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

Diff Legend

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