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

Diff Legend

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