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.82 by root, Thu Jan 12 01:30:53 2006 UTC vs.
Revision 1.220 by root, Tue Jun 19 18:17:56 2012 UTC

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

Diff Legend

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