ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.231 by root, Sun Apr 27 20:26:28 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 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 *DEPRECATED*
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 going away in
		293	preference to the C<< ->register_keysym_action >> method.
		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 a true value the binding
		299	is not 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 a true value, 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	=item on_client_message $term, $event
		357
		358	=item on_wm_protocols $term, $event
		359
		360	=item on_wm_delete_window $term, $event
		361
		362	Called when various types of ClientMessage events are received (all with
		363	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		364
		365	=item on_bell $term
		366
		367	Called on receipt of a bell character.
345		368
346	=back	369	=back
		370
		371	=cut
		372
		373	package urxvt;
		374
		375	use utf8;
		376	use strict 'vars';
		377	use Carp ();
		378	use Scalar::Util ();
		379	use List::Util ();
		380
		381	our $VERSION = 1;
		382	our $TERM;
		383	our @TERM_INIT; # should go, prevents async I/O etc.
		384	our @TERM_EXT; # should go, prevents async I/O etc.
		385	our @HOOKNAME;
		386	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		387	our %OPTION;
		388
		389	our $LIBDIR;
		390	our $RESNAME;
		391	our $RESCLASS;
		392	our $RXVTNAME;
		393
		394	our $NOCHAR = chr 0xffff;
347		395
348	=head2 Variables in the C<urxvt> Package	396	=head2 Variables in the C<urxvt> Package
349		397
350	=over 4	398	=over 4
351		399
…		…
365	=item $urxvt::TERM	413	=item $urxvt::TERM
366		414
367	The current terminal. This variable stores the current C<urxvt::term>	415	The current terminal. This variable stores the current C<urxvt::term>
368	object, whenever a callback/hook is executing.	416	object, whenever a callback/hook is executing.
369		417
370	=item	418	=item @urxvt::TERM_INIT
		419
		420	All code references in this array will be called as methods of the next newly
		421	created C<urxvt::term> object (during the C<on_init> phase). The array
		422	gets cleared before the code references that were in it are being executed,
		423	so references can push themselves onto it again if they so desire.
		424
		425	This complements to the perl-eval command line option, but gets executed
		426	first.
		427
		428	=item @urxvt::TERM_EXT
		429
		430	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		431	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		432	but before other extensions. Gets cleared just like C<@TERM_INIT>.
371		433
372	=back	434	=back
373		435
374	=head2 Functions in the C<urxvt> Package	436	=head2 Functions in the C<urxvt> Package
375		437
376	=over 4	438	=over 4
377		439
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	440	=item urxvt::fatal $errormessage
387		441
388	Fatally aborts execution with the given error message. Avoid at all	442	Fatally aborts execution with the given error message (which should
389	costs! The only time this is acceptable is when the terminal process	443	include a trailing newline). Avoid at all costs! The only time this
390	starts up.	444	is acceptable (and useful) is in the init hook, where it prevents the
		445	terminal from starting up.
391		446
392	=item urxvt::warn $string	447	=item urxvt::warn $string
393		448
394	Calls C<rxvt_warn> with the given string which should not include a	449	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	450	newline. The module also overwrites the C<warn> builtin with a function
396	that calls this function.	451	that calls this function.
397		452
398	Using this function has the advantage that its output ends up in the	453	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.	454	correct place, e.g. on stderr of the connecting urxvtc client.
400		455
401	=item $is_safe = urxvt::safe	456	Messages have a size limit of 1023 bytes currently.
402		457
403	Returns true when it is safe to do potentially unsafe things, such as	458	=item @terms = urxvt::termlist
404	evaluating perl code specified by the user. This is true when urxvt was	459
405	started setuid or setgid.	460	Returns all urxvt::term objects that exist in this process, regardless of
		461	whether they are started, being destroyed etc., so be careful. Only term
		462	objects that have perl extensions attached will be returned (because there
		463	is no urxvt::term object associated with others).
406		464
407	=item $time = urxvt::NOW	465	=item $time = urxvt::NOW
408		466
409	Returns the "current time" (as per the event loop).	467	Returns the "current time" (as per the event loop).
410		468
411	=item urxvt::CurrentTime	469	=item urxvt::CurrentTime
412		470
413	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	471	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
414	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	472	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
415	Button4Mask, Button5Mask, AnyModifier	473	Button4Mask, Button5Mask, AnyModifier
		474
		475	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		476	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		477	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		478	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		479	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		480	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		481	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		482
		483	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		484	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		485	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		486	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		487	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		488	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		489	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
416		490
417	Various constants for use in X calls and event processing.	491	Various constants for use in X calls and event processing.
418		492
419	=back	493	=back
420		494
…		…
437		511
438	=item $rend = urxvt::OVERLAY_RSTYLE	512	=item $rend = urxvt::OVERLAY_RSTYLE
439		513
440	Return the rendition mask used for overlays by default.	514	Return the rendition mask used for overlays by default.
441		515
442	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	516	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		517	urxvt::RS_RVid, urxvt::RS_Uline
443		518
444	Return the bit that enabled bold, italic, blink, reverse-video and	519	Return the bit that enabled bold, italic, blink, reverse-video and
445	underline, respectively. To enable such a style, just logically OR it into	520	underline, respectively. To enable such a style, just logically OR it into
446	the bitset.	521	the bitset.
447		522
…		…
453		528
454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	529	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
455		530
456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	531	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
457		532
		533	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		534
458	Replace the foreground/background colour in the rendition mask with the	535	Replace the foreground/background colour in the rendition mask with the
459	specified one.	536	specified one.
460		537
461	=item $value = urxvt::GET_CUSTOM $rend	538	=item $value = urxvt::GET_CUSTOM $rend
462		539
…		…
470		547
471	=back	548	=back
472		549
473	=cut	550	=cut
474		551
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 {	552	BEGIN {
495	urxvt->bootstrap;
496
497	# overwrite perl's warn	553	# overwrite perl's warn
498	*CORE::GLOBAL::warn = sub {	554	*CORE::GLOBAL::warn = sub {
499	my $msg = join "", @_;	555	my $msg = join "", @_;
500	$msg .= "\n"	556	$msg .= "\n"
501	unless $msg =~ /\n$/;	557	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	558	urxvt::warn ($msg);
503	};	559	};
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	}	560	}
510		561
511	my @hook_count;	562	no warnings 'utf8';
		563
		564	sub parse_resource {
		565	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		566
		567	$name =~ y/-/./ if $isarg;
		568
		569	$term->scan_meta;
		570
		571	my $r = $term->{meta}{resource};
		572	keys %$r; # reset iterator
		573	while (my ($pattern, $v) = each %$r) {
		574	if (
		575	$pattern =~ /\.$/
		576	? $pattern eq substr $name, 0, length $pattern
		577	: $pattern eq $name
		578	) {
		579	$name = "$urxvt::RESCLASS.$name";
		580
		581	push @{ $term->{perl_ext_3} }, $v->[0];
		582
		583	if ($v->[1] eq "boolean") {
		584	$term->put_option_db ($name, $flag ? "true" : "false");
		585	return 1;
		586	} else {
		587	$term->put_option_db ($name, $value);
		588	return 1 + 2;
		589	}
		590	}
		591	}
		592
		593	0
		594	}
		595
		596	sub usage {
		597	my ($term, $usage_type) = @_;
		598
		599	$term->scan_meta;
		600
		601	my $r = $term->{meta}{resource};
		602
		603	for my $pattern (sort keys %$r) {
		604	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		605
		606	$desc .= " (-pe $ext)";
		607
		608	if ($usage_type == 1) {
		609	$pattern =~ y/./-/;
		610	$pattern =~ s/-$/-.../g;
		611
		612	if ($type eq "boolean") {
		613	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		614	} else {
		615	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		616	}
		617	} else {
		618	$pattern =~ s/\.$/.*/g;
		619	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		620	}
		621	}
		622	}
		623
512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	624	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513		625
514	sub verbose {	626	sub verbose {
515	my ($level, $msg) = @_;	627	my ($level, $msg) = @_;
516	warn "$msg\n" if $level <= $verbosity;	628	warn "$msg\n" if $level <= $verbosity;
517	}	629	}
518		630
519	my $extension_pkg = "extension0000";
520	my %extension_pkg;	631	my %extension_pkg;
521		632
522	# load a single script into its own package, once only	633	# load a single script into its own package, once only
523	sub extension_package($) {	634	sub extension_package($) {
524	my ($path) = @_;	635	my ($path) = @_;
525		636
526	$extension_pkg{$path} ||= do {	637	$extension_pkg{$path} ||= do {
527	my $pkg = "urxvt::" . ($extension_pkg++);	638	$path =~ /([^\/\\]+)$/;
		639	my $pkg = $1;
		640	$pkg =~ s/[^[:word:]]/_/g;
		641	$pkg = "urxvt::ext::$pkg";
528		642
529	verbose 3, "loading extension '$path' into package '$pkg'";	643	verbose 3, "loading extension '$path' into package '$pkg'";
		644
		645	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
530		646
531	open my $fh, "<:raw", $path	647	open my $fh, "<:raw", $path
532	or die "$path: $!";	648	or die "$path: $!";
533		649
534	my $source = untaint	650	my $source =
535	"package $pkg; use strict; use utf8;\n"	651	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
536	. "use base urxvt::term::extension::;\n"
537	. "#line 1 \"$path\"\n{\n"	652	. "#line 1 \"$path\"\n{\n"
538	. (do { local $/; <$fh> })	653	. (do { local $/; <$fh> })
539	. "\n};\n1";	654	. "\n};\n1";
540		655
541	eval $source	656	eval $source
…		…
550	# called by the rxvt core	665	# called by the rxvt core
551	sub invoke {	666	sub invoke {
552	local $TERM = shift;	667	local $TERM = shift;
553	my $htype = shift;	668	my $htype = shift;
554		669
555	if ($htype == 0) { # INIT	670	if ($htype == HOOK_INIT) {
556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	671	my @dirs = $TERM->perl_libdirs;
557		672
558	my %ext_arg;	673	my %ext_arg;
559		674
		675	{
		676	my @init = @TERM_INIT;
		677	@TERM_INIT = ();
		678	$_->($TERM) for @init;
		679	my @pkg = @TERM_EXT;
		680	@TERM_EXT = ();
		681	$TERM->register_package ($_) for @pkg;
		682	}
		683
		684	for (
		685	@{ delete $TERM->{perl_ext_3} },
560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	686	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		687	) {
561	if ($_ eq "default") {	688	if ($_ eq "default") {
562	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	689	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
563	} elsif (/^-(.*)$/) {	690	} elsif (/^-(.*)$/) {
564	delete $ext_arg{$1};	691	delete $ext_arg{$1};
565	} elsif (/^([^<]+)<(.*)>$/) {	692	} elsif (/^([^<]+)<(.*)>$/) {
566	push @{ $ext_arg{$1} }, $2;	693	push @{ $ext_arg{$1} }, $2;
567	} else {	694	} else {
568	$ext_arg{$_} ||= [];	695	$ext_arg{$_} ||= [];
569	}	696	}
570	}	697	}
571		698
572	while (my ($ext, $argv) = each %ext_arg) {	699	for my $ext (sort keys %ext_arg) {
573	my @files = grep -f $_, map "$_/$ext", @dirs;	700	my @files = grep -f $_, map "$_/$ext", @dirs;
574		701
575	if (@files) {	702	if (@files) {
576	$TERM->register_package (extension_package $files[0], $argv);	703	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
577	} else {	704	} else {
578	warn "perl extension '$ext' not found in perl library search path\n";	705	warn "perl extension '$ext' not found in perl library search path\n";
579	}	706	}
580	}	707	}
581		708
…		…
587		714
588	if (my $cb = $TERM->{_hook}[$htype]) {	715	if (my $cb = $TERM->{_hook}[$htype]) {
589	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	716	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
590	if $verbosity >= 10;	717	if $verbosity >= 10;
591		718
		719	for my $pkg (
		720	# this hook is only sent to the extension with the name
		721	# matching the first arg
		722	$htype == HOOK_KEYBOARD_DISPATCH
		723	? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
592	keys %$cb;	724	: keys %$cb
593		725	) {
594	while (my ($pkg, $cb) = each %$cb) {
595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	726	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
596	and last;	727	$retval ||= $retval_;
597		728
598	if ($@) {	729	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	730	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	731	warn $@;
601	}	732	}
602	}	733	}
		734
		735	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		736	if $verbosity >= 11;
603	}	737	}
604		738
605	if ($htype == 1) { # DESTROY	739	if ($htype == HOOK_DESTROY) {
606	if (my $hook = delete $TERM->{_hook}) {
607	for my $htype (0..$#$hook) {
608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
609	or set_should_invoke $htype, 0;
610	}
611	}
612
613	# clear package objects	740	# clear package objects
614	%$_ = () for values %{ $TERM->{_pkg} };	741	%$_ = () for values %{ $TERM->{_pkg} };
615		742
616	# clear package	743	# clear package
617	%$TERM = ();	744	%$TERM = ();
618	}	745	}
619		746
620	$retval	747	$retval
621	}	748	}
622		749
623	# urxvt::term::extension	750	sub SET_COLOR($$$) {
		751	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		752	}
624		753
625	package urxvt::term::extension;	754	sub rend2mask {
626		755	no strict 'refs';
627	sub enable {	756	my ($str, $mask) = (@_, 0);
628	my ($self, %hook) = @_;	757	my %color = ( fg => undef, bg => undef );
629	my $pkg = $self->{_pkg};	758	my @failed;
630		759	for my $spec ( split /\s+/, $str ) {
631	while (my ($name, $cb) = each %hook) {	760	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
632	my $htype = $HOOKTYPE{uc $name};	761	$color{lc($1)} = $2;
633	defined $htype	762	} else {
634	or Carp::croak "unsupported hook type '$name'";	763	my $neg = $spec =~ s/^[-^]//;
635		764	unless ( exists &{"RS_$spec"} ) {
636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	765	push @failed, $spec;
637	$hook_count[$htype]++	766	next;
638	or urxvt::set_should_invoke $htype, 1;
639	}	767	}
640		768	my $cur = &{"RS_$spec"};
641	$self->{term}{_hook}[$htype]{$pkg} = $cb;	769	if ( $neg ) {
642	}	770	$mask &= ~$cur;
643	}	771	} else {
644		772	$mask |= $cur;
645	sub disable {	773	}
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	}	774	}
658	}	775	}
		776	($mask, @color{qw(fg bg)}, \@failed)
659	}	777	}
		778
		779	package urxvt::term::extension;
		780
		781	=head2 The C<urxvt::term::extension> class
		782
		783	Each extension attached to a terminal object is represented by
		784	a C<urxvt::term::extension> object.
		785
		786	You can use these objects, which are passed to all callbacks to store any
		787	state related to the terminal and extension instance.
		788
		789	The methods (And data members) documented below can be called on extension
		790	objects, in addition to call methods documented for the <urxvt::term>
		791	class.
		792
		793	=over 4
		794
		795	=item $urxvt_term = $self->{term}
		796
		797	Returns the C<urxvt::term> object associated with this instance of the
		798	extension. This member I<must not> be changed in any way.
		799
		800	=cut
660		801
661	our $AUTOLOAD;	802	our $AUTOLOAD;
662		803
663	sub AUTOLOAD {	804	sub AUTOLOAD {
664	$AUTOLOAD =~ /:([^:]+)$/	805	$AUTOLOAD =~ /:([^:]+)$/
…		…
677		818
678	sub DESTROY {	819	sub DESTROY {
679	# nop	820	# nop
680	}	821	}
681		822
682	# urxvt::destroy_hook	823	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
683		824
684	sub urxvt::destroy_hook::DESTROY {	825	sub urxvt::destroy_hook::DESTROY {
685	${$_[0]}->();	826	${$_[0]}->();
686	}	827	}
687		828
688	sub urxvt::destroy_hook(&) {	829	sub urxvt::destroy_hook(&) {
689	bless \shift, urxvt::destroy_hook::	830	bless \shift, urxvt::destroy_hook::
690	}	831	}
		832
		833	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		834
		835	Dynamically enable the given hooks (named without the C<on_> prefix) for
		836	this extension, replacing any hook previously installed via C<enable> in
		837	this extension.
		838
		839	This is useful when you want to overwrite time-critical hooks only
		840	temporarily.
		841
		842	To install additional callbacks for the same hook, you can use the C<on>
		843	method of the C<urxvt::term> class.
		844
		845	=item $self->disable ($hook_name[, $hook_name..])
		846
		847	Dynamically disable the given hooks.
		848
		849	=cut
		850
		851	sub enable {
		852	my ($self, %hook) = @_;
		853	my $pkg = $self->{_pkg};
		854
		855	while (my ($name, $cb) = each %hook) {
		856	my $htype = $HOOKTYPE{uc $name};
		857	defined $htype
		858	or Carp::croak "unsupported hook type '$name'";
		859
		860	$self->set_should_invoke ($htype, +1)
		861	unless exists $self->{term}{_hook}[$htype]{$pkg};
		862
		863	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		864	}
		865	}
		866
		867	sub disable {
		868	my ($self, @hook) = @_;
		869	my $pkg = $self->{_pkg};
		870
		871	for my $name (@hook) {
		872	my $htype = $HOOKTYPE{uc $name};
		873	defined $htype
		874	or Carp::croak "unsupported hook type '$name'";
		875
		876	$self->set_should_invoke ($htype, -1)
		877	if delete $self->{term}{_hook}[$htype]{$pkg};
		878	}
		879	}
		880
		881	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		882
		883	Similar to the C<enable> enable, but installs additional callbacks for
		884	the given hook(s) (that is, it doesn't replace existing callbacks), and
		885	returns a guard object. When the guard object is destroyed the callbacks
		886	are disabled again.
		887
		888	=cut
		889
		890	sub urxvt::extension::on_disable::DESTROY {
		891	my $disable = shift;
		892
		893	my $term = delete $disable->{""};
		894
		895	while (my ($htype, $id) = each %$disable) {
		896	delete $term->{_hook}[$htype]{$id};
		897	$term->set_should_invoke ($htype, -1);
		898	}
		899	}
		900
		901	sub on {
		902	my ($self, %hook) = @_;
		903
		904	my $term = $self->{term};
		905
		906	my %disable = ( "" => $term );
		907
		908	while (my ($name, $cb) = each %hook) {
		909	my $htype = $HOOKTYPE{uc $name};
		910	defined $htype
		911	or Carp::croak "unsupported hook type '$name'";
		912
		913	$term->set_should_invoke ($htype, +1);
		914	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		915	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		916	}
		917
		918	bless \%disable, "urxvt::extension::on_disable"
		919	}
		920
		921	=item $self->x_resource ($pattern)
		922
		923	=item $self->x_resource_boolean ($pattern)
		924
		925	These methods support an additional C<%> prefix when called on an
		926	extension object - see the description of these methods in the
		927	C<urxvt::term> class for details.
		928
		929	=cut
		930
		931	sub x_resource {
		932	my ($self, $name) = @_;
		933	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		934	$self->{term}->x_resource ($name)
		935	}
		936
		937	sub x_resource_boolean {
		938	my ($self, $name) = @_;
		939	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		940	$self->{term}->x_resource_boolean ($name)
		941	}
		942
		943	=back
		944
		945	=cut
691		946
692	package urxvt::anyevent;	947	package urxvt::anyevent;
693		948
694	=head2 The C<urxvt::anyevent> Class	949	=head2 The C<urxvt::anyevent> Class
695		950
696	The sole purpose of this class is to deliver an interface to the	951	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	952	C<AnyEvent> module - any module using it will work inside urxvt without
698	further programming. The only exception is that you cannot wait on	953	further programming. The only exception is that you cannot wait on
699	condition variables, but non-blocking condvar use is ok. What this means	954	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		955
703	=cut	956	In practical terms this means is that you cannot use blocking APIs, but
		957	the non-blocking variant should work.
704		958
		959	=cut
		960
705	our $VERSION = 1;	961	our $VERSION = '5.23';
706		962
707	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	963	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
708	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	964	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
709		965
710	sub timer {	966	sub timer {
…		…
712		968
713	my $cb = $arg{cb};	969	my $cb = $arg{cb};
714		970
715	urxvt::timer	971	urxvt::timer
716	->new	972	->new
717	->start (urxvt::NOW + $arg{after})	973	->after ($arg{after}, $arg{interval})
718	->cb (sub {	974	->cb ($arg{interval} ? $cb : sub {
719	$_[0]->stop; # need to cancel manually	975	$_[0]->stop; # need to cancel manually
720	$cb->();	976	$cb->();
721	})	977	})
722	}	978	}
723		979
724	sub io {	980	sub io {
725	my ($class, %arg) = @_;	981	my ($class, %arg) = @_;
726		982
727	my $cb = $arg{cb};	983	my $cb = $arg{cb};
		984	my $fd = fileno $arg{fh};
		985	defined $fd or $fd = $arg{fh};
728		986
729	bless [$arg{fh}, urxvt::iow	987	bless [$arg{fh}, urxvt::iow
730	->new	988	->new
731	->fd (fileno $arg{fh})	989	->fd ($fd)
732	->events (($arg{poll} =~ /r/ ? 1 : 0)	990	->events (($arg{poll} =~ /r/ ? 1 : 0)
733	| ($arg{poll} =~ /w/ ? 2 : 0))	991	| ($arg{poll} =~ /w/ ? 2 : 0))
734	->start	992	->start
735	->cb (sub {	993	->cb ($cb)
736	$cb->(($_[1] & 1 ? 'r' : '')
737	. ($_[1] & 2 ? 'w' : ''));
738	})],
739	urxvt::anyevent::	994	], urxvt::anyevent::
		995	}
		996
		997	sub idle {
		998	my ($class, %arg) = @_;
		999
		1000	my $cb = $arg{cb};
		1001
		1002	urxvt::iw
		1003	->new
		1004	->start
		1005	->cb ($cb)
		1006	}
		1007
		1008	sub child {
		1009	my ($class, %arg) = @_;
		1010
		1011	my $cb = $arg{cb};
		1012
		1013	urxvt::pw
		1014	->new
		1015	->start ($arg{pid})
		1016	->cb (sub {
		1017	$_[0]->stop; # need to cancel manually
		1018	$cb->($_[0]->rpid, $_[0]->rstatus);
		1019	})
740	}	1020	}
741		1021
742	sub DESTROY {	1022	sub DESTROY {
743	$_[0][1]->stop;	1023	$_[0][1]->stop;
744	}	1024	}
745		1025
746	sub condvar {	1026	# only needed for AnyEvent < 6 compatibility
747	bless \my $flag, urxvt::anyevent::condvar::	1027	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";	1028	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
757	}
758	}	1029	}
759		1030
760	package urxvt::term;	1031	package urxvt::term;
761		1032
762	=head2 The C<urxvt::term> Class	1033	=head2 The C<urxvt::term> Class
…		…
768	# find on_xxx subs in the package and register them	1039	# find on_xxx subs in the package and register them
769	# as hooks	1040	# as hooks
770	sub register_package {	1041	sub register_package {
771	my ($self, $pkg, $argv) = @_;	1042	my ($self, $pkg, $argv) = @_;
772		1043
		1044	no strict 'refs';
		1045
		1046	urxvt::verbose 6, "register package $pkg to $self";
		1047
		1048	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1049
773	my $proxy = bless {	1050	my $proxy = bless {
774	_pkg => $pkg,	1051	_pkg => $pkg,
		1052	_name => ${"$pkg\::_NAME"}, # hackish
775	argv => $argv,	1053	argv => $argv,
776	}, $pkg;	1054	}, $pkg;
777	Scalar::Util::weaken ($proxy->{term} = $self);	1055	Scalar::Util::weaken ($proxy->{term} = $self);
778		1056
779	$self->{_pkg}{$pkg} = $proxy;	1057	$self->{_pkg}{$pkg} = $proxy;
780		1058
…		…
783	$proxy->enable ($name => $ref);	1061	$proxy->enable ($name => $ref);
784	}	1062	}
785	}	1063	}
786	}	1064	}
787		1065
		1066	sub perl_libdirs {
		1067	map { split /:/ }
		1068	$_[0]->resource ("perl_lib"),
		1069	$ENV{URXVT_PERL_LIB},
		1070	"$ENV{HOME}/.urxvt/ext",
		1071	"$LIBDIR/perl"
		1072	}
		1073
		1074	sub scan_meta {
		1075	my ($self) = @_;
		1076	my @libdirs = perl_libdirs $self;
		1077
		1078	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1079
		1080	my %meta;
		1081
		1082	$self->{meta_libdirs} = join "\x00", @libdirs;
		1083	$self->{meta} = \%meta;
		1084
		1085	for my $dir (reverse @libdirs) {
		1086	opendir my $fh, $dir
		1087	or next;
		1088	for my $ext (readdir $fh) {
		1089	$ext !~ /^\./
		1090	and open my $fh, "<", "$dir/$ext"
		1091	or next;
		1092
		1093	while (<$fh>) {
		1094	if (/^#:META:X_RESOURCE:(.*)/) {
		1095	my ($pattern, $type, $desc) = split /:/, $1;
		1096	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1097	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1098	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1099	} else {
		1100	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1101	}
		1102	} elsif (/^\s*(?:#|$)/) {
		1103	# skip other comments and empty lines
		1104	} else {
		1105	last; # stop parsing on first non-empty non-comment line
		1106	}
		1107	}
		1108	}
		1109	}
		1110	}
		1111
		1112	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1113
		1114	Creates a new terminal, very similar as if you had started it with system
		1115	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1116	hash which defines the environment of the new terminal.
		1117
		1118	Croaks (and probably outputs an error message) if the new instance
		1119	couldn't be created. Returns C<undef> if the new instance didn't
		1120	initialise perl, and the terminal object otherwise. The C<init> and
		1121	C<start> hooks will be called before this call returns, and are free to
		1122	refer to global data (which is race free).
		1123
		1124	=cut
		1125
		1126	sub new {
		1127	my ($class, $env, @args) = @_;
		1128
		1129	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1130	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1131
		1132	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1133	}
		1134
788	=item $term->destroy	1135	=item $term->destroy
789		1136
790	Destroy the terminal object (close the window, free resources	1137	Destroy the terminal object (close the window, free resources
791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1138	etc.). Please note that urxvt will not exit as long as any event
792	watchers (timers, io watchers) are still active.	1139	watchers (timers, io watchers) are still active.
		1140
		1141	=item $term->exec_async ($cmd[, @args])
		1142
		1143	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1144	("starts") programs in the background. This function takes care of setting
		1145	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1146	be preferred over explicit calls to C<exec> or C<system>.
		1147
		1148	Returns the pid of the subprocess or C<undef> on error.
		1149
		1150	=cut
		1151
		1152	sub exec_async {
		1153	my $self = shift;
		1154
		1155	my $pid = fork;
		1156
		1157	return $pid
		1158	if !defined $pid or $pid;
		1159
		1160	%ENV = %{ $self->env };
		1161
		1162	exec @_;
		1163	urxvt::_exit 255;
		1164	}
793		1165
794	=item $isset = $term->option ($optval[, $set])	1166	=item $isset = $term->option ($optval[, $set])
795		1167
796	Returns true if the option specified by C<$optval> is enabled, and	1168	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	1169	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.	1170	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
799		1171
800	Here is a a likely non-exhaustive list of option names, please see the	1172	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:	1173	source file F</src/optinc.h> to see the actual list:
802		1174
803	borderLess console cursorBlink cursorUnderline hold iconic insecure	1175	borderLess buffered console cursorBlink cursorUnderline hold iconic
804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1176	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1177	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1178	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1179	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1180	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
808	tripleclickwords utmpInhibit visualBell	1181	urgentOnBell utmpInhibit visualBell
809		1182
810	=item $value = $term->resource ($name[, $newval])	1183	=item $value = $term->resource ($name[, $newval])
811		1184
812	Returns the current resource value associated with a given name and	1185	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>	1186	optionally sets a new value. Setting values is most useful in the C<init>
…		…
822	likely change).	1195	likely change).
823		1196
824	Please note that resource strings will currently only be freed when the	1197	Please note that resource strings will currently only be freed when the
825	terminal is destroyed, so changing options frequently will eat memory.	1198	terminal is destroyed, so changing options frequently will eat memory.
826		1199
827	Here is a a likely non-exhaustive list of resource names, not all of which	1200	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>	1201	are supported in every build, please see the source file F</src/rsinc.h>
829	to see the actual list:	1202	to see the actual list:
830		1203
831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1204	answerbackstring backgroundPixmap backspace_key blurradius
832	borderLess color cursorBlink cursorUnderline cutchars delete_key	1205	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
833	display_name embed ext_bwidth fade font geometry hold iconName	1206	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
834	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1207	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1208	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
835	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1209	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
836	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1210	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1211	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1212	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1213	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1214	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841	shade term_name title transparent transparent_all tripleclickwords	1215	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1216	term_name title transient_for transparent tripleclickwords urgentOnBell
842	utmpInhibit visualBell	1217	utmpInhibit visualBell
843		1218
844	=cut	1219	=cut
845		1220
846	sub resource($$;$) {	1221	sub resource($$;$) {
847	my ($self, $name) = (shift, shift);	1222	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1223	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	1224	goto &urxvt::term::_resource
850	}	1225	}
851		1226
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1227	=item $value = $term->x_resource ($pattern)
853		1228
		1229	Returns the X-Resource for the given pattern, excluding the program or
		1230	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1231	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1232	resource with that pattern exists.
		1233
		1234	Extensions that define extra resource or command line arguments also need
		1235	to call this method to access their values.
		1236
		1237	If the method is called on an extension object (basically, from an
		1238	extension), then the special prefix C<%.> will be replaced by the name of
		1239	the extension and a dot, and the lone string C<%> will be replaced by the
		1240	extension name itself. This makes it possible to code extensions so you
		1241	can rename them and get a new set of commandline switches and resources
		1242	without having to change the actual code.
		1243
		1244	This method should only be called during the C<on_start> hook, as there is
		1245	only one resource database per display, and later invocations might return
		1246	the wrong resources.
		1247
		1248	=item $value = $term->x_resource_boolean ($pattern)
		1249
		1250	Like C<x_resource>, above, but interprets the string value as a boolean
		1251	and returns C<1> for true values, C<0> for false values and C<undef> if
		1252	the resource or option isn't specified.
		1253
		1254	You should always use this method to parse boolean resources.
		1255
		1256	=cut
		1257
		1258	sub x_resource_boolean {
		1259	my $res = &x_resource;
		1260
		1261	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1262	}
		1263
		1264	=item $success = $term->parse_keysym ($key, $octets)
		1265
854	Adds a keymap translation exactly as specified via a resource. See the	1266	Adds a key binding exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1267	C<keysym> resource in the urxvt(1) manpage.
		1268
		1269	=item $term->register_command ($keysym, $modifiermask, $string)
		1270
		1271	Adds a key binding. This is a lower level api compared to
		1272	C<parse_keysym>, as it expects a parsed key description, and can be
		1273	used only inside either the C<on_init> hook, to add a binding, or the
		1274	C<on_register_command> hook, to modify a parsed binding.
856		1275
857	=item $rend = $term->rstyle ([$new_rstyle])	1276	=item $rend = $term->rstyle ([$new_rstyle])
858		1277
859	Return and optionally change the current rendition. Text that is output by	1278	Return and optionally change the current rendition. Text that is output by
860	the terminal application will use this style.	1279	the terminal application will use this style.
…		…
868		1287
869	=item ($row, $col) = $term->selection_beg ([$row, $col])	1288	=item ($row, $col) = $term->selection_beg ([$row, $col])
870		1289
871	=item ($row, $col) = $term->selection_end ([$row, $col])	1290	=item ($row, $col) = $term->selection_end ([$row, $col])
872		1291
873	Return the current values of the selection mark, begin or end positions,	1292	Return the current values of the selection mark, begin or end positions.
874	and optionally set them to new values.
875		1293
		1294	When arguments are given, then the selection coordinates are set to
		1295	C<$row> and C<$col>, and the selection screen is set to the current
		1296	screen.
		1297
		1298	=item $screen = $term->selection_screen ([$screen])
		1299
		1300	Returns the current selection screen, and then optionally sets it.
		1301
		1302	=item $term->selection_make ($eventtime[, $rectangular])
		1303
		1304	Tries to make a selection as set by C<selection_beg> and
		1305	C<selection_end>. If C<$rectangular> is true (default: false), a
		1306	rectangular selection will be made. This is the preferred function to make
		1307	a selection.
		1308
876	=item $success = $term->selection_grab ($eventtime)	1309	=item $success = $term->selection_grab ($eventtime[, $clipboard])
877		1310
878	Try to request the primary selection from the server (for example, as set	1311	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
879	by the next method).	1312	true) selection from the server. The corresponding text can be set
		1313	with the next method. No visual feedback will be given. This function
		1314	is mostly useful from within C<on_sel_grab> hooks.
880		1315
881	=item $oldtext = $term->selection ([$newtext])	1316	=item $oldtext = $term->selection ([$newtext, $clipboard])
882		1317
883	Return the current selection text and optionally replace it by C<$newtext>.	1318	Return the current selection (clipboard if C<$clipboard> is true) text
		1319	and optionally replace it by C<$newtext>.
		1320
		1321	=item $term->selection_clear ([$clipboard])
		1322
		1323	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
884		1324
885	=item $term->overlay_simple ($x, $y, $text)	1325	=item $term->overlay_simple ($x, $y, $text)
886		1326
887	Create a simple multi-line overlay box. See the next method for details.	1327	Create a simple multi-line overlay box. See the next method for details.
888		1328
…		…
918		1358
919	The methods currently supported on C<urxvt::overlay> objects are:	1359	The methods currently supported on C<urxvt::overlay> objects are:
920		1360
921	=over 4	1361	=over 4
922		1362
923	=item $overlay->set ($x, $y, $text, $rend)	1363	=item $overlay->set ($x, $y, $text[, $rend])
924		1364
925	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1365	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	1366	text in rxvt-unicode's special encoding and an array of rendition values
927	at a specific position inside the overlay.	1367	at a specific position inside the overlay.
		1368
		1369	If C<$rend> is missing, then the rendition will not be changed.
928		1370
929	=item $overlay->hide	1371	=item $overlay->hide
930		1372
931	If visible, hide the overlay, but do not destroy it.	1373	If visible, hide the overlay, but do not destroy it.
932		1374
…		…
977	Convert the given locale-encoded octets into a perl string.	1419	Convert the given locale-encoded octets into a perl string.
978		1420
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1421	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1422
981	XORs the rendition values in the given span with the provided value	1423	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	1424	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1425	refresh hooks to provide effects similar to the selection.
984		1426
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1427	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1428
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1429	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1430	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	1431	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
990	it instead.	1432	it instead. Both styles I<MUST NOT> contain font styles.
991		1433
992	=item $term->scr_bell	1434	=item $term->scr_bell
993		1435
994	Ring the bell!	1436	Ring the bell!
995		1437
…		…
1002		1444
1003	Normally its not a good idea to use this function, as programs might be	1445	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	1446	confused by changes in cursor position or scrolling. Its useful inside a
1005	C<on_add_lines> hook, though.	1447	C<on_add_lines> hook, though.
1006		1448
		1449	=item $term->scr_change_screen ($screen)
		1450
		1451	Switch to given screen - 0 primary, 1 secondary.
		1452
1007	=item $term->cmd_parse ($octets)	1453	=item $term->cmd_parse ($octets)
1008		1454
1009	Similar to C<scr_add_lines>, but the argument must be in the	1455	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	1456	locale-specific encoding of the terminal and can contain command sequences
1011	(escape codes) that will be interpreted.	1457	(escape codes) that will be interpreted.
1012		1458
1013	=item $term->tt_write ($octets)	1459	=item $term->tt_write ($octets)
1014		1460
1015	Write the octets given in C<$data> to the tty (i.e. as program input). To	1461	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	1462	pass characters instead of octets, you should convert your strings first
1017	to the locale-specific encoding using C<< $term->locale_encode >>.	1463	to the locale-specific encoding using C<< $term->locale_encode >>.
		1464
		1465	=item $term->tt_paste ($octets)
		1466
		1467	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1468	CR and bracketing the data with control sequences if bracketed paste mode
		1469	is set.
1018		1470
1019	=item $old_events = $term->pty_ev_events ([$new_events])	1471	=item $old_events = $term->pty_ev_events ([$new_events])
1020		1472
1021	Replaces the event mask of the pty watcher by the given event mask. Can	1473	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	1474	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	1475	description of C<< urxvt::timer->events >>. Make sure to always restore
1024	the previous value.	1476	the previous value.
1025		1477
		1478	=item $fd = $term->pty_fd
		1479
		1480	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1481	is used.
		1482
1026	=item $windowid = $term->parent	1483	=item $windowid = $term->parent
1027		1484
1028	Return the window id of the toplevel window.	1485	Return the window id of the toplevel window.
1029		1486
1030	=item $windowid = $term->vt	1487	=item $windowid = $term->vt
1031		1488
1032	Return the window id of the terminal window.	1489	Return the window id of the terminal window.
1033		1490
		1491	=item $term->vt_emask_add ($x_event_mask)
		1492
		1493	Adds the specified events to the vt event mask. Useful e.g. when you want
		1494	to receive pointer events all the times:
		1495
		1496	$term->vt_emask_add (urxvt::PointerMotionMask);
		1497
		1498	=item $term->set_urgency ($set)
		1499
		1500	Enable/disable the urgency hint on the toplevel window.
		1501
		1502	=item $term->focus_in
		1503
		1504	=item $term->focus_out
		1505
		1506	=item $term->key_press ($state, $keycode[, $time])
		1507
		1508	=item $term->key_release ($state, $keycode[, $time])
		1509
		1510	Deliver various fake events to to terminal.
		1511
1034	=item $window_width = $term->width	1512	=item $window_width = $term->width
1035		1513
1036	=item $window_height = $term->height	1514	=item $window_height = $term->height
1037		1515
1038	=item $font_width = $term->fwidth	1516	=item $font_width = $term->fwidth
…		…
1051		1529
1052	=item $max_scrollback = $term->saveLines	1530	=item $max_scrollback = $term->saveLines
1053		1531
1054	=item $nrow_plus_saveLines = $term->total_rows	1532	=item $nrow_plus_saveLines = $term->total_rows
1055		1533
1056	=item $lines_in_scrollback = $term->nsaved	1534	=item $topmost_scrollback_row = $term->top_row
1057		1535
1058	Return various integers describing terminal characteristics.	1536	Return various integers describing terminal characteristics.
1059		1537
		1538	=item $x_display = $term->display_id
		1539
		1540	Return the DISPLAY used by rxvt-unicode.
		1541
1060	=item $lc_ctype = $term->locale	1542	=item $lc_ctype = $term->locale
1061		1543
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1544	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1545
1064	=item $x_display = $term->display_id	1546	=item $env = $term->env
1065		1547
1066	Return the DISPLAY used by rxvt-unicode.	1548	Returns a copy of the environment in effect for the terminal as a hashref
		1549	similar to C<\%ENV>.
		1550
		1551	=item @envv = $term->envv
		1552
		1553	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1554
		1555	=item @argv = $term->argv
		1556
		1557	Return the argument vector as this terminal, similar to @ARGV, but
		1558	includes the program name as first element.
		1559
		1560	=cut
		1561
		1562	sub env {
		1563	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1564	}
1067		1565
1068	=item $modifiermask = $term->ModLevel3Mask	1566	=item $modifiermask = $term->ModLevel3Mask
1069		1567
1070	=item $modifiermask = $term->ModMetaMask	1568	=item $modifiermask = $term->ModMetaMask
1071		1569
1072	=item $modifiermask = $term->ModNumLockMask	1570	=item $modifiermask = $term->ModNumLockMask
1073		1571
1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1572	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.	1573	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076		1574
		1575	=item $screen = $term->current_screen
		1576
		1577	Returns the currently displayed screen (0 primary, 1 secondary).
		1578
		1579	=item $cursor_is_hidden = $term->hidden_cursor
		1580
		1581	Returns whether the cursor is currently hidden or not.
		1582
1077	=item $view_start = $term->view_start ([$newvalue])	1583	=item $view_start = $term->view_start ([$newvalue])
1078		1584
1079	Returns the negative row number of the topmost line. Minimum value is	1585	Returns the row number of the topmost displayed line. Maximum value is
1080	C<0>, which displays the normal terminal contents. Larger values scroll	1586	C<0>, which displays the normal terminal contents. Lower values scroll
1081	this many lines into the scrollback buffer.	1587	this many lines into the scrollback buffer.
1082		1588
1083	=item $term->want_refresh	1589	=item $term->want_refresh
1084		1590
1085	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1591	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1088		1594
1089	Used after changing terminal contents to display them.	1595	Used after changing terminal contents to display them.
1090		1596
1091	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1597	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1092		1598
1093	Returns the text of the entire row with number C<$row_number>. Row C<0>	1599	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	1600	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	1601	terminal line. Nothing will be returned if a nonexistent line
1097	is requested.	1602	is requested.
1098		1603
1099	If C<$new_text> is specified, it will replace characters in the current	1604	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	1605	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	1606	to replace only parts of a line. The font index in the rendition will
1102	automatically be updated.	1607	automatically be updated.
1103		1608
1104	C<$text> is in a special encoding: tabs and wide characters that use more	1609	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	1610	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1106	(C<chr 65535>). Characters with combining characters and other characters	1611	characters. Characters with combining characters and other characters that
1107	that do not fit into the normal tetx encoding will be replaced with	1612	do not fit into the normal text encoding will be replaced with characters
1108	characters in the private use area.	1613	in the private use area.
1109		1614
1110	You have to obey this encoding when changing text. The advantage is	1615	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	1616	that C<substr> and similar functions work on screen cells and not on
1112	characters.	1617	characters.
1113		1618
…		…
1164	Return the row number of the first/last row of the line, respectively.	1669	Return the row number of the first/last row of the line, respectively.
1165		1670
1166	=item $offset = $line->offset_of ($row, $col)	1671	=item $offset = $line->offset_of ($row, $col)
1167		1672
1168	Returns the character offset of the given row|col pair within the logical	1673	Returns the character offset of the given row|col pair within the logical
1169	line.	1674	line. Works for rows outside the line, too, and returns corresponding
		1675	offsets outside the string.
1170		1676
1171	=item ($row, $col) = $line->coord_of ($offset)	1677	=item ($row, $col) = $line->coord_of ($offset)
1172		1678
1173	Translates a string offset into terminal coordinates again.	1679	Translates a string offset into terminal coordinates again.
1174		1680
…		…
1196	}	1702	}
1197		1703
1198	sub urxvt::line::t {	1704	sub urxvt::line::t {
1199	my ($self) = @_;	1705	my ($self) = @_;
1200		1706
1201	if (@_ > 1)	1707	if (@_ > 1) {
1202	{
1203	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1708	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1204	for $self->{beg} .. $self->{end};	1709	for $self->{beg} .. $self->{end};
1205	}	1710	}
1206		1711
1207	defined wantarray &&	1712	defined wantarray &&
1208	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1713	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1209	0, $self->{len}	1714	0, $self->{len}
1210	}	1715	}
1211		1716
1212	sub urxvt::line::r {	1717	sub urxvt::line::r {
1213	my ($self) = @_;	1718	my ($self) = @_;
1214		1719
1215	if (@_ > 1)	1720	if (@_ > 1) {
1216	{
1217	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1721	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1218	for $self->{beg} .. $self->{end};	1722	for $self->{beg} .. $self->{end};
1219	}	1723	}
1220		1724
1221	if (defined wantarray) {	1725	if (defined wantarray) {
1222	my $rend = [	1726	my $rend = [
1223	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1727	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1224	];	1728	];
…		…
1256	where one character corresponds to one screen cell. See	1760	where one character corresponds to one screen cell. See
1257	C<< $term->ROW_t >> for details.	1761	C<< $term->ROW_t >> for details.
1258		1762
1259	=item $string = $term->special_decode $text	1763	=item $string = $term->special_decode $text
1260		1764
1261	Converts rxvt-unicodes text reprsentation into a perl string. See	1765	Converts rxvt-unicodes text representation into a perl string. See
1262	C<< $term->ROW_t >> for details.	1766	C<< $term->ROW_t >> for details.
1263		1767
1264	=item $success = $term->grab_button ($button, $modifiermask)	1768	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1265		1769
		1770	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1771
1266	Registers a synchronous button grab. See the XGrabButton manpage.	1772	Register/unregister a synchronous button grab. See the XGrabButton
		1773	manpage.
1267		1774
1268	=item $success = $term->grab ($eventtime[, $sync])	1775	=item $success = $term->grab ($eventtime[, $sync])
1269		1776
1270	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1777	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1271	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1778	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1272		1779
1273	=item $term->allow_events_async	1780	=item $term->allow_events_async
1274		1781
1275	Calls XAllowEvents with AsyncBoth for the most recent grab.	1782	Calls XAllowEvents with AsyncBoth for the most recent grab.
1276		1783
…		…
1283	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1790	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1284	recent grab.	1791	recent grab.
1285		1792
1286	=item $term->ungrab	1793	=item $term->ungrab
1287		1794
1288	Calls XUngrab for the most recent grab. Is called automatically on	1795	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	1796	evaluation errors, as it is better to lose the grab in the error case as
1290	the session.	1797	the session.
		1798
		1799	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1800
		1801	=item $atom_name = $term->XGetAtomName ($atom)
		1802
		1803	=item @atoms = $term->XListProperties ($window)
		1804
		1805	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1806
		1807	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1808
		1809	=item $term->XDeleteProperty ($window, $property)
		1810
		1811	=item $window = $term->DefaultRootWindow
		1812
		1813	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1814
		1815	=item $term->XMapWindow ($window)
		1816
		1817	=item $term->XUnmapWindow ($window)
		1818
		1819	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1820
		1821	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1822
		1823	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1824
		1825	=item $keysym = $term->XStringToKeysym ($string)
		1826
		1827	=item $string = $term->XKeysymToString ($keysym)
		1828
		1829	Various X or X-related functions. The C<$term> object only serves as
		1830	the source of the display, otherwise those functions map more-or-less
		1831	directly onto the X functions of the same name.
1291		1832
1292	=back	1833	=back
1293		1834
1294	=cut	1835	=cut
1295		1836
…		…
1359	my ($self, $text, $cb) = @_;	1900	my ($self, $text, $cb) = @_;
1360		1901
1361	$self->add_item ({ type => "button", text => $text, activate => $cb});	1902	$self->add_item ({ type => "button", text => $text, activate => $cb});
1362	}	1903	}
1363		1904
1364	=item $popup->add_toggle ($text, $cb, $initial_value)	1905	=item $popup->add_toggle ($text, $initial_value, $cb)
1365		1906
1366	Adds a toggle/checkbox item to the popup. Teh callback gets called	1907	Adds a toggle/checkbox item to the popup. The callback gets called
1367	whenever it gets toggled, with a boolean indicating its value as its first	1908	whenever it gets toggled, with a boolean indicating its new value as its
1368	argument.	1909	first argument.
1369		1910
1370	=cut	1911	=cut
1371		1912
1372	sub add_toggle {	1913	sub add_toggle {
1373	my ($self, $text, $cb, $value) = @_;	1914	my ($self, $text, $value, $cb) = @_;
1374		1915
1375	my $item; $item = {	1916	my $item; $item = {
1376	type => "button",	1917	type => "button",
1377	text => " $text",	1918	text => " $text",
1378	value => $value,	1919	value => $value,
…		…
1392	sub show {	1933	sub show {
1393	my ($self) = @_;	1934	my ($self) = @_;
1394		1935
1395	local $urxvt::popup::self = $self;	1936	local $urxvt::popup::self = $self;
1396		1937
		1938	my $env = $self->{term}->env;
		1939	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1940	delete $env->{LC_ALL};
1397	local $ENV{LC_ALL} = $self->{term}->locale;	1941	$env->{LC_CTYPE} = $self->{term}->locale;
1398		1942
1399	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1943	my $term = urxvt::term->new (
		1944	$env, "popup",
		1945	"--perl-lib" => "", "--perl-ext-common" => "",
		1946	"-pty-fd" => -1, "-sl" => 0,
		1947	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1400	"--transient-for" => $self->{term}->parent,	1948	"--transient-for" => $self->{term}->parent,
1401	"-display" => $self->{term}->display_id,	1949	"-display" => $self->{term}->display_id,
1402	"-pe" => "urxvt-popup")	1950	"-pe" => "urxvt-popup",
1403	or die "unable to create popup window\n";	1951	) or die "unable to create popup window\n";
		1952
		1953	unless (delete $term->{urxvt_popup_init_done}) {
		1954	$term->ungrab;
		1955	$term->destroy;
		1956	die "unable to initialise popup window\n";
		1957	}
1404	}	1958	}
1405		1959
1406	sub DESTROY {	1960	sub DESTROY {
1407	my ($self) = @_;	1961	my ($self) = @_;
1408		1962
1409	delete $self->{term}{_destroy}{$self};	1963	delete $self->{term}{_destroy}{$self};
1410	$self->{term}->ungrab;	1964	$self->{term}->ungrab;
1411	}	1965	}
		1966
		1967	=back
		1968
		1969	=cut
		1970
		1971	package urxvt::watcher;
1412		1972
1413	=head2 The C<urxvt::timer> Class	1973	=head2 The C<urxvt::timer> Class
1414		1974
1415	This class implements timer watchers/events. Time is represented as a	1975	This class implements timer watchers/events. Time is represented as a
1416	fractional number of seconds since the epoch. Example:	1976	fractional number of seconds since the epoch. Example:
…		…
1420	->new	1980	->new
1421	->interval (1)	1981	->interval (1)
1422	->cb (sub {	1982	->cb (sub {
1423	$term->{overlay}->set (0, 0,	1983	$term->{overlay}->set (0, 0,
1424	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1984	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1425	});	1985	});
1426		1986
1427	=over 4	1987	=over 4
1428		1988
1429	=item $timer = new urxvt::timer	1989	=item $timer = new urxvt::timer
1430		1990
…		…
1433		1993
1434	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1994	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1435		1995
1436	Set the callback to be called when the timer triggers.	1996	Set the callback to be called when the timer triggers.
1437		1997
1438	=item $tstamp = $timer->at
1439
1440	Return the time this watcher will fire next.
1441
1442	=item $timer = $timer->set ($tstamp)	1998	=item $timer = $timer->set ($tstamp[, $interval])
1443		1999
1444	Set the time the event is generated to $tstamp.	2000	Set the time the event is generated to $tstamp (and optionally specifies a
		2001	new $interval).
1445		2002
1446	=item $timer = $timer->interval ($interval)	2003	=item $timer = $timer->interval ($interval)
1447		2004
1448	Normally (and when C<$interval> is C<0>), the timer will automatically	2005	By default (and when C<$interval> is C<0>), the timer will automatically
1449	stop after it has fired once. If C<$interval> is non-zero, then the timer	2006	stop after it has fired once. If C<$interval> is non-zero, then the timer
1450	is automatically rescheduled at the given intervals.	2007	is automatically rescheduled at the given intervals.
1451		2008
1452	=item $timer = $timer->start	2009	=item $timer = $timer->start
1453		2010
1454	Start the timer.	2011	Start the timer.
1455		2012
1456	=item $timer = $timer->start ($tstamp)	2013	=item $timer = $timer->start ($tstamp[, $interval])
1457		2014
1458	Set the event trigger time to C<$tstamp> and start the timer.	2015	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2016	also replaces the interval.
		2017
		2018	=item $timer = $timer->after ($delay[, $interval])
		2019
		2020	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1459		2021
1460	=item $timer = $timer->stop	2022	=item $timer = $timer->stop
1461		2023
1462	Stop the timer.	2024	Stop the timer.
1463		2025
…		…
1469		2031
1470	$term->{socket} = ...	2032	$term->{socket} = ...
1471	$term->{iow} = urxvt::iow	2033	$term->{iow} = urxvt::iow
1472	->new	2034	->new
1473	->fd (fileno $term->{socket})	2035	->fd (fileno $term->{socket})
1474	->events (urxvt::EVENT_READ)	2036	->events (urxvt::EV_READ)
1475	->start	2037	->start
1476	->cb (sub {	2038	->cb (sub {
1477	my ($iow, $revents) = @_;	2039	my ($iow, $revents) = @_;
1478	# $revents must be 1 here, no need to check	2040	# $revents must be 1 here, no need to check
1479	sysread $term->{socket}, my $buf, 8192	2041	sysread $term->{socket}, my $buf, 8192
…		…
1492	Set the callback to be called when io events are triggered. C<$reventmask>	2054	Set the callback to be called when io events are triggered. C<$reventmask>
1493	is a bitset as described in the C<events> method.	2055	is a bitset as described in the C<events> method.
1494		2056
1495	=item $iow = $iow->fd ($fd)	2057	=item $iow = $iow->fd ($fd)
1496		2058
1497	Set the filedescriptor (not handle) to watch.	2059	Set the file descriptor (not handle) to watch.
1498		2060
1499	=item $iow = $iow->events ($eventmask)	2061	=item $iow = $iow->events ($eventmask)
1500		2062
1501	Set the event mask to watch. The only allowed values are	2063	Set the event mask to watch. The only allowed values are
1502	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2064	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1503	together, or C<urxvt::EVENT_NONE>.	2065	together, or C<urxvt::EV_NONE>.
1504		2066
1505	=item $iow = $iow->start	2067	=item $iow = $iow->start
1506		2068
1507	Start watching for requested events on the given handle.	2069	Start watching for requested events on the given handle.
1508		2070
1509	=item $iow = $iow->stop	2071	=item $iow = $iow->stop
1510		2072
1511	Stop watching for events on the given filehandle.	2073	Stop watching for events on the given file handle.
		2074
		2075	=back
		2076
		2077	=head2 The C<urxvt::iw> Class
		2078
		2079	This class implements idle watchers, that get called automatically when
		2080	the process is idle. They should return as fast as possible, after doing
		2081	some useful work.
		2082
		2083	=over 4
		2084
		2085	=item $iw = new urxvt::iw
		2086
		2087	Create a new idle watcher object in stopped state.
		2088
		2089	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2090
		2091	Set the callback to be called when the watcher triggers.
		2092
		2093	=item $timer = $timer->start
		2094
		2095	Start the watcher.
		2096
		2097	=item $timer = $timer->stop
		2098
		2099	Stop the watcher.
		2100
		2101	=back
		2102
		2103	=head2 The C<urxvt::pw> Class
		2104
		2105	This class implements process watchers. They create an event whenever a
		2106	process exits, after which they stop automatically.
		2107
		2108	my $pid = fork;
		2109	...
		2110	$term->{pw} = urxvt::pw
		2111	->new
		2112	->start ($pid)
		2113	->cb (sub {
		2114	my ($pw, $exit_status) = @_;
		2115	...
		2116	});
		2117
		2118	=over 4
		2119
		2120	=item $pw = new urxvt::pw
		2121
		2122	Create a new process watcher in stopped state.
		2123
		2124	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2125
		2126	Set the callback to be called when the timer triggers.
		2127
		2128	=item $pw = $timer->start ($pid)
		2129
		2130	Tells the watcher to start watching for process C<$pid>.
		2131
		2132	=item $pw = $pw->stop
		2133
		2134	Stop the watcher.
1512		2135
1513	=back	2136	=back
1514		2137
1515	=head1 ENVIRONMENT	2138	=head1 ENVIRONMENT
1516		2139
…		…
1523		2146
1524	=item == 0 - fatal messages	2147	=item == 0 - fatal messages
1525		2148
1526	=item >= 3 - script loading and management	2149	=item >= 3 - script loading and management
1527		2150
1528	=item >=10 - all events received	2151	=item >=10 - all called hooks
		2152
		2153	=item >=11 - hook return values
1529		2154
1530	=back	2155	=back
1531		2156
1532	=head1 AUTHOR	2157	=head1 AUTHOR
1533		2158
1534	Marc Lehmann <pcg@goof.com>	2159	Marc Lehmann <schmorp@schmorp.de>
1535	http://software.schmorp.de/pkg/rxvt-unicode	2160	http://software.schmorp.de/pkg/rxvt-unicode
1536		2161
1537	=cut	2162	=cut
1538		2163
1539	1	2164	1
		2165
		2166	# vim: sw=3:

Diff Legend

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