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.55 by root, Sun Jan 8 05:50:27 2006 UTC vs.
Revision 1.259 by sf-exg, Sat May 8 06:16:21 2021 UTC

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

Diff Legend

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