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

Diff Legend

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