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.71 by root, Mon Jan 9 23:18:49 2006 UTC vs.
Revision 1.257 by root, Thu Jul 13 10:31:27 2017 UTC

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

Diff Legend

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