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

Diff Legend

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