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

Diff Legend

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