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

Diff Legend

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