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

Diff Legend

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