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.100 by root, Wed Jan 18 08:33:34 2006 UTC vs.
Revision 1.269 by root, Sun Nov 21 15:15:02 2021 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in some directory:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt instance using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib path/to/somedirectory -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict qw(vars subs)' and 'use utf8'
26	thus must be encoded as UTF-8.	26	environment, and thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	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	This is a little rarely useful extension that Uploads the selection as
170	textfile to a remote site (or does other things). (The implementation is
171	not currently secure for use in a multiuser environment as it writes to
172	F</tmp> directly.).
173
174	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
175	i.e.
176
177	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
178
179	Pressing this combination runs a command with C<%> replaced by the name of
180	the textfile. This command can be set via a resource:
181
182	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
183
184	And the default is likely not useful to anybody but the few people around
185	here :)
186
187	The name of the textfile is the hex encoded md5 sum of the selection, so
188	the same content should lead to the same filename.
189
190	After a successful upload the selection will be replaced by the text given
191	in the C<selection-pastebin-url> resource (again, the % is the placeholder
192	for the filename):
193
194	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
195
196	=back
197		56
198	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
199		58
200	=head2 General API Considerations	59	=head2 General API Considerations
201		60
…		…
211	terminal is destroyed.	70	terminal is destroyed.
212		71
213	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
214	hints on what they mean:	73	hints on what they mean:
215		74
216	=over 4	75	=over
217		76
218	=item $text	77	=item $text
219		78
220	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
221	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.
222		81
223	=item $string	82	=item $string
224		83
225	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
…		…
229	=item $octets	88	=item $octets
230		89
231	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
232	locale-specific way.	91	locale-specific way.
233		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
234	=back	99	=back
235		100
236	=head2 Extension Objects	101	=head2 Extension Objects
237		102
238	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
239	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,
240	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
241	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
242	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
243	use.	109	internal use.
244		110
245	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
246	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
247		113
248	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.
249		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
250	=over 4	128	=over
251		129
252	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
253		131
254	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
255	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.
256		135
257	=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.
258		138
259	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
260	this extension, replacing any previous hook. This is useful when you want	140	comment:
261	to overwrite time-critical hooks only temporarily.
262		141
263	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
264		143
265	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
266		183
267	=back	184	=back
268		185
269	=head2 Hooks	186	=head2 Hooks
270		187
271	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
272	called whenever the relevant event happens.	189	called whenever the relevant event happens.
273		190
274	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
275	the in the C<Extension Objects> section.	192	the in the C<Extension Objects> section.
276		193
277	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
278	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
279	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.
280		197
281	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
282		199
283	=over 4	200	=over
284		201
285	=item on_init $term	202	=item on_init $term
286		203
287	Called after a new terminal object has been initialized, but before	204	Called after a new terminal object has been initialized, but before
288	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
289	call or deliver senseless data, as terminal size and other characteristics	206	call or deliver senseless data, as terminal size and other characteristics
290	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
291	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).
292		220
293	=item on_reset $term	221	=item on_reset $term
294		222
295	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
296	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
297	variables.	225	variables.
298		226
299	=item on_start $term	227	=item on_child_start $term, $pid
300		228
301	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.
302	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>.
303		235
304	=item on_sel_make $term, $eventtime	236	=item on_sel_make $term, $eventtime
305		237
306	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
307	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
…		…
314		246
315	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
316	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
317	by calling C<< $term->selection >>.	249	by calling C<< $term->selection >>.
318		250
319	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.
320		252
321	=item on_sel_extend $term	253	=item on_sel_extend $term
322		254
323	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
324	click) and is either supposed to return false (normal operation), or	256	click) and is either supposed to return false (normal operation), or
325	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
326	processing. This can happen multiple times, as long as the callback	258	processing. This can happen multiple times, as long as the callback
327	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
328	supposed to enlarge the selection more and more, if possible.	260	supposed to enlarge the selection more and more, if possible.
329		261
330	See the F<selection> example extension.	262	See the F<selection> example extension.
331		263
332	=item on_view_change $term, $offset	264	=item on_view_change $term, $offset
333		265
334	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
335	scrolls. Offset C<0> means display the normal terminal, positive values	267	scrolls. Offset C<0> means display the normal terminal, positive values
336	show this many lines of scrollback.	268	show this many lines of scrollback.
337		269
338	=item on_scroll_back $term, $lines, $saved	270	=item on_scroll_back $term, $lines, $saved
339		271
…		…
343		275
344	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,
345	$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
346	number of lines that will be in the scrollback buffer.	278	number of lines that will be in the scrollback buffer.
347		279
348	=item on_osc_seq $term, $string	280	=item on_osc_seq $term, $op, $args, $resp
349		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
350	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	292	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
351	operating system command) is processed. Cursor position and other state	293	(OSC = operating system command) is processed. Cursor position and other
352	information is up-to-date when this happens. For interoperability, the	294	state information is up-to-date when this happens. For interoperability,
353	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
354	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
355	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	}
356		308
357	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,
358	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
359	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.
360		315
361	=item on_add_lines $term, $string	316	=item on_add_lines $term, $string
362		317
363	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
364	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
…		…
369	=item on_tt_write $term, $octets	324	=item on_tt_write $term, $octets
370		325
371	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
372	suppress or filter tty input.	327	suppress or filter tty input.
373		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
374	=item on_line_update $term, $row	336	=item on_line_update $term, $row
375		337
376	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
377	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
378	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,
…		…
385	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
386	you cannot just toggle rendition bits, but only set them.	348	you cannot just toggle rendition bits, but only set them.
387		349
388	=item on_refresh_begin $term	350	=item on_refresh_begin $term
389		351
390	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
391	or similar effects by modify terminal contents in refresh_begin, and	353	similar effects by modifying the terminal contents in refresh_begin, and
392	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
393	code is run after this hook, and takes precedence.	355	code is run after this hook, and takes precedence.
394		356
395	=item on_refresh_end $term	357	=item on_refresh_end $term
396		358
397	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>.
398		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
399	=item on_keyboard_command $term, $string	369	=item on_user_command $term, $string *DEPRECATED*
400		370
401	Called whenever the user presses a key combination that has a	371	Called whenever a user-configured event is being activated (e.g. via
402	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>
403	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.
404		383
405	=item on_x_event $term, $event	384	=item on_x_event $term, $event
406		385
407	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
408	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
409	members are not passed.	388	members are not passed.
410		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
411	=item on_focus_in $term	394	=item on_focus_in $term
412		395
413	Called whenever the window gets the keyboard focus, before rxvt-unicode	396	Called whenever the window gets the keyboard focus, before rxvt-unicode
414	does focus in processing.	397	does focus in processing.
415		398
416	=item on_focus_out $term	399	=item on_focus_out $term
417		400
418	Called wheneever the window loses keyboard focus, before rxvt-unicode does	401	Called whenever the window loses keyboard focus, before rxvt-unicode does
419	focus out processing.	402	focus out processing.
420		403
		404	=item on_configure_notify $term, $event
		405
		406	=item on_property_notify $term, $event
		407
421	=item on_key_press $term, $event, $keysym, $octets	408	=item on_key_press $term, $event, $keysym, $octets
422		409
423	=item on_key_release $term, $event, $keysym	410	=item on_key_release $term, $event, $keysym
424		411
425	=item on_button_press $term, $event	412	=item on_button_press $term, $event
…		…
430		417
431	=item on_map_notify $term, $event	418	=item on_map_notify $term, $event
432		419
433	=item on_unmap_notify $term, $event	420	=item on_unmap_notify $term, $event
434		421
435	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
436	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.
437		424
438	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
439	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
440	and column under the mouse cursor.	427	(real, not screen-based) row and column under the mouse cursor.
441		428
442	C<on_key_press> additionally receives the string rxvt-unicode would	429	C<on_key_press> additionally receives the string rxvt-unicode would
443	output, if any, in locale-specific encoding.	430	output, if any, in locale-specific encoding.
444		431
445	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.
446		444
447	=back	445	=back
448		446
449	=cut	447	=cut
450		448
451	package urxvt;	449	package urxvt;
452		450
453	use utf8;	451	use utf8;
454	use strict;	452	use strict qw(vars subs);
455	use Carp ();	453	use Carp ();
456	use Scalar::Util ();	454	use Scalar::Util ();
457	use List::Util ();	455	use List::Util ();
458		456
459	our $VERSION = 1;	457	our $VERSION = 1;
460	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.
461	our @HOOKNAME;	461	our @HOOKNAME;
462	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	462	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
463	our %OPTION;	463	our %OPTION;
464		464
465	our $LIBDIR;	465	our $LIBDIR;
466	our $RESNAME;	466	our $RESNAME;
467	our $RESCLASS;	467	our $RESCLASS;
468	our $RXVTNAME;	468	our $RXVTNAME;
469		469
		470	our $NOCHAR = chr 0xffff;
		471
470	=head2 Variables in the C<urxvt> Package	472	=head2 Variables in the C<urxvt> Package
471		473
472	=over 4	474	=over
473		475
474	=item $urxvt::LIBDIR	476	=item $urxvt::LIBDIR
475		477
476	The rxvt-unicode library directory, where, among other things, the perl	478	The rxvt-unicode library directory, where, among other things, the perl
477	modules and scripts are stored.	479	modules and scripts are stored.
…		…
487	=item $urxvt::TERM	489	=item $urxvt::TERM
488		490
489	The current terminal. This variable stores the current C<urxvt::term>	491	The current terminal. This variable stores the current C<urxvt::term>
490	object, whenever a callback/hook is executing.	492	object, whenever a callback/hook is executing.
491		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
492	=back	510	=back
493		511
494	=head2 Functions in the C<urxvt> Package	512	=head2 Functions in the C<urxvt> Package
495		513
496	=over 4	514	=over
497		515
498	=item urxvt::fatal $errormessage	516	=item urxvt::fatal $errormessage
499		517
500	Fatally aborts execution with the given error message. Avoid at all	518	Fatally aborts execution with the given error message (which should
501	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
502	starts up.	520	is acceptable (and useful) is in the init hook, where it prevents the
		521	terminal from starting up.
503		522
504	=item urxvt::warn $string	523	=item urxvt::warn $string
505		524
506	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
507	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
508	that calls this function.	527	that calls this function.
509		528
510	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
511	correct place, e.g. on stderr of the connecting urxvtc client.	530	correct place, e.g. on stderr of the connecting urxvtc client.
512		531
513	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).
514		540
515	=item $time = urxvt::NOW	541	=item $time = urxvt::NOW
516		542
517	Returns the "current time" (as per the event loop).	543	Returns the "current time" (as per the event loop).
518		544
…		…
538	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	564	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
539	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	565	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
540		566
541	Various constants for use in X calls and event processing.	567	Various constants for use in X calls and event processing.
542		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
543	=back	581	=back
544		582
545	=head2 RENDITION	583	=head2 RENDITION
546		584
547	Rendition bitsets contain information about colour, font, font styles and	585	Rendition bitsets contain information about colour, font, font styles and
…		…
550	The following "macros" deal with changes in rendition sets. You should	588	The following "macros" deal with changes in rendition sets. You should
551	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,
552	as they contain important information required for correct operation of	590	as they contain important information required for correct operation of
553	rxvt-unicode.	591	rxvt-unicode.
554		592
555	=over 4	593	=over
556		594
557	=item $rend = urxvt::DEFAULT_RSTYLE	595	=item $rend = urxvt::DEFAULT_RSTYLE
558		596
559	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
560	being reset. Useful as a base to start when creating renditions.	598	being reset. Useful as a base to start when creating renditions.
561		599
562	=item $rend = urxvt::OVERLAY_RSTYLE	600	=item $rend = urxvt::OVERLAY_RSTYLE
563		601
564	Return the rendition mask used for overlays by default.	602	Return the rendition mask used for overlays by default.
565		603
566	=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
567		606
568	Return the bit that enabled bold, italic, blink, reverse-video and	607	Return the bit that enabled bold, italic, blink, reverse-video and
569	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
570	the bitset.	609	the bitset.
571		610
…		…
576	Return the foreground/background colour index, respectively.	615	Return the foreground/background colour index, respectively.
577		616
578	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	617	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
579		618
580	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	619	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		620
		621	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
581		622
582	Replace the foreground/background colour in the rendition mask with the	623	Replace the foreground/background colour in the rendition mask with the
583	specified one.	624	specified one.
584		625
585	=item $value = urxvt::GET_CUSTOM $rend	626	=item $value = urxvt::GET_CUSTOM $rend
…		…
602	my $msg = join "", @_;	643	my $msg = join "", @_;
603	$msg .= "\n"	644	$msg .= "\n"
604	unless $msg =~ /\n$/;	645	unless $msg =~ /\n$/;
605	urxvt::warn ($msg);	646	urxvt::warn ($msg);
606	};	647	};
607
608	# %ENV is the original startup environment
609	delete $ENV{IFS};
610	delete $ENV{CDPATH};
611	delete $ENV{BASH_ENV};
612	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
613	}	648	}
614		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
615	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	718	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
616		719
617	sub verbose {	720	sub verbose {
618	my ($level, $msg) = @_;	721	my ($level, $msg) = @_;
619	warn "$msg\n" if $level <= $verbosity;	722	warn "$msg\n" if $level <= $verbosity;
620	}	723	}
…		…
622	my %extension_pkg;	725	my %extension_pkg;
623		726
624	# load a single script into its own package, once only	727	# load a single script into its own package, once only
625	sub extension_package($) {	728	sub extension_package($) {
626	my ($path) = @_;	729	my ($path) = @_;
627
628	no strict 'refs';
629		730
630	$extension_pkg{$path} ||= do {	731	$extension_pkg{$path} ||= do {
631	$path =~ /([^\/\\]+)$/;	732	$path =~ /([^\/\\]+)$/;
632	my $pkg = $1;	733	my $pkg = $1;
633	$pkg =~ s/[^[:word:]]/_/g;	734	$pkg =~ s/[^[:word:]]/_/g;
634	$pkg = "urxvt::ext::$pkg";	735	$pkg = "urxvt::ext::$pkg";
635		736
636	verbose 3, "loading extension '$path' into package '$pkg'";	737	verbose 3, "loading extension '$path' into package '$pkg'";
637		738
		739	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		740
638	open my $fh, "<:raw", $path	741	open my $fh, "<:raw", $path
639	or die "$path: $!";	742	or die "$path: $!";
640		743
641	@{"$pkg\::ISA"} = urxvt::term::extension::;
642
643	my $source =	744	my $source =
644	"package $pkg; use strict; use utf8;\n"	745	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
645	. "#line 1 \"$path\"\n{\n"	746	. "#line 1 \"$path\"\n{\n"
646	. (do { local $/; <$fh> })	747	. (do { local $/; <$fh> })
647	. "\n};\n1";	748	. "\n};\n1";
648		749
649	eval $source	750	eval $source
…		…
658	# called by the rxvt core	759	# called by the rxvt core
659	sub invoke {	760	sub invoke {
660	local $TERM = shift;	761	local $TERM = shift;
661	my $htype = shift;	762	my $htype = shift;
662		763
663	if ($htype == 0) { # INIT	764	if ($htype == HOOK_INIT) {
664	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	765	$TERM->scan_extensions;
665		766
666	my %ext_arg;	767	my %ext_arg;
667		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} },
668	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	780	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		781	) {
669	if ($_ eq "default") {	782	if ($_ eq "default") {
		783
		784	$ext_arg{$_} = []
670	$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
671	} elsif (/^-(.*)$/) {	796	} elsif (/^-(.*)$/) { # remove from set
672	delete $ext_arg{$1};	797	delete $ext_arg{$1};
673	} 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};
674	push @{ $ext_arg{$1} }, $2;	804	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		805
675	} else {	806	} else {
676	$ext_arg{$_} ||= [];	807	verbose 2, "cannot parse extension specification '$_', ignoring.";
677	}	808	}
678	}	809	}
679		810
680	while (my ($ext, $argv) = each %ext_arg) {	811	$TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
681	my @files = grep -f $_, map "$_/$ext", @dirs;	812	$TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
682		813
683	if (@files) {	814	for my $ext (sort keys %ext_arg) {
684	$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});
685	} else {	819	} else {
686	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";
687	}	821	}
688	}	822	}
689		823
690	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");
691	warn $@ if $@;	825	warn $@ if $@;
692	}	826	}
693		827
		828	if ($htype == HOOK_OSC_SEQ) {
		829	if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
		830	$TERM->autoload_extension ($_->[0]) for @$exts;
		831	}
		832	} elsif ($htype == HOOK_OSC_SEQ_PERL) {
		833	if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
		834	$TERM->autoload_extension ($_->[0]) for @$exts;
		835	}
		836	}
		837
694	$retval = undef;	838	$retval = undef;
695		839
696	if (my $cb = $TERM->{_hook}[$htype]) {	840	if (my $cb = $TERM->{_hook}[$htype]) {
697	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	841	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
698	if $verbosity >= 10;	842	if $verbosity >= 10;
699		843
700	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";
701		850
702	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) {
703	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	858	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
704	and last;	859	$retval ||= $retval_;
705		860
706	if ($@) {	861	if ($@) {
707	$TERM->ungrab; # better to lose the grab than the session	862	$TERM->ungrab; # better to lose the grab than the session
708	warn $@;	863	warn $@;
709	}	864	}
…		…
711		866
712	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	867	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
713	if $verbosity >= 11;	868	if $verbosity >= 11;
714	}	869	}
715		870
716	if ($htype == 1) { # DESTROY	871	if ($htype == HOOK_DESTROY) {
717	# clear package objects	872	# clear package objects
718	%$_ = () for values %{ $TERM->{_pkg} };	873	%$_ = () for values %{ $TERM->{_pkg} };
719		874
720	# clear package	875	# clear package
721	%$TERM = ();	876	%$TERM = ();
722	}	877	}
723		878
724	$retval	879	$retval
725	}	880	}
726		881
727	sub exec_async(@) {	882	sub SET_COLOR($$$) {
728	my $pid = fork;	883	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
729
730	return
731	if !defined $pid or $pid;
732
733	%ENV = %{ $TERM->env };
734
735	exec @_;
736	_exit 255;
737	}	884	}
738		885
739	# 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	}
740		910
741	package urxvt::term::extension;	911	package urxvt::term::extension;
742		912
743	sub enable {	913	=head2 The C<urxvt::term::extension> class
744	my ($self, %hook) = @_;
745	my $pkg = $self->{_pkg};
746		914
747	while (my ($name, $cb) = each %hook) {	915	Each extension attached to a terminal object is represented by
748	my $htype = $HOOKTYPE{uc $name};	916	a C<urxvt::term::extension> object.
749	defined $htype
750	or Carp::croak "unsupported hook type '$name'";
751		917
752	$self->set_should_invoke ($htype, +1)	918	You can use these objects, which are passed to all callbacks to store any
753	unless exists $self->{term}{_hook}[$htype]{$pkg};	919	state related to the terminal and extension instance.
754		920
755	$self->{term}{_hook}[$htype]{$pkg} = $cb;	921	The methods (And data members) documented below can be called on extension
756	}	922	objects, in addition to call methods documented for the <urxvt::term>
757	}	923	class.
758		924
759	sub disable {	925	=over
760	my ($self, @hook) = @_;
761	my $pkg = $self->{_pkg};
762		926
763	for my $name (@hook) {	927	=item $urxvt_term = $self->{term}
764	my $htype = $HOOKTYPE{uc $name};
765	defined $htype
766	or Carp::croak "unsupported hook type '$name'";
767		928
768	$self->set_should_invoke ($htype, -1)	929	Returns the C<urxvt::term> object associated with this instance of the
769	if delete $self->{term}{_hook}[$htype]{$pkg};	930	extension. This member I<must not> be changed in any way.
770	}	931
771	}	932	=cut
772		933
773	our $AUTOLOAD;	934	our $AUTOLOAD;
774		935
775	sub AUTOLOAD {	936	sub AUTOLOAD {
776	$AUTOLOAD =~ /:([^:]+)$/	937	$AUTOLOAD =~ /:([^:]+)$/
…		…
789		950
790	sub DESTROY {	951	sub DESTROY {
791	# nop	952	# nop
792	}	953	}
793		954
794	# urxvt::destroy_hook	955	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
795		956
796	sub urxvt::destroy_hook::DESTROY {	957	sub urxvt::destroy_hook::DESTROY {
797	${$_[0]}->();	958	${$_[0]}->();
798	}	959	}
799		960
800	sub urxvt::destroy_hook(&) {	961	sub urxvt::destroy_hook(&) {
801	bless \shift, urxvt::destroy_hook::	962	bless \shift, urxvt::destroy_hook::
802	}	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
803		1087
804	package urxvt::anyevent;	1088	package urxvt::anyevent;
805		1089
806	=head2 The C<urxvt::anyevent> Class	1090	=head2 The C<urxvt::anyevent> Class
807		1091
808	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
809	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
810	further programming. The only exception is that you cannot wait on	1094	further programming. The only exception is that you cannot wait on
811	condition variables, but non-blocking condvar use is ok. What this means	1095	condition variables, but non-blocking condvar use is ok.
812	is that you cannot use blocking APIs, but the non-blocking variant should
813	work.
814		1096
815	=cut	1097	In practical terms this means is that you cannot use blocking APIs, but
		1098	the non-blocking variant should work.
816		1099
		1100	=cut
		1101
817	our $VERSION = 1;	1102	our $VERSION = '5.23';
818		1103
819	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1104	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
820	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1105	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
821		1106
822	sub timer {	1107	sub timer {
…		…
824		1109
825	my $cb = $arg{cb};	1110	my $cb = $arg{cb};
826		1111
827	urxvt::timer	1112	urxvt::timer
828	->new	1113	->new
829	->start (urxvt::NOW + $arg{after})	1114	->after ($arg{after}, $arg{interval})
830	->cb (sub {	1115	->cb ($arg{interval} ? $cb : sub {
831	$_[0]->stop; # need to cancel manually	1116	$_[0]->stop; # need to cancel manually
832	$cb->();	1117	$cb->();
833	})	1118	})
834	}	1119	}
835		1120
836	sub io {	1121	sub io {
837	my ($class, %arg) = @_;	1122	my ($class, %arg) = @_;
838		1123
839	my $cb = $arg{cb};	1124	my $cb = $arg{cb};
		1125	my $fd = fileno $arg{fh};
		1126	defined $fd or $fd = $arg{fh};
840		1127
841	bless [$arg{fh}, urxvt::iow	1128	bless [$arg{fh}, urxvt::iow
842	->new	1129	->new
843	->fd (fileno $arg{fh})	1130	->fd ($fd)
844	->events (($arg{poll} =~ /r/ ? 1 : 0)	1131	->events (($arg{poll} =~ /r/ ? 1 : 0)
845	| ($arg{poll} =~ /w/ ? 2 : 0))	1132	| ($arg{poll} =~ /w/ ? 2 : 0))
846	->start	1133	->start
847	->cb (sub {	1134	->cb ($cb)
848	$cb->(($_[1] & 1 ? 'r' : '')
849	. ($_[1] & 2 ? 'w' : ''));
850	})],
851	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	})
852	}	1161	}
853		1162
854	sub DESTROY {	1163	sub DESTROY {
855	$_[0][1]->stop;	1164	$_[0][1]->stop;
856	}	1165	}
857		1166
858	sub condvar {	1167	# only needed for AnyEvent < 6 compatibility
859	bless \my $flag, urxvt::anyevent::condvar::	1168	sub one_event {
860	}
861
862	sub urxvt::anyevent::condvar::broadcast {
863	${$_[0]}++;
864	}
865
866	sub urxvt::anyevent::condvar::wait {
867	unless (${$_[0]}) {
868	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";
869	}
870	}	1170	}
871		1171
872	package urxvt::term;	1172	package urxvt::term;
873		1173
874	=head2 The C<urxvt::term> Class	1174	=head2 The C<urxvt::term> Class
875		1175
876	=over 4	1176	=over
877		1177
878	=cut	1178	=cut
879		1179
880	# find on_xxx subs in the package and register them	1180	# find on_xxx subs in the package and register them
881	# as hooks	1181	# as hooks
882	sub register_package {	1182	sub register_package {
883	my ($self, $pkg, $argv) = @_;	1183	my ($self, $pkg, $argv) = @_;
884		1184
		1185	no strict 'refs';
		1186
		1187	urxvt::verbose 6, "register package $pkg to $self";
		1188
		1189	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1190
885	my $proxy = bless {	1191	my $proxy = bless {
886	_pkg => $pkg,	1192	_pkg => $pkg,
		1193	_name => ${"$pkg\::_NAME"}, # hackish
887	argv => $argv,	1194	argv => $argv,
888	}, $pkg;	1195	}, $pkg;
889	Scalar::Util::weaken ($proxy->{term} = $self);	1196	Scalar::Util::weaken ($proxy->{term} = $self);
890		1197
891	$self->{_pkg}{$pkg} = $proxy;	1198	$self->{_pkg}{$pkg} = $proxy;
892		1199
…		…
895	$proxy->enable ($name => $ref);	1202	$proxy->enable ($name => $ref);
896	}	1203	}
897	}	1204	}
898	}	1205	}
899		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
900	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1314	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
901		1315
902	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
903	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
904	hash which defines the environment of the new terminal.	1318	hash which defines the environment of the new terminal.
905		1319
906	Croaks (and probably outputs an error message) if the new instance	1320	Croaks (and probably outputs an error message) if the new instance
907	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
908	initialise perl, and the terminal object otherwise. The C<init> and	1322	initialise perl, and the terminal object otherwise. The C<init> and
909	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).
910		1325
911	=cut	1326	=cut
912		1327
913	sub new {	1328	sub new {
914	my ($class, $env, @args) = @_;	1329	my ($class, $env, @args) = @_;
915		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
916	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1334	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
917	}	1335	}
918		1336
919	=item $term->destroy	1337	=item $term->destroy
920		1338
921	Destroy the terminal object (close the window, free resources	1339	Destroy the terminal object (close the window, free resources
922	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
923	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	}
924		1367
925	=item $isset = $term->option ($optval[, $set])	1368	=item $isset = $term->option ($optval[, $set])
926		1369
927	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
928	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
929	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.
930		1373
931	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
932	source file F</src/optinc.h> to see the actual list:	1375	source file F</src/optinc.h> to see the actual list:
933		1376
934	borderLess console cursorBlink cursorUnderline hold iconic insecure	1377	borderLess buffered console cursorBlink cursorUnderline hold iconic
935	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1378	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1379	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
936	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1380	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
937	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1381	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
938	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1382	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
939	tripleclickwords utmpInhibit visualBell	1383	urgentOnBell utmpInhibit visualBell disablePasteBrackets
940		1384
941	=item $value = $term->resource ($name[, $newval])	1385	=item $value = $term->resource ($name[, $newval])
942		1386
943	Returns the current resource value associated with a given name and	1387	Returns the current resource value associated with a given name and
944	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>
…		…
953	likely change).	1397	likely change).
954		1398
955	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
956	terminal is destroyed, so changing options frequently will eat memory.	1400	terminal is destroyed, so changing options frequently will eat memory.
957		1401
958	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
959	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>
960	to see the actual list:	1404	to see the actual list:
961		1405
962	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1406	answerbackstring backgroundPixmap backspace_key blurradius
963	borderLess color cursorBlink cursorUnderline cutchars delete_key	1407	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
964	display_name embed ext_bwidth fade font geometry hold iconName	1408	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
965	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
966	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1411	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
967	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1412	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
968	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1413	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
969	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1414	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
970	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1415	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
971	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1416	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
972	shade term_name title transparent transparent_all tripleclickwords	1417	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
973	utmpInhibit visualBell	1418	term_name title transient_for transparent tripleclickwords urgentOnBell
		1419	utmpInhibit visualBell rewrapMode disablePasteBrackets
974		1420
975	=cut	1421	=cut
976		1422
977	sub resource($$;$) {	1423	sub resource($$;$) {
978	my ($self, $name) = (shift, shift);	1424	my ($self, $name) = (shift, shift);
979	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1425	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
980	&urxvt::term::_resource	1426	goto &urxvt::term::_resource
981	}	1427	}
982		1428
983	=item $value = $term->x_resource ($pattern)	1429	=item $value = $term->x_resource ($pattern)
984		1430
985	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
986	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
987	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
988	resource with that pattern exists.	1434	resource with that pattern exists.
989		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
990	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
991	only one resource database per display, and later invocations might return	1447	only one resource database per display, and later invocations might return
992	the wrong resources.	1448	the wrong resources.
993		1449
994	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1450	=item $value = $term->x_resource_boolean ($pattern)
995		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
996	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
997	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	}
998		1490
999	=item $rend = $term->rstyle ([$new_rstyle])	1491	=item $rend = $term->rstyle ([$new_rstyle])
1000		1492
1001	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
1002	the terminal application will use this style.	1494	the terminal application will use this style.
…		…
1010		1502
1011	=item ($row, $col) = $term->selection_beg ([$row, $col])	1503	=item ($row, $col) = $term->selection_beg ([$row, $col])
1012		1504
1013	=item ($row, $col) = $term->selection_end ([$row, $col])	1505	=item ($row, $col) = $term->selection_end ([$row, $col])
1014		1506
1015	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.
1016	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.
1017		1516
1018	=item $term->selection_make ($eventtime[, $rectangular])	1517	=item $term->selection_make ($eventtime[, $rectangular])
1019		1518
1020	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
1021	C<selection_end>. If C<$rectangular> is true (default: false), a	1520	C<selection_end>. If C<$rectangular> is true (default: false), a
1022	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
1023	a selection.	1522	a selection.
1024		1523
1025	=item $success = $term->selection_grab ($eventtime)	1524	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1026		1525
1027	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
1028	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
1029	is mostly useful from within C<on_sel_grab> hooks.	1529	is mostly useful from within C<on_sel_grab> hooks.
1030		1530
1031	=item $oldtext = $term->selection ([$newtext])	1531	=item $oldtext = $term->selection ([$newtext, $clipboard])
1032		1532
1033	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.
1034		1539
1035	=item $term->overlay_simple ($x, $y, $text)	1540	=item $term->overlay_simple ($x, $y, $text)
1036		1541
1037	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.
1038		1543
…		…
1066	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
1067	as long as the perl object is referenced.	1572	as long as the perl object is referenced.
1068		1573
1069	The methods currently supported on C<urxvt::overlay> objects are:	1574	The methods currently supported on C<urxvt::overlay> objects are:
1070		1575
1071	=over 4	1576	=over
1072		1577
1073	=item $overlay->set ($x, $y, $text, $rend)	1578	=item $overlay->set ($x, $y, $text[, $rend])
1074		1579
1075	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
1076	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
1077	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.
1078		1585
1079	=item $overlay->hide	1586	=item $overlay->hide
1080		1587
1081	If visible, hide the overlay, but do not destroy it.	1588	If visible, hide the overlay, but do not destroy it.
1082		1589
…		…
1118	Returns the number of screen-cells this string would need. Correctly	1625	Returns the number of screen-cells this string would need. Correctly
1119	accounts for wide and combining characters.	1626	accounts for wide and combining characters.
1120		1627
1121	=item $octets = $term->locale_encode ($string)	1628	=item $octets = $term->locale_encode ($string)
1122		1629
1123	Convert the given text string into the corresponding locale encoding.	1630	Convert the given text string into the corresponding locale
		1631	encoding. Returns C<undef> if C<$string> is C<undef>.
1124		1632
1125	=item $string = $term->locale_decode ($octets)	1633	=item $string = $term->locale_decode ($octets)
1126		1634
1127	Convert the given locale-encoded octets into a perl string.	1635	Convert the given locale-encoded octets into a perl string. Returns
		1636	C<undef> if C<$octets> is C<undef>.
1128		1637
1129	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1638	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1130		1639
1131	XORs the rendition values in the given span with the provided value	1640	XORs the rendition values in the given span with the provided value
1132	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in	1641	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
…		…
1145		1654
1146	=item $term->scr_add_lines ($string)	1655	=item $term->scr_add_lines ($string)
1147		1656
1148	Write the given text string to the screen, as if output by the application	1657	Write the given text string to the screen, as if output by the application
1149	running inside the terminal. It may not contain command sequences (escape	1658	running inside the terminal. It may not contain command sequences (escape
1150	codes), but is free to use line feeds, carriage returns and tabs. The	1659	codes - see C<cmd_parse> for that), but is free to use line feeds,
1151	string is a normal text string, not in locale-dependent encoding.	1660	carriage returns and tabs. The string is a normal text string, not in
		1661	locale-dependent encoding.
1152		1662
1153	Normally its not a good idea to use this function, as programs might be	1663	Normally its not a good idea to use this function, as programs might be
1154	confused by changes in cursor position or scrolling. Its useful inside a	1664	confused by changes in cursor position or scrolling. Its useful inside a
1155	C<on_add_lines> hook, though.	1665	C<on_add_lines> hook, though.
1156		1666
		1667	=item $term->scr_change_screen ($screen)
		1668
		1669	Switch to given screen - 0 primary, 1 secondary.
		1670
1157	=item $term->cmd_parse ($octets)	1671	=item $term->cmd_parse ($octets)
1158		1672
1159	Similar to C<scr_add_lines>, but the argument must be in the	1673	Similar to C<scr_add_lines>, but the argument must be in the
1160	locale-specific encoding of the terminal and can contain command sequences	1674	locale-specific encoding of the terminal and can contain command sequences
1161	(escape codes) that will be interpreted.	1675	(escape codes) that will be interpreted.
1162		1676
1163	=item $term->tt_write ($octets)	1677	=item $term->tt_write ($octets)
1164		1678
1165	Write the octets given in C<$data> to the tty (i.e. as program input). To	1679	Write the octets given in C<$octets> to the tty (i.e. as user input
		1680	to the program, see C<cmd_parse> for the opposite direction). To pass
1166	pass characters instead of octets, you should convert your strings first	1681	characters instead of octets, you should convert your strings first to the
1167	to the locale-specific encoding using C<< $term->locale_encode >>.	1682	locale-specific encoding using C<< $term->locale_encode >>.
		1683
		1684	=item $term->tt_write_user_input ($octets)
		1685
		1686	Like C<tt_write>, but should be used when writing strings in response to
		1687	the user pressing a key, to invoke the additional actions requested by
		1688	the user for that case (C<tt_write> doesn't do that).
		1689
		1690	The typical use case would be inside C<on_action> hooks.
		1691
		1692	=item $term->tt_paste ($octets)
		1693
		1694	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1695	CR and bracketing the data with control sequences if bracketed paste mode
		1696	is set.
1168		1697
1169	=item $old_events = $term->pty_ev_events ([$new_events])	1698	=item $old_events = $term->pty_ev_events ([$new_events])
1170		1699
1171	Replaces the event mask of the pty watcher by the given event mask. Can	1700	Replaces the event mask of the pty watcher by the given event mask. Can
1172	be used to suppress input and output handling to the pty/tty. See the	1701	be used to suppress input and output handling to the pty/tty. See the
1173	description of C<< urxvt::timer->events >>. Make sure to always restore	1702	description of C<< urxvt::timer->events >>. Make sure to always restore
1174	the previous value.	1703	the previous value.
1175		1704
		1705	=item $fd = $term->pty_fd
		1706
		1707	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1708	is used.
		1709
1176	=item $windowid = $term->parent	1710	=item $windowid = $term->parent
1177		1711
1178	Return the window id of the toplevel window.	1712	Return the window id of the toplevel window.
1179		1713
1180	=item $windowid = $term->vt	1714	=item $windowid = $term->vt
…		…
1186	Adds the specified events to the vt event mask. Useful e.g. when you want	1720	Adds the specified events to the vt event mask. Useful e.g. when you want
1187	to receive pointer events all the times:	1721	to receive pointer events all the times:
1188		1722
1189	$term->vt_emask_add (urxvt::PointerMotionMask);	1723	$term->vt_emask_add (urxvt::PointerMotionMask);
1190		1724
		1725	=item $term->set_urgency ($set)
		1726
		1727	Enable/disable the urgency hint on the toplevel window.
		1728
		1729	=item $term->focus_in
		1730
		1731	=item $term->focus_out
		1732
		1733	=item $term->key_press ($state, $keycode[, $time])
		1734
		1735	=item $term->key_release ($state, $keycode[, $time])
		1736
		1737	Deliver various fake events to to terminal.
		1738
1191	=item $window_width = $term->width	1739	=item $window_width = $term->width ([$new_value])
1192		1740
1193	=item $window_height = $term->height	1741	=item $window_height = $term->height ([$new_value])
1194		1742
1195	=item $font_width = $term->fwidth	1743	=item $font_width = $term->fwidth ([$new_value])
1196		1744
1197	=item $font_height = $term->fheight	1745	=item $font_height = $term->fheight ([$new_value])
1198		1746
1199	=item $font_ascent = $term->fbase	1747	=item $font_ascent = $term->fbase ([$new_value])
1200		1748
1201	=item $terminal_rows = $term->nrow	1749	=item $terminal_rows = $term->nrow ([$new_value])
1202		1750
1203	=item $terminal_columns = $term->ncol	1751	=item $terminal_columns = $term->ncol ([$new_value])
1204		1752
1205	=item $has_focus = $term->focus	1753	=item $has_focus = $term->focus ([$new_value])
1206		1754
1207	=item $is_mapped = $term->mapped	1755	=item $is_mapped = $term->mapped ([$new_value])
1208		1756
1209	=item $max_scrollback = $term->saveLines	1757	=item $max_scrollback = $term->saveLines ([$new_value])
1210		1758
1211	=item $nrow_plus_saveLines = $term->total_rows	1759	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1212		1760
1213	=item $topmost_scrollback_row = $term->top_row	1761	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1214		1762
1215	Return various integers describing terminal characteristics.	1763	Return various integers describing terminal characteristics. If an
		1764	argument is given, changes the value and returns the previous one.
1216		1765
1217	=item $x_display = $term->display_id	1766	=item $x_display = $term->display_id
1218		1767
1219	Return the DISPLAY used by rxvt-unicode.	1768	Return the DISPLAY used by rxvt-unicode.
1220		1769
…		…
1225	=item $env = $term->env	1774	=item $env = $term->env
1226		1775
1227	Returns a copy of the environment in effect for the terminal as a hashref	1776	Returns a copy of the environment in effect for the terminal as a hashref
1228	similar to C<\%ENV>.	1777	similar to C<\%ENV>.
1229		1778
		1779	=item @envv = $term->envv
		1780
		1781	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1782
		1783	=item @argv = $term->argv
		1784
		1785	Return the argument vector as this terminal, similar to @ARGV, but
		1786	includes the program name as first element.
		1787
1230	=cut	1788	=cut
1231		1789
1232	sub env {	1790	sub env {
1233	if (my $env = $_[0]->_env) {
1234	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1791	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1235	} else {
1236	+{ %ENV }
1237	}
1238	}	1792	}
1239		1793
1240	=item $modifiermask = $term->ModLevel3Mask	1794	=item $modifiermask = $term->ModLevel3Mask
1241		1795
1242	=item $modifiermask = $term->ModMetaMask	1796	=item $modifiermask = $term->ModMetaMask
…		…
1244	=item $modifiermask = $term->ModNumLockMask	1798	=item $modifiermask = $term->ModNumLockMask
1245		1799
1246	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1800	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1247	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1801	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1248		1802
		1803	=item $screen = $term->current_screen
		1804
		1805	Returns the currently displayed screen (0 primary, 1 secondary).
		1806
		1807	=item $cursor_is_hidden = $term->hidden_cursor
		1808
		1809	Returns whether the cursor is currently hidden or not.
		1810
		1811	=item $priv_modes = $term->priv_modes
		1812
		1813	Returns a bitset with the state of DEC private modes.
		1814
		1815	Example:
		1816
		1817	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1818	# mouse reporting is turned on
		1819	}
		1820
1249	=item $view_start = $term->view_start ([$newvalue])	1821	=item $view_start = $term->view_start ([$newvalue])
1250		1822
1251	Returns the row number of the topmost displayed line. Maximum value is	1823	Returns the row number of the topmost displayed line and changes it,
1252	C<0>, which displays the normal terminal contents. Lower values scroll	1824	if an argument is given. Values greater than or equal to C<0> display
1253	this many lines into the scrollback buffer.	1825	the terminal contents. Lower values scroll this many lines into the
		1826	scrollback buffer.
1254		1827
1255	=item $term->want_refresh	1828	=item $term->want_refresh
1256		1829
1257	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1830	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1258	compare the on-screen display with its stored representation. If they	1831	compare the on-screen display with its stored representation. If they
1259	differ, it redraws the differences.	1832	differ, it redraws the differences.
1260		1833
1261	Used after changing terminal contents to display them.	1834	Used after changing terminal contents to display them.
1262		1835
		1836	=item $term->refresh_check
		1837
		1838	Checks if a refresh has been requested and, if so, schedules one.
		1839
1263	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1840	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1264		1841
1265	Returns the text of the entire row with number C<$row_number>. Row C<0>	1842	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1266	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1843	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1267	terminal line. The scrollback buffer starts at line C<-1> and extends to
1268	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1844	terminal line. Nothing will be returned if a nonexistent line
1269	is requested.	1845	is requested.
1270		1846
1271	If C<$new_text> is specified, it will replace characters in the current	1847	If C<$new_text> is specified, it will replace characters in the current
1272	line, starting at column C<$start_col> (default C<0>), which is useful	1848	line, starting at column C<$start_col> (default C<0>), which is useful
1273	to replace only parts of a line. The font index in the rendition will	1849	to replace only parts of a line. The font index in the rendition will
1274	automatically be updated.	1850	automatically be updated.
1275		1851
1276	C<$text> is in a special encoding: tabs and wide characters that use more	1852	C<$text> is in a special encoding: tabs and wide characters that use more
1277	than one cell when displayed are padded with urxvt::NOCHAR characters	1853	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1278	(C<chr 65535>). Characters with combining characters and other characters	1854	characters. Characters with combining characters and other characters that
1279	that do not fit into the normal tetx encoding will be replaced with	1855	do not fit into the normal text encoding will be replaced with characters
1280	characters in the private use area.	1856	in the private use area.
1281		1857
1282	You have to obey this encoding when changing text. The advantage is	1858	You have to obey this encoding when changing text. The advantage is
1283	that C<substr> and similar functions work on screen cells and not on	1859	that C<substr> and similar functions work on screen cells and not on
1284	characters.	1860	characters.
1285		1861
…		…
1313		1889
1314	Create and return a new C<urxvt::line> object that stores information	1890	Create and return a new C<urxvt::line> object that stores information
1315	about the logical line that row C<$row_number> is part of. It supports the	1891	about the logical line that row C<$row_number> is part of. It supports the
1316	following methods:	1892	following methods:
1317		1893
1318	=over 4	1894	=over
1319		1895
1320	=item $text = $line->t ([$new_text])	1896	=item $text = $line->t ([$new_text])
1321		1897
1322	Returns or replaces the full text of the line, similar to C<ROW_t>	1898	Returns or replaces the full text of the line, similar to C<ROW_t>
1323		1899
…		…
1369	}	1945	}
1370		1946
1371	sub urxvt::line::t {	1947	sub urxvt::line::t {
1372	my ($self) = @_;	1948	my ($self) = @_;
1373		1949
1374	if (@_ > 1)	1950	if (@_ > 1) {
1375	{
1376	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1951	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1377	for $self->{beg} .. $self->{end};	1952	for $self->{beg} .. $self->{end};
1378	}	1953	}
1379		1954
1380	defined wantarray &&	1955	defined wantarray &&
1381	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1956	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1382	0, $self->{len}	1957	0, $self->{len}
1383	}	1958	}
1384		1959
1385	sub urxvt::line::r {	1960	sub urxvt::line::r {
1386	my ($self) = @_;	1961	my ($self) = @_;
1387		1962
1388	if (@_ > 1)	1963	if (@_ > 1) {
1389	{
1390	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1964	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1391	for $self->{beg} .. $self->{end};	1965	for $self->{beg} .. $self->{end};
1392	}	1966	}
1393		1967
1394	if (defined wantarray) {	1968	if (defined wantarray) {
1395	my $rend = [	1969	my $rend = [
1396	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1970	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1397	];	1971	];
…		…
1429	where one character corresponds to one screen cell. See	2003	where one character corresponds to one screen cell. See
1430	C<< $term->ROW_t >> for details.	2004	C<< $term->ROW_t >> for details.
1431		2005
1432	=item $string = $term->special_decode $text	2006	=item $string = $term->special_decode $text
1433		2007
1434	Converts rxvt-unicodes text reprsentation into a perl string. See	2008	Converts rxvt-unicode's text representation into a perl string. See
1435	C<< $term->ROW_t >> for details.	2009	C<< $term->ROW_t >> for details.
1436		2010
1437	=item $success = $term->grab_button ($button, $modifiermask)	2011	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1438		2012
		2013	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2014
1439	Registers a synchronous button grab. See the XGrabButton manpage.	2015	Register/unregister a synchronous button grab. See the XGrabButton
		2016	manpage.
1440		2017
1441	=item $success = $term->grab ($eventtime[, $sync])	2018	=item $success = $term->grab ($eventtime[, $sync])
1442		2019
1443	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2020	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1444	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2021	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1445		2022
1446	=item $term->allow_events_async	2023	=item $term->allow_events_async
1447		2024
1448	Calls XAllowEvents with AsyncBoth for the most recent grab.	2025	Calls XAllowEvents with AsyncBoth for the most recent grab.
1449		2026
…		…
1456	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2033	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1457	recent grab.	2034	recent grab.
1458		2035
1459	=item $term->ungrab	2036	=item $term->ungrab
1460		2037
1461	Calls XUngrab for the most recent grab. Is called automatically on	2038	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1462	evaluation errors, as it is better to lose the grab in the error case as	2039	evaluation errors, as it is better to lose the grab in the error case as
1463	the session.	2040	the session.
1464		2041
		2042	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		2043
		2044	=item $atom_name = $term->XGetAtomName ($atom)
		2045
		2046	=item @atoms = $term->XListProperties ($window)
		2047
		2048	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		2049
		2050	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		2051
		2052	=item $term->XDeleteProperty ($window, $property)
		2053
		2054	=item $window = $term->DefaultRootWindow
		2055
		2056	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		2057
		2058	=item $term->XMapWindow ($window)
		2059
		2060	=item $term->XUnmapWindow ($window)
		2061
		2062	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		2063
		2064	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		2065
		2066	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2067
		2068	=item $keysym = $term->XStringToKeysym ($string)
		2069
		2070	=item $string = $term->XKeysymToString ($keysym)
		2071
		2072	Various X or X-related functions. The C<$term> object only serves as
		2073	the source of the display, otherwise those functions map more-or-less
		2074	directly onto the X functions of the same name.
		2075
1465	=back	2076	=back
1466		2077
1467	=cut	2078	=cut
1468		2079
1469	package urxvt::popup;	2080	package urxvt::popup;
1470		2081
1471	=head2 The C<urxvt::popup> Class	2082	=head2 The C<urxvt::popup> Class
1472		2083
1473	=over 4	2084	=over
1474		2085
1475	=cut	2086	=cut
1476		2087
1477	sub add_item {	2088	sub add_item {
1478	my ($self, $item) = @_;	2089	my ($self, $item) = @_;
…		…
1532	my ($self, $text, $cb) = @_;	2143	my ($self, $text, $cb) = @_;
1533		2144
1534	$self->add_item ({ type => "button", text => $text, activate => $cb});	2145	$self->add_item ({ type => "button", text => $text, activate => $cb});
1535	}	2146	}
1536		2147
1537	=item $popup->add_toggle ($text, $cb, $initial_value)	2148	=item $popup->add_toggle ($text, $initial_value, $cb)
1538		2149
1539	Adds a toggle/checkbox item to the popup. Teh callback gets called	2150	Adds a toggle/checkbox item to the popup. The callback gets called
1540	whenever it gets toggled, with a boolean indicating its value as its first	2151	whenever it gets toggled, with a boolean indicating its new value as its
1541	argument.	2152	first argument.
1542		2153
1543	=cut	2154	=cut
1544		2155
1545	sub add_toggle {	2156	sub add_toggle {
1546	my ($self, $text, $cb, $value) = @_;	2157	my ($self, $text, $value, $cb) = @_;
1547		2158
1548	my $item; $item = {	2159	my $item; $item = {
1549	type => "button",	2160	type => "button",
1550	text => " $text",	2161	text => " $text",
1551	value => $value,	2162	value => $value,
…		…
1570	my $env = $self->{term}->env;	2181	my $env = $self->{term}->env;
1571	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2182	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1572	delete $env->{LC_ALL};	2183	delete $env->{LC_ALL};
1573	$env->{LC_CTYPE} = $self->{term}->locale;	2184	$env->{LC_CTYPE} = $self->{term}->locale;
1574		2185
1575	urxvt::term->new ($env, $self->{term}->resource ("name"),	2186	my $term = urxvt::term->new (
1576	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2187	$env, "popup",
		2188	"--perl-lib" => "", "--perl-ext-common" => "",
		2189	"-pty-fd" => -1, "-sl" => 0,
		2190	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1577	"--transient-for" => $self->{term}->parent,	2191	"--transient-for" => $self->{term}->parent,
1578	"-display" => $self->{term}->display_id,	2192	"-display" => $self->{term}->display_id,
1579	"-pe" => "urxvt-popup")	2193	"-pe" => "urxvt-popup",
1580	or die "unable to create popup window\n";	2194	) or die "unable to create popup window\n";
		2195
		2196	unless (delete $term->{urxvt_popup_init_done}) {
		2197	$term->ungrab;
		2198	$term->destroy;
		2199	die "unable to initialise popup window\n";
		2200	}
1581	}	2201	}
1582		2202
1583	sub DESTROY {	2203	sub DESTROY {
1584	my ($self) = @_;	2204	my ($self) = @_;
1585		2205
1586	delete $self->{term}{_destroy}{$self};	2206	delete $self->{term}{_destroy}{$self};
1587	$self->{term}->ungrab;	2207	$self->{term}->ungrab;
1588	}	2208	}
1589		2209
1590	=back	2210	=back
		2211
		2212	=cut
		2213
		2214	package urxvt::watcher;
1591		2215
1592	=head2 The C<urxvt::timer> Class	2216	=head2 The C<urxvt::timer> Class
1593		2217
1594	This class implements timer watchers/events. Time is represented as a	2218	This class implements timer watchers/events. Time is represented as a
1595	fractional number of seconds since the epoch. Example:	2219	fractional number of seconds since the epoch. Example:
…		…
1599	->new	2223	->new
1600	->interval (1)	2224	->interval (1)
1601	->cb (sub {	2225	->cb (sub {
1602	$term->{overlay}->set (0, 0,	2226	$term->{overlay}->set (0, 0,
1603	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2227	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1604	});	2228	});
1605		2229
1606	=over 4	2230	=over
1607		2231
1608	=item $timer = new urxvt::timer	2232	=item $timer = new urxvt::timer
1609		2233
1610	Create a new timer object in started state. It is scheduled to fire	2234	Create a new timer object in started state. It is scheduled to fire
1611	immediately.	2235	immediately.
1612		2236
1613	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2237	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1614		2238
1615	Set the callback to be called when the timer triggers.	2239	Set the callback to be called when the timer triggers.
1616		2240
1617	=item $tstamp = $timer->at
1618
1619	Return the time this watcher will fire next.
1620
1621	=item $timer = $timer->set ($tstamp)	2241	=item $timer = $timer->set ($tstamp[, $interval])
1622		2242
1623	Set the time the event is generated to $tstamp.	2243	Set the time the event is generated to $tstamp (and optionally specifies a
		2244	new $interval).
1624		2245
1625	=item $timer = $timer->interval ($interval)	2246	=item $timer = $timer->interval ($interval)
1626		2247
1627	Normally (and when C<$interval> is C<0>), the timer will automatically	2248	By default (and when C<$interval> is C<0>), the timer will automatically
1628	stop after it has fired once. If C<$interval> is non-zero, then the timer	2249	stop after it has fired once. If C<$interval> is non-zero, then the timer
1629	is automatically rescheduled at the given intervals.	2250	is automatically rescheduled at the given intervals.
1630		2251
1631	=item $timer = $timer->start	2252	=item $timer = $timer->start
1632		2253
1633	Start the timer.	2254	Start the timer.
1634		2255
1635	=item $timer = $timer->start ($tstamp)	2256	=item $timer = $timer->start ($tstamp[, $interval])
1636		2257
1637	Set the event trigger time to C<$tstamp> and start the timer.	2258	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2259	also replaces the interval.
		2260
		2261	=item $timer = $timer->after ($delay[, $interval])
		2262
		2263	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1638		2264
1639	=item $timer = $timer->stop	2265	=item $timer = $timer->stop
1640		2266
1641	Stop the timer.	2267	Stop the timer.
1642		2268
…		…
1648		2274
1649	$term->{socket} = ...	2275	$term->{socket} = ...
1650	$term->{iow} = urxvt::iow	2276	$term->{iow} = urxvt::iow
1651	->new	2277	->new
1652	->fd (fileno $term->{socket})	2278	->fd (fileno $term->{socket})
1653	->events (urxvt::EVENT_READ)	2279	->events (urxvt::EV_READ)
1654	->start	2280	->start
1655	->cb (sub {	2281	->cb (sub {
1656	my ($iow, $revents) = @_;	2282	my ($iow, $revents) = @_;
1657	# $revents must be 1 here, no need to check	2283	# $revents must be 1 here, no need to check
1658	sysread $term->{socket}, my $buf, 8192	2284	sysread $term->{socket}, my $buf, 8192
1659	or end-of-file;	2285	or end-of-file;
1660	});	2286	});
1661		2287
1662		2288
1663	=over 4	2289	=over
1664		2290
1665	=item $iow = new urxvt::iow	2291	=item $iow = new urxvt::iow
1666		2292
1667	Create a new io watcher object in stopped state.	2293	Create a new io watcher object in stopped state.
1668		2294
…		…
1671	Set the callback to be called when io events are triggered. C<$reventmask>	2297	Set the callback to be called when io events are triggered. C<$reventmask>
1672	is a bitset as described in the C<events> method.	2298	is a bitset as described in the C<events> method.
1673		2299
1674	=item $iow = $iow->fd ($fd)	2300	=item $iow = $iow->fd ($fd)
1675		2301
1676	Set the filedescriptor (not handle) to watch.	2302	Set the file descriptor (not handle) to watch.
1677		2303
1678	=item $iow = $iow->events ($eventmask)	2304	=item $iow = $iow->events ($eventmask)
1679		2305
1680	Set the event mask to watch. The only allowed values are	2306	Set the event mask to watch. The only allowed values are
1681	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2307	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1682	together, or C<urxvt::EVENT_NONE>.	2308	together, or C<urxvt::EV_NONE>.
1683		2309
1684	=item $iow = $iow->start	2310	=item $iow = $iow->start
1685		2311
1686	Start watching for requested events on the given handle.	2312	Start watching for requested events on the given handle.
1687		2313
1688	=item $iow = $iow->stop	2314	=item $iow = $iow->stop
1689		2315
1690	Stop watching for events on the given filehandle.	2316	Stop watching for events on the given file handle.
		2317
		2318	=back
		2319
		2320	=head2 The C<urxvt::iw> Class
		2321
		2322	This class implements idle watchers, that get called automatically when
		2323	the process is idle. They should return as fast as possible, after doing
		2324	some useful work.
		2325
		2326	=over
		2327
		2328	=item $iw = new urxvt::iw
		2329
		2330	Create a new idle watcher object in stopped state.
		2331
		2332	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2333
		2334	Set the callback to be called when the watcher triggers.
		2335
		2336	=item $timer = $timer->start
		2337
		2338	Start the watcher.
		2339
		2340	=item $timer = $timer->stop
		2341
		2342	Stop the watcher.
		2343
		2344	=back
		2345
		2346	=head2 The C<urxvt::pw> Class
		2347
		2348	This class implements process watchers. They create an event whenever a
		2349	process exits, after which they stop automatically.
		2350
		2351	my $pid = fork;
		2352	...
		2353	$term->{pw} = urxvt::pw
		2354	->new
		2355	->start ($pid)
		2356	->cb (sub {
		2357	my ($pw, $exit_status) = @_;
		2358	...
		2359	});
		2360
		2361	=over
		2362
		2363	=item $pw = new urxvt::pw
		2364
		2365	Create a new process watcher in stopped state.
		2366
		2367	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2368
		2369	Set the callback to be called when the timer triggers.
		2370
		2371	=item $pw = $timer->start ($pid)
		2372
		2373	Tells the watcher to start watching for process C<$pid>.
		2374
		2375	=item $pw = $pw->stop
		2376
		2377	Stop the watcher.
1691		2378
1692	=back	2379	=back
1693		2380
1694	=head1 ENVIRONMENT	2381	=head1 ENVIRONMENT
1695		2382
1696	=head2 URXVT_PERL_VERBOSITY	2383	=head2 URXVT_PERL_VERBOSITY
1697		2384
1698	This variable controls the verbosity level of the perl extension. Higher	2385	This variable controls the verbosity level of the perl extension. Higher
1699	numbers indicate more verbose output.	2386	numbers indicate more verbose output.
1700		2387
1701	=over 4	2388	=over
1702		2389
1703	=item == 0 - fatal messages	2390	=item == 0 - fatal messages only
		2391
		2392	=item >= 2 - general warnings (default level)
1704		2393
1705	=item >= 3 - script loading and management	2394	=item >= 3 - script loading and management
1706		2395
1707	=item >=10 - all called hooks	2396	=item >=10 - all called hooks
1708		2397
1709	=item >=11 - hook reutrn values	2398	=item >=11 - hook return values
1710		2399
1711	=back	2400	=back
1712		2401
1713	=head1 AUTHOR	2402	=head1 AUTHOR
1714		2403
1715	Marc Lehmann <pcg@goof.com>	2404	Marc Lehmann <schmorp@schmorp.de>
1716	http://software.schmorp.de/pkg/rxvt-unicode	2405	http://software.schmorp.de/pkg/rxvt-unicode
1717		2406
1718	=cut	2407	=cut
1719		2408
1720	1	2409	1
		2410
		2411	# vim: sw=3:

Diff Legend

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