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.69 by root, Mon Jan 9 22:41:41 2006 UTC vs.
Revision 1.269 by root, Sun Nov 21 15:15:02 2021 UTC

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

Diff Legend

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