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.145 by root, Thu Aug 10 22:53:20 2006 UTC vs.
Revision 1.270 by root, Fri Nov 26 18:49:47 2021 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in some directory:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt instance using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib path/to/somedirectory -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Every time 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	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions may add additional resources and C<actions>, i.e., methods
45		49	which can be bound to a key and invoked by the user. An extension can
46	=item selection (enabled by default)	50	define the resources it support using so called META comments,
47		51	described below. Similarly to builtin resources, extension resources
48	(More) intelligent selection. This extension tries to be more intelligent	52	can also be specified on the command line as long options (with C<.>
49	when the user extends selections (double-click and further clicks). Right	53	replaced by C<->), in which case the corresponding extension is loaded
50	now, it tries to select words, urls and complete shell-quoted	54	automatically. For this to work the extension B<must> define META
51	arguments, which is very convenient, too, if your F<ls> supports	55	comments for its resources.
52	C<--quoting-style=shell>.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72	Another example: Programs I use often output "absolute path: " at the
73	beginning of a line when they process multiple files. The following
74	pattern matches the filename (note, there is a single space at the very
75	end):
76
77	URxvt.selection.pattern-0: ^(/[^:]+):\
78
79	You can look at the source of the selection extension to see more
80	interesting uses, such as parsing a line from beginning to end.
81
82	This extension also offers following bindable keyboard commands:
83
84	=over 4
85
86	=item rot13
87
88	Rot-13 the selection when activated. Used via keyboard trigger:
89
90	URxvt.keysym.C-M-r: perl:selection:rot13
91
92	=back
93
94	=item option-popup (enabled by default)
95
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.
98
99	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.
102
103	It's sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as
107	first argument.
108
109	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:
111
112	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};
115
116	=item selection-popup (enabled by default)
117
118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119	text into various other formats/action (such as uri unescaping, perl
120	evaluation, web-browser starting etc.), depending on content.
121
122	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.
125
126	It's sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide whether to add something or not.
128	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.
131
132	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:
135
136	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }
138	: ()
139	};
140
141	=item searchable-scrollback<hotkey> (enabled by default)
142
143	Adds regex search functionality to the scrollback buffer, triggered
144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
145	input/output is suspended and a regex is displayed at the bottom of the
146	screen.
147
148	Inputting characters appends them to the regex and continues incremental
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary
154	selection.
155
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.
159
160	See L<perlre> for more info about perl regular expression syntax.
161
162	=item readline (enabled by default)
163
164	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to
166	move the text cursor to this position. It does so by generating as many
167	cursor-left or cursor-right keypresses as required (the this only works
168	for programs that correctly support wide characters).
169
170	To avoid too many false positives, this is only done when:
171
172	=over 4
173
174	=item - the tty is in ICANON state.
175
176	=item - the text cursor is visible.
177
178	=item - the primary screen is currently being displayed.
179
180	=item - the mouse is on the same (multi-row-) line as the text cursor.
181
182	=back
183
184	The normal selection mechanism isn't disabled, so quick successive clicks
185	might interfere with selection creation in harmless ways.
186
187	=item selection-autotransform
188
189	This selection allows you to do automatic transforms on a selection
190	whenever a selection is made.
191
192	It works by specifying perl snippets (most useful is a single C<s///>
193	operator) that modify C<$_> as resources:
194
195	URxvt.selection-autotransform.0: transform
196	URxvt.selection-autotransform.1: transform
197	...
198
199	For example, the following will transform selections of the form
200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
201	$word>:
202
203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
204
205	And this example matches the same,but replaces it with vi-commands you can
206	paste directly into your (vi :) editor:
207
208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
209
210	Of course, this can be modified to suit your needs and your editor :)
211
212	To expand the example above to typical perl error messages ("XXX at
213	FILENAME line YYY."), you need a slightly more elaborate solution:
214
215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
217
218	The first line tells the selection code to treat the unchanging part of
219	every error message as a selection pattern, and the second line transforms
220	the message into vi commands to load the file.
221
222	=item tabbed
223
224	This transforms the terminal into a tabbar with additional terminals, that
225	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227	button per tab.
228
229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
230	B<Shift-Right> will switch to the tab left or right of the current one,
231	while B<Shift-Down> creates a new tab.
232
233	The tabbar itself can be configured similarly to a normal terminal, but
234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
235	following four resources (shown with defaults):
236
237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239	URxvt.tabbed.tab-fg: <colour-index, default 0>
240	URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243	indices.
244
245	=item mark-urls
246
247	Uses per-line display filtering (C<on_line_update>) to underline urls and
248	make them clickable. When middle-clicked, the program specified in the
249	resource C<urlLauncher> (default C<x-www-browser>) will be started with
250	the URL as first argument.
251
252	=item xim-onthespot
253
254	This (experimental) perl extension implements OnTheSpot editing. It does
255	not work perfectly, and some input methods don't seem to work well with
256	OnTheSpot editing in general, but it seems to work at leats for SCIM and
257	kinput2.
258
259	You enable it by specifying this extension and a preedit style of
260	C<OnTheSpot>, i.e.:
261
262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263
264	=item kuake<hotkey>
265
266	A very primitive quake-console-like extension. It was inspired by a
267	description of how the programs C<kuake> and C<yakuake> work: Whenever the
268	user presses a global accelerator key (by default C<F10>), the terminal
269	will show or hide itself. Another press of the accelerator key will hide
270	or show it again.
271
272	Initially, the window will not be shown when using this extension.
273
274	This is useful if you need a single terminal thats not using any desktop
275	space most of the time but is quickly available at the press of a key.
276
277	The accelerator key is grabbed regardless of any modifiers, so this
278	extension will actually grab a physical key just for this function.
279
280	If you want a quake-like animation, tell your window manager to do so
281	(fvwm can do it).
282
283	=item automove-background
284
285	This is basically a very small extension that dynamically changes the
286	background pixmap offset to the window position, in effect creating the
287	same effect as pseudo transparency with a custom pixmap. No scaling is
288	supported in this mode. Example:
289
290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291
292	=item block-graphics-to-ascii
293
294	A not very useful example of filtering all text output to the terminal
295	by replacing all line-drawing characters (U+2500 .. U+259F) by a
296	similar-looking ascii character.
297
298	=item digital-clock
299
300	Displays a digital clock using the built-in overlay.
301
302	=item remote-clipboard
303
304	Somewhat of a misnomer, this extension adds two menu entries to the
305	selection popup that allows one ti run external commands to store the
306	selection somewhere and fetch it again.
307
308	We use it to implement a "distributed selection mechanism", which just
309	means that one command uploads the file to a remote server, and another
310	reads it.
311
312	The commands can be set using the C<URxvt.remote-selection.store> and
313	C<URxvt.remote-selection.fetch> resources. The first should read the
314	selection to store from STDIN (always in UTF-8), the second should provide
315	the selection data on STDOUT (also in UTF-8).
316
317	The defaults (which are likely useless to you) use rsh and cat:
318
319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321
322	=item selection-pastebin
323
324	This is a little rarely useful extension that Uploads the selection as
325	textfile to a remote site (or does other things). (The implementation is
326	not currently secure for use in a multiuser environment as it writes to
327	F</tmp> directly.).
328
329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
330	i.e.
331
332	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
333
334	Pressing this combination runs a command with C<%> replaced by the name of
335	the textfile. This command can be set via a resource:
336
337	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
338
339	And the default is likely not useful to anybody but the few people around
340	here :)
341
342	The name of the textfile is the hex encoded md5 sum of the selection, so
343	the same content should lead to the same filename.
344
345	After a successful upload the selection will be replaced by the text given
346	in the C<selection-pastebin-url> resource (again, the % is the placeholder
347	for the filename):
348
349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350
351	=item example-refresh-hooks
352
353	Displays a very simple digital clock in the upper right corner of the
354	window. Illustrates overwriting the refresh callbacks to create your own
355	overlays or changes.
356
357	=back
358		56
359	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
360		58
361	=head2 General API Considerations	59	=head2 General API Considerations
362		60
…		…
372	terminal is destroyed.	70	terminal is destroyed.
373		71
374	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
375	hints on what they mean:	73	hints on what they mean:
376		74
377	=over 4	75	=over
378		76
379	=item $text	77	=item $text
380		78
381	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
382	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.
383		81
384	=item $string	82	=item $string
385		83
386	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
…		…
390	=item $octets	88	=item $octets
391		89
392	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
393	locale-specific way.	91	locale-specific way.
394		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
395	=back	99	=back
396		100
397	=head2 Extension Objects	101	=head2 Extension Objects
398		102
399	Every 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
400	for each terminal, and each terminal has its own set of extenion objects,	104	for each terminal, and each terminal has its own set of extension objects,
401	which are passed as the first parameter to hooks. So extensions can use	105	which are passed as the first parameter to hooks. So extensions can use
402	their C<$self> object without having to think about clashes with other	106	their C<$self> object without having to think about clashes with other
403	extensions or other terminals, with the exception of methods and members	107	extensions or other terminals, with the exception of methods and members
404	that begin with an underscore character C<_>: these are reserved for	108	that begin with an underscore character C<_>: these are reserved for
405	internal use.	109	internal use.
406		110
407	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
408	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
409		113
410	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.
411		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
412	=over 4	128	=over
413		129
414	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
415		131
416	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
417	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.
418		135
419	=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.
420		138
421	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
422	this extension, replacing any previous hook. This is useful when you want	140	comment:
423	to overwrite time-critical hooks only temporarily.
424		141
425	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
426		143
427	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
428		183
429	=back	184	=back
430		185
431	=head2 Hooks	186	=head2 Hooks
432		187
…		…
440	hooks returns true, then the event counts as being I<consumed>, and the	195	hooks returns true, then the event counts as being I<consumed>, and the
441	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
442		197
443	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
444		199
445	=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.
446		213
447	=item on_init $term	214	=item on_init $term
448		215
449	Called after a new terminal object has been initialized, but before	216	Called after a new terminal object has been initialized, but before
450	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
…		…
520		287
521	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,
522	$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
523	number of lines that will be in the scrollback buffer.	290	number of lines that will be in the scrollback buffer.
524		291
525	=item on_osc_seq $term, $op, $args	292	=item on_osc_seq $term, $op, $args, $resp
526		293
527	Called on every OSC sequence and can be used to suppress it or modify its	294	Called on every OSC sequence and can be used to suppress it or modify its
528	behaviour. The default should be to return an empty list. A true value	295	behaviour. The default should be to return an empty list. A true value
529	suppresses execution of the request completely. Make sure you don't get	296	suppresses execution of the request completely. Make sure you don't get
530	confused by recursive invocations when you output an osc sequence within	297	confused by recursive invocations when you output an OSC sequence within
531	this callback.	298	this callback.
532		299
533	C<on_osc_seq_perl> should be used for new behaviour.	300	C<on_osc_seq_perl> should be used for new behaviour.
534		301
535	=item on_osc_seq_perl $term, $string	302	=item on_osc_seq_perl $term, $args, $resp
536		303
537	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	304	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
538	operating system command) is processed. Cursor position and other state	305	(OSC = operating system command) is processed. Cursor position and other
539	information is up-to-date when this happens. For interoperability, the	306	state information is up-to-date when this happens. For interoperability,
540	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
541	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
542	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	}
543		320
544	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,
545	as its source can not easily be controlled (e-mail content, messages from	322	as its source can not easily be controlled (e-mail content, messages from
546	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.
547		327
548	=item on_add_lines $term, $string	328	=item on_add_lines $term, $string
549		329
550	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
551	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
…		…
556	=item on_tt_write $term, $octets	336	=item on_tt_write $term, $octets
557		337
558	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
559	suppress or filter tty input.	339	suppress or filter tty input.
560		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
561	=item on_line_update $term, $row	348	=item on_line_update $term, $row
562		349
563	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
564	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
565	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,
…		…
572	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
573	you cannot just toggle rendition bits, but only set them.	360	you cannot just toggle rendition bits, but only set them.
574		361
575	=item on_refresh_begin $term	362	=item on_refresh_begin $term
576		363
577	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
578	or similar effects by modify terminal contents in refresh_begin, and	365	similar effects by modifying the terminal contents in refresh_begin, and
579	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
580	code is run after this hook, and takes precedence.	367	code is run after this hook, and takes precedence.
581		368
582	=item on_refresh_end $term	369	=item on_refresh_end $term
583		370
584	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>.
585		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
586	=item on_user_command $term, $string	381	=item on_user_command $term, $string *DEPRECATED*
587		382
588	Called whenever a user-configured event is being activated (e.g. via	383	Called whenever a user-configured event is being activated (e.g. via
589	a C<perl:string> action bound to a key, see description of the B<keysym>	384	a C<perl:string> action bound to a key, see description of the B<keysym>
590	resource in the @@RXVT_NAME@@(1) manpage).	385	resource in the urxvt(1) manpage).
591		386
592	The event is simply the action string. This interface is assumed to change	387	The event is simply the action string. This interface is going away in
593	slightly in the future.	388	preference to the C<on_action> hook.
594		389
595	=item on_resize_all_windows $tern, $new_width, $new_height	390	=item on_resize_all_windows $term, $new_width, $new_height
596		391
597	Called just after the new window size has been calculated, but before	392	Called just after the new window size has been calculated, but before
598	windows are actually being resized or hints are being set. If this hook	393	windows are actually being resized or hints are being set. If this hook
599	returns TRUE, setting of the window hints is being skipped.	394	returns a true value, setting of the window hints is being skipped.
600		395
601	=item on_x_event $term, $event	396	=item on_x_event $term, $event
602		397
603	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
604	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
…		…
634		429
635	=item on_map_notify $term, $event	430	=item on_map_notify $term, $event
636		431
637	=item on_unmap_notify $term, $event	432	=item on_unmap_notify $term, $event
638		433
639	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
640	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.
641		436
642	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
643	manpage), with the additional members C<row> and C<col>, which are the	438	manpage), with the additional members C<row> and C<col>, which are the
644	(real, not screen-based) row and column under the mouse cursor.	439	(real, not screen-based) row and column under the mouse cursor.
645		440
646	C<on_key_press> additionally receives the string rxvt-unicode would	441	C<on_key_press> additionally receives the string rxvt-unicode would
647	output, if any, in locale-specific encoding.	442	output, if any, in locale-specific encoding.
648		443
649	subwindow.
650
651	=item on_client_message $term, $event	444	=item on_client_message $term, $event
652		445
653	=item on_wm_protocols $term, $event	446	=item on_wm_protocols $term, $event
654		447
655	=item on_wm_delete_window $term, $event	448	=item on_wm_delete_window $term, $event
656		449
657	Called when various types of ClientMessage events are received (all with	450	Called when various types of ClientMessage events are received (all with
658	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	451	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
659		452
		453	=item on_bell $term
		454
		455	Called on receipt of a bell character.
		456
660	=back	457	=back
661		458
662	=cut	459	=cut
663		460
664	package urxvt;	461	package urxvt;
665		462
666	use utf8;	463	use utf8;
667	use strict;	464	use strict qw(vars subs);
668	use Carp ();	465	use Carp ();
669	use Scalar::Util ();	466	use Scalar::Util ();
670	use List::Util ();	467	use List::Util ();
671		468
672	our $VERSION = 1;	469	our $VERSION = 1;
673	our $TERM;	470	our $TERM;
674	our @TERM_INIT;	471	our @TERM_INIT; # should go, prevents async I/O etc.
675	our @TERM_EXT;	472	our @TERM_EXT; # should go, prevents async I/O etc.
676	our @HOOKNAME;	473	our @HOOKNAME;
677	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	474	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
678	our %OPTION;	475	our %OPTION;
679		476
680	our $LIBDIR;	477	our $LIBDIR;
…		…
684		481
685	our $NOCHAR = chr 0xffff;	482	our $NOCHAR = chr 0xffff;
686		483
687	=head2 Variables in the C<urxvt> Package	484	=head2 Variables in the C<urxvt> Package
688		485
689	=over 4	486	=over
690		487
691	=item $urxvt::LIBDIR	488	=item $urxvt::LIBDIR
692		489
693	The rxvt-unicode library directory, where, among other things, the perl	490	The rxvt-unicode library directory, where, among other things, the perl
694	modules and scripts are stored.	491	modules and scripts are stored.
…		…
724		521
725	=back	522	=back
726		523
727	=head2 Functions in the C<urxvt> Package	524	=head2 Functions in the C<urxvt> Package
728		525
729	=over 4	526	=over
730		527
731	=item urxvt::fatal $errormessage	528	=item urxvt::fatal $errormessage
732		529
733	Fatally aborts execution with the given error message. Avoid at all	530	Fatally aborts execution with the given error message (which should
734	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
735	starts up.	532	is acceptable (and useful) is in the init hook, where it prevents the
		533	terminal from starting up.
736		534
737	=item urxvt::warn $string	535	=item urxvt::warn $string
738		536
739	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
740	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
741	that calls this function.	539	that calls this function.
742		540
743	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
744	correct place, e.g. on stderr of the connecting urxvtc client.	542	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
748	=item @terms = urxvt::termlist	546	=item @terms = urxvt::termlist
749		547
750	Returns all urxvt::term objects that exist in this process, regardless of	548	Returns all urxvt::term objects that exist in this process, regardless of
751	whether they are started, being destroyed etc., so be careful. Only term	549	whether they are started, being destroyed etc., so be careful. Only term
752	objects that have perl extensions attached will be returned (because there	550	objects that have perl extensions attached will be returned (because there
753	is no urxvt::term objet associated with others).	551	is no urxvt::term object associated with others).
754		552
755	=item $time = urxvt::NOW	553	=item $time = urxvt::NOW
756		554
757	Returns the "current time" (as per the event loop).	555	Returns the "current time" (as per the event loop).
758		556
…		…
778	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	576	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
779	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	577	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
780		578
781	Various constants for use in X calls and event processing.	579	Various constants for use in X calls and event processing.
782		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
783	=back	593	=back
784		594
785	=head2 RENDITION	595	=head2 RENDITION
786		596
787	Rendition bitsets contain information about colour, font, font styles and	597	Rendition bitsets contain information about colour, font, font styles and
…		…
790	The following "macros" deal with changes in rendition sets. You should	600	The following "macros" deal with changes in rendition sets. You should
791	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,
792	as they contain important information required for correct operation of	602	as they contain important information required for correct operation of
793	rxvt-unicode.	603	rxvt-unicode.
794		604
795	=over 4	605	=over
796		606
797	=item $rend = urxvt::DEFAULT_RSTYLE	607	=item $rend = urxvt::DEFAULT_RSTYLE
798		608
799	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
800	being reset. Useful as a base to start when creating renditions.	610	being reset. Useful as a base to start when creating renditions.
801		611
802	=item $rend = urxvt::OVERLAY_RSTYLE	612	=item $rend = urxvt::OVERLAY_RSTYLE
803		613
804	Return the rendition mask used for overlays by default.	614	Return the rendition mask used for overlays by default.
805		615
806	=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
807		618
808	Return the bit that enabled bold, italic, blink, reverse-video and	619	Return the bit that enabled bold, italic, blink, reverse-video and
809	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
810	the bitset.	621	the bitset.
811		622
…		…
848	};	659	};
849	}	660	}
850		661
851	no warnings 'utf8';	662	no warnings 'utf8';
852		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
853	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	730	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
854		731
855	sub verbose {	732	sub verbose {
856	my ($level, $msg) = @_;	733	my ($level, $msg) = @_;
857	warn "$msg\n" if $level <= $verbosity;	734	warn "$msg\n" if $level <= $verbosity;
858	}	735	}
…		…
869	$pkg =~ s/[^[:word:]]/_/g;	746	$pkg =~ s/[^[:word:]]/_/g;
870	$pkg = "urxvt::ext::$pkg";	747	$pkg = "urxvt::ext::$pkg";
871		748
872	verbose 3, "loading extension '$path' into package '$pkg'";	749	verbose 3, "loading extension '$path' into package '$pkg'";
873		750
		751	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		752
874	open my $fh, "<:raw", $path	753	open my $fh, "<:raw", $path
875	or die "$path: $!";	754	or die "$path: $!";
876		755
877	my $source =	756	my $source =
878	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	757	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
879	. "#line 1 \"$path\"\n{\n"	758	. "#line 1 \"$path\"\n{\n"
880	. (do { local $/; <$fh> })	759	. (do { local $/; <$fh> })
881	. "\n};\n1";	760	. "\n};\n1";
882		761
883	eval $source	762	eval $source
…		…
892	# called by the rxvt core	771	# called by the rxvt core
893	sub invoke {	772	sub invoke {
894	local $TERM = shift;	773	local $TERM = shift;
895	my $htype = shift;	774	my $htype = shift;
896		775
897	if ($htype == 0) { # INIT	776	if ($htype == HOOK_INIT) {
898	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	777	$TERM->scan_extensions;
899		778
900	my %ext_arg;	779	my %ext_arg;
901		780
902	{	781	{
903	my @init = @TERM_INIT;	782	my @init = @TERM_INIT;
904	@TERM_INIT = ();	783	@TERM_INIT = ();
…		…
906	my @pkg = @TERM_EXT;	785	my @pkg = @TERM_EXT;
907	@TERM_EXT = ();	786	@TERM_EXT = ();
908	$TERM->register_package ($_) for @pkg;	787	$TERM->register_package ($_) for @pkg;
909	}	788	}
910		789
		790	for (
		791	@{ delete $TERM->{perl_ext_3} },
911	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	792	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		793	) {
912	if ($_ eq "default") {	794	if ($_ eq "default") {
		795
		796	$ext_arg{$_} = []
913	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	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
914	} elsif (/^-(.*)$/) {	808	} elsif (/^-(.*)$/) { # remove from set
915	delete $ext_arg{$1};	809	delete $ext_arg{$1};
916	} 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};
917	push @{ $ext_arg{$1} }, $2;	816	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		817
918	} else {	818	} else {
919	$ext_arg{$_} ||= [];	819	verbose 2, "cannot parse extension specification '$_', ignoring.";
920	}	820	}
921	}	821	}
922		822
		823	$TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
		824	$TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
		825
923	for my $ext (sort keys %ext_arg) {	826	for my $ext (sort keys %ext_arg) {
924	my @files = grep -f $_, map "$_/$ext", @dirs;	827	my $path = $TERM->extension_path ($ext);
925		828
926	if (@files) {	829	if (defined $path) {
927	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});	830	$TERM->autoload_extension ($ext, $ext_arg{$ext});
928	} else {	831	} else {
929	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";
930	}	833	}
931	}	834	}
932		835
933	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");
934	warn $@ if $@;	837	warn $@ if $@;
935	}	838	}
936		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
937	$retval = undef;	850	$retval = undef;
938		851
939	if (my $cb = $TERM->{_hook}[$htype]) {	852	if (my $cb = $TERM->{_hook}[$htype]) {
940	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	853	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
941	if $verbosity >= 10;	854	if $verbosity >= 10;
942		855
		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";
		862
		863	$cb = $cb->{$pkg}
		864	or return undef; #TODO: maybe warn user?
		865
		866	$cb = { $pkg => $cb };
		867	}
		868
943	for my $pkg (keys %$cb) {	869	for my $pkg (keys %$cb) {
944	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	870	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
945	$retval ||= $retval_;	871	$retval ||= $retval_;
946		872
947	if ($@) {	873	if ($@) {
948	$TERM->ungrab; # better to lose the grab than the session	874	$TERM->ungrab; # better to lose the grab than the session
949	warn $@;	875	warn $@;
…		…
952		878
953	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	879	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
954	if $verbosity >= 11;	880	if $verbosity >= 11;
955	}	881	}
956		882
957	if ($htype == 1) { # DESTROY	883	if ($htype == HOOK_DESTROY) {
958	# clear package objects	884	# clear package objects
959	%$_ = () for values %{ $TERM->{_pkg} };	885	%$_ = () for values %{ $TERM->{_pkg} };
960		886
961	# clear package	887	# clear package
962	%$TERM = ();	888	%$TERM = ();
…		…
967		893
968	sub SET_COLOR($$$) {	894	sub SET_COLOR($$$) {
969	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	895	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
970	}	896	}
971		897
972	# 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	}
973		922
974	package urxvt::term::extension;	923	package urxvt::term::extension;
975		924
976	sub enable {	925	=head2 The C<urxvt::term::extension> class
977	my ($self, %hook) = @_;
978	my $pkg = $self->{_pkg};
979		926
980	while (my ($name, $cb) = each %hook) {	927	Each extension attached to a terminal object is represented by
981	my $htype = $HOOKTYPE{uc $name};	928	a C<urxvt::term::extension> object.
982	defined $htype
983	or Carp::croak "unsupported hook type '$name'";
984		929
985	$self->set_should_invoke ($htype, +1)	930	You can use these objects, which are passed to all callbacks to store any
986	unless exists $self->{term}{_hook}[$htype]{$pkg};	931	state related to the terminal and extension instance.
987		932
988	$self->{term}{_hook}[$htype]{$pkg} = $cb;	933	The methods (And data members) documented below can be called on extension
989	}	934	objects, in addition to call methods documented for the <urxvt::term>
990	}	935	class.
991		936
992	sub disable {	937	=over
993	my ($self, @hook) = @_;
994	my $pkg = $self->{_pkg};
995		938
996	for my $name (@hook) {	939	=item $urxvt_term = $self->{term}
997	my $htype = $HOOKTYPE{uc $name};
998	defined $htype
999	or Carp::croak "unsupported hook type '$name'";
1000		940
1001	$self->set_should_invoke ($htype, -1)	941	Returns the C<urxvt::term> object associated with this instance of the
1002	if delete $self->{term}{_hook}[$htype]{$pkg};	942	extension. This member I<must not> be changed in any way.
1003	}	943
1004	}	944	=cut
1005		945
1006	our $AUTOLOAD;	946	our $AUTOLOAD;
1007		947
1008	sub AUTOLOAD {	948	sub AUTOLOAD {
1009	$AUTOLOAD =~ /:([^:]+)$/	949	$AUTOLOAD =~ /:([^:]+)$/
…		…
1022		962
1023	sub DESTROY {	963	sub DESTROY {
1024	# nop	964	# nop
1025	}	965	}
1026		966
1027	# urxvt::destroy_hook	967	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1028		968
1029	sub urxvt::destroy_hook::DESTROY {	969	sub urxvt::destroy_hook::DESTROY {
1030	${$_[0]}->();	970	${$_[0]}->();
1031	}	971	}
1032		972
1033	sub urxvt::destroy_hook(&) {	973	sub urxvt::destroy_hook(&) {
1034	bless \shift, urxvt::destroy_hook::	974	bless \shift, urxvt::destroy_hook::
1035	}	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
1036		1099
1037	package urxvt::anyevent;	1100	package urxvt::anyevent;
1038		1101
1039	=head2 The C<urxvt::anyevent> Class	1102	=head2 The C<urxvt::anyevent> Class
1040		1103
1041	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
1042	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
1043	further programming. The only exception is that you cannot wait on	1106	further programming. The only exception is that you cannot wait on
1044	condition variables, but non-blocking condvar use is ok. What this means	1107	condition variables, but non-blocking condvar use is ok.
1045	is that you cannot use blocking APIs, but the non-blocking variant should
1046	work.
1047		1108
1048	=cut	1109	In practical terms this means is that you cannot use blocking APIs, but
		1110	the non-blocking variant should work.
1049		1111
		1112	=cut
		1113
1050	our $VERSION = 1;	1114	our $VERSION = '5.23';
1051		1115
1052	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1116	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1053	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1117	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1054		1118
1055	sub timer {	1119	sub timer {
…		…
1057		1121
1058	my $cb = $arg{cb};	1122	my $cb = $arg{cb};
1059		1123
1060	urxvt::timer	1124	urxvt::timer
1061	->new	1125	->new
1062	->start (urxvt::NOW + $arg{after})	1126	->after ($arg{after}, $arg{interval})
1063	->cb (sub {	1127	->cb ($arg{interval} ? $cb : sub {
1064	$_[0]->stop; # need to cancel manually	1128	$_[0]->stop; # need to cancel manually
1065	$cb->();	1129	$cb->();
1066	})	1130	})
1067	}	1131	}
1068		1132
1069	sub io {	1133	sub io {
1070	my ($class, %arg) = @_;	1134	my ($class, %arg) = @_;
1071		1135
1072	my $cb = $arg{cb};	1136	my $cb = $arg{cb};
		1137	my $fd = fileno $arg{fh};
		1138	defined $fd or $fd = $arg{fh};
1073		1139
1074	bless [$arg{fh}, urxvt::iow	1140	bless [$arg{fh}, urxvt::iow
1075	->new	1141	->new
1076	->fd (fileno $arg{fh})	1142	->fd ($fd)
1077	->events (($arg{poll} =~ /r/ ? 1 : 0)	1143	->events (($arg{poll} =~ /r/ ? 1 : 0)
1078	| ($arg{poll} =~ /w/ ? 2 : 0))	1144	| ($arg{poll} =~ /w/ ? 2 : 0))
1079	->start	1145	->start
1080	->cb (sub {	1146	->cb ($cb)
1081	$cb->(($_[1] & 1 ? 'r' : '')
1082	. ($_[1] & 2 ? 'w' : ''));
1083	})],
1084	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	})
1085	}	1173	}
1086		1174
1087	sub DESTROY {	1175	sub DESTROY {
1088	$_[0][1]->stop;	1176	$_[0][1]->stop;
1089	}	1177	}
1090		1178
1091	sub condvar {	1179	# only needed for AnyEvent < 6 compatibility
1092	bless \my $flag, urxvt::anyevent::condvar::	1180	sub one_event {
1093	}
1094
1095	sub urxvt::anyevent::condvar::broadcast {
1096	${$_[0]}++;
1097	}
1098
1099	sub urxvt::anyevent::condvar::wait {
1100	unless (${$_[0]}) {
1101	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";
1102	}
1103	}	1182	}
1104		1183
1105	package urxvt::term;	1184	package urxvt::term;
1106		1185
1107	=head2 The C<urxvt::term> Class	1186	=head2 The C<urxvt::term> Class
1108		1187
1109	=over 4	1188	=over
1110		1189
1111	=cut	1190	=cut
1112		1191
1113	# find on_xxx subs in the package and register them	1192	# find on_xxx subs in the package and register them
1114	# as hooks	1193	# as hooks
1115	sub register_package {	1194	sub register_package {
1116	my ($self, $pkg, $argv) = @_;	1195	my ($self, $pkg, $argv) = @_;
1117		1196
		1197	return if $self->{_pkg}{$pkg};
		1198
1118	no strict 'refs';	1199	no strict 'refs';
1119		1200
1120	urxvt::verbose 6, "register package $pkg to $self";	1201	urxvt::verbose 6, "register package $pkg to $self";
1121		1202
1122	@{"$pkg\::ISA"} = urxvt::term::extension::;	1203	@{"$pkg\::ISA"} = urxvt::term::extension::;
1123		1204
1124	my $proxy = bless {	1205	my $proxy = bless {
1125	_pkg => $pkg,	1206	_pkg => $pkg,
		1207	_name => ${"$pkg\::_NAME"}, # hackish
1126	argv => $argv,	1208	argv => $argv,
1127	}, $pkg;	1209	}, $pkg;
1128	Scalar::Util::weaken ($proxy->{term} = $self);	1210	Scalar::Util::weaken ($proxy->{term} = $self);
1129		1211
1130	$self->{_pkg}{$pkg} = $proxy;	1212	$self->{_pkg}{$pkg} = $proxy;
1131		1213
1132	for my $name (@HOOKNAME) {	1214	for my $name (@HOOKNAME) {
1133	if (my $ref = $pkg->can ("on_" . lc $name)) {	1215	if (my $ref = $pkg->can ("on_" . lc $name)) {
1134	$proxy->enable ($name => $ref);	1216	$proxy->enable ($name => $ref);
1135	}	1217	}
1136	}	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	}
1137	}	1331	}
1138		1332
1139	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1333	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1140		1334
1141	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
…		…
1160	}	1354	}
1161		1355
1162	=item $term->destroy	1356	=item $term->destroy
1163		1357
1164	Destroy the terminal object (close the window, free resources	1358	Destroy the terminal object (close the window, free resources
1165	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
1166	watchers (timers, io watchers) are still active.	1360	watchers (timers, io watchers) are still active.
1167		1361
1168	=item $term->exec_async ($cmd[, @args])	1362	=item $term->exec_async ($cmd[, @args])
1169		1363
1170	Works like the combination of the C<fork>/C<exec> builtins, which executes	1364	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1197	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1391	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1198		1392
1199	Here is a likely non-exhaustive list of option names, please see the	1393	Here is a likely non-exhaustive list of option names, please see the
1200	source file F</src/optinc.h> to see the actual list:	1394	source file F</src/optinc.h> to see the actual list:
1201		1395
1202	borderLess console cursorBlink cursorUnderline hold iconic insecure	1396	borderLess buffered console cursorBlink cursorUnderline hold iconic
1203	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1397	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1204	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1398	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1205	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1399	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1206	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1400	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1207	transparent tripleclickwords utmpInhibit visualBell	1401	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1402	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1208		1403
1209	=item $value = $term->resource ($name[, $newval])	1404	=item $value = $term->resource ($name[, $newval])
1210		1405
1211	Returns the current resource value associated with a given name and	1406	Returns the current resource value associated with a given name and
1212	optionally sets a new value. Setting values is most useful in the C<init>	1407	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1225		1420
1226	Here is a likely non-exhaustive list of resource names, not all of which	1421	Here is a likely non-exhaustive list of resource names, not all of which
1227	are supported in every build, please see the source file F</src/rsinc.h>	1422	are supported in every build, please see the source file F</src/rsinc.h>
1228	to see the actual list:	1423	to see the actual list:
1229		1424
1230	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1425	answerbackstring backgroundPixmap backspace_key blurradius
1231	borderLess color cursorBlink cursorUnderline cutchars delete_key	1426	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1232	display_name embed ext_bwidth fade font geometry hold iconName	1427	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1233	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1428	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1429	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1234	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1430	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1235	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1431	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1236	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1432	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1237	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1433	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1238	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1434	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1239	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1435	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1240	secondaryScreen secondaryScroll selectstyle shade term_name title	1436	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1241	transient_for transparent transparent_all tripleclickwords utmpInhibit	1437	term_name title transient_for transparent tripleclickwords urgentOnBell
1242	visualBell	1438	utmpInhibit visualBell rewrapMode disablePasteBrackets
1243		1439
1244	=cut	1440	=cut
1245		1441
1246	sub resource($$;$) {	1442	sub resource($$;$) {
1247	my ($self, $name) = (shift, shift);	1443	my ($self, $name) = (shift, shift);
1248	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1444	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1249	&urxvt::term::_resource	1445	goto &urxvt::term::_resource
1250	}	1446	}
1251		1447
1252	=item $value = $term->x_resource ($pattern)	1448	=item $value = $term->x_resource ($pattern)
1253		1449
1254	Returns the X-Resource for the given pattern, excluding the program or	1450	Returns the X-Resource for the given pattern, excluding the program or
1255	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1451	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1256	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1452	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1257	resource with that pattern exists.	1453	resource with that pattern exists.
1258		1454
		1455	Extensions that define extra resources also need to call this method
		1456	to access their values.
		1457
		1458	If the method is called on an extension object (basically, from an
		1459	extension), then the special prefix C<%.> will be replaced by the name of
		1460	the extension and a dot, and the lone string C<%> will be replaced by the
		1461	extension name itself. This makes it possible to code extensions so you
		1462	can rename them and get a new set of resources without having to change
		1463	the actual code.
		1464
1259	This method should only be called during the C<on_start> hook, as there is	1465	This method should only be called during the C<on_start> hook, as there is
1260	only one resource database per display, and later invocations might return	1466	only one resource database per display, and later invocations might return
1261	the wrong resources.	1467	the wrong resources.
1262		1468
1263	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1469	=item $value = $term->x_resource_boolean ($pattern)
1264		1470
		1471	Like C<x_resource>, above, but interprets the string value as a boolean
		1472	and returns C<1> for true values, C<0> for false values and C<undef> if
		1473	the resource or option isn't specified.
		1474
		1475	You should always use this method to parse boolean resources.
		1476
		1477	=cut
		1478
		1479	sub x_resource_boolean {
		1480	my $res = &x_resource;
		1481
		1482	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1483	}
		1484
		1485	=item $action = $term->lookup_keysym ($keysym, $state)
		1486
		1487	Returns the action bound to key combination C<($keysym, $state)>,
		1488	if a binding for it exists, and C<undef> otherwise.
		1489
		1490	=item $success = $term->bind_action ($key, $action)
		1491
1265	Adds a keymap translation exactly as specified via a resource. See the	1492	Adds a key binding exactly as specified via a C<keysym> resource. See the
1266	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1493	C<keysym> resource in the urxvt(1) manpage.
		1494
		1495	To add default bindings for actions, an extension should call C<<
		1496	->bind_action >> in its C<init> hook for every such binding. Doing it
		1497	in the C<init> hook allows users to override or remove the binding
		1498	again.
		1499
		1500	Example: the C<searchable-scrollback> by default binds itself
		1501	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1502	$term->bind_action >>.
		1503
		1504	sub init {
		1505	my ($self) = @_;
		1506
		1507	$self->bind_action ("M-s" => "%:start");
		1508	}
1267		1509
1268	=item $rend = $term->rstyle ([$new_rstyle])	1510	=item $rend = $term->rstyle ([$new_rstyle])
1269		1511
1270	Return and optionally change the current rendition. Text that is output by	1512	Return and optionally change the current rendition. Text that is output by
1271	the terminal application will use this style.	1513	the terminal application will use this style.
…		…
1279		1521
1280	=item ($row, $col) = $term->selection_beg ([$row, $col])	1522	=item ($row, $col) = $term->selection_beg ([$row, $col])
1281		1523
1282	=item ($row, $col) = $term->selection_end ([$row, $col])	1524	=item ($row, $col) = $term->selection_end ([$row, $col])
1283		1525
1284	Return the current values of the selection mark, begin or end positions,	1526	Return the current values of the selection mark, begin or end positions.
1285	and optionally set them to new values.	1527
		1528	When arguments are given, then the selection coordinates are set to
		1529	C<$row> and C<$col>, and the selection screen is set to the current
		1530	screen.
		1531
		1532	=item $screen = $term->selection_screen ([$screen])
		1533
		1534	Returns the current selection screen, and then optionally sets it.
1286		1535
1287	=item $term->selection_make ($eventtime[, $rectangular])	1536	=item $term->selection_make ($eventtime[, $rectangular])
1288		1537
1289	Tries to make a selection as set by C<selection_beg> and	1538	Tries to make a selection as set by C<selection_beg> and
1290	C<selection_end>. If C<$rectangular> is true (default: false), a	1539	C<selection_end>. If C<$rectangular> is true (default: false), a
1291	rectangular selection will be made. This is the prefered function to make	1540	rectangular selection will be made. This is the preferred function to make
1292	a selection.	1541	a selection.
1293		1542
1294	=item $success = $term->selection_grab ($eventtime)	1543	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1295		1544
1296	Try to request the primary selection text from the server (for example, as	1545	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1546	true) selection from the server. The corresponding text can be set
1297	set by the next method). No visual feedback will be given. This function	1547	with the next method. No visual feedback will be given. This function
1298	is mostly useful from within C<on_sel_grab> hooks.	1548	is mostly useful from within C<on_sel_grab> hooks.
1299		1549
1300	=item $oldtext = $term->selection ([$newtext])	1550	=item $oldtext = $term->selection ([$newtext, $clipboard])
1301		1551
1302	Return the current selection text and optionally replace it by C<$newtext>.	1552	Return the current selection (clipboard if C<$clipboard> is true) text
		1553	and optionally replace it by C<$newtext>.
		1554
		1555	=item $term->selection_clear ([$clipboard])
		1556
		1557	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1303		1558
1304	=item $term->overlay_simple ($x, $y, $text)	1559	=item $term->overlay_simple ($x, $y, $text)
1305		1560
1306	Create a simple multi-line overlay box. See the next method for details.	1561	Create a simple multi-line overlay box. See the next method for details.
1307		1562
…		…
1335	This method returns an urxvt::overlay object. The overlay will be visible	1590	This method returns an urxvt::overlay object. The overlay will be visible
1336	as long as the perl object is referenced.	1591	as long as the perl object is referenced.
1337		1592
1338	The methods currently supported on C<urxvt::overlay> objects are:	1593	The methods currently supported on C<urxvt::overlay> objects are:
1339		1594
1340	=over 4	1595	=over
1341		1596
1342	=item $overlay->set ($x, $y, $text, $rend)	1597	=item $overlay->set ($x, $y, $text[, $rend])
1343		1598
1344	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1599	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1345	text in rxvt-unicode's special encoding and an array of rendition values	1600	text in rxvt-unicode's special encoding and an array of rendition values
1346	at a specific position inside the overlay.	1601	at a specific position inside the overlay.
		1602
		1603	If C<$rend> is missing, then the rendition will not be changed.
1347		1604
1348	=item $overlay->hide	1605	=item $overlay->hide
1349		1606
1350	If visible, hide the overlay, but do not destroy it.	1607	If visible, hide the overlay, but do not destroy it.
1351		1608
…		…
1387	Returns the number of screen-cells this string would need. Correctly	1644	Returns the number of screen-cells this string would need. Correctly
1388	accounts for wide and combining characters.	1645	accounts for wide and combining characters.
1389		1646
1390	=item $octets = $term->locale_encode ($string)	1647	=item $octets = $term->locale_encode ($string)
1391		1648
1392	Convert the given text string into the corresponding locale encoding.	1649	Convert the given text string into the corresponding locale
		1650	encoding. Returns C<undef> if C<$string> is C<undef>.
1393		1651
1394	=item $string = $term->locale_decode ($octets)	1652	=item $string = $term->locale_decode ($octets)
1395		1653
1396	Convert the given locale-encoded octets into a perl string.	1654	Convert the given locale-encoded octets into a perl string. Returns
		1655	C<undef> if C<$octets> is C<undef>.
1397		1656
1398	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1657	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1399		1658
1400	XORs the rendition values in the given span with the provided value	1659	XORs the rendition values in the given span with the provided value
1401	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in	1660	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
…		…
1414		1673
1415	=item $term->scr_add_lines ($string)	1674	=item $term->scr_add_lines ($string)
1416		1675
1417	Write the given text string to the screen, as if output by the application	1676	Write the given text string to the screen, as if output by the application
1418	running inside the terminal. It may not contain command sequences (escape	1677	running inside the terminal. It may not contain command sequences (escape
1419	codes), but is free to use line feeds, carriage returns and tabs. The	1678	codes - see C<cmd_parse> for that), but is free to use line feeds,
1420	string is a normal text string, not in locale-dependent encoding.	1679	carriage returns and tabs. The string is a normal text string, not in
		1680	locale-dependent encoding.
1421		1681
1422	Normally its not a good idea to use this function, as programs might be	1682	Normally its not a good idea to use this function, as programs might be
1423	confused by changes in cursor position or scrolling. Its useful inside a	1683	confused by changes in cursor position or scrolling. Its useful inside a
1424	C<on_add_lines> hook, though.	1684	C<on_add_lines> hook, though.
1425		1685
…		…
1433	locale-specific encoding of the terminal and can contain command sequences	1693	locale-specific encoding of the terminal and can contain command sequences
1434	(escape codes) that will be interpreted.	1694	(escape codes) that will be interpreted.
1435		1695
1436	=item $term->tt_write ($octets)	1696	=item $term->tt_write ($octets)
1437		1697
1438	Write the octets given in C<$data> to the tty (i.e. as program input). To	1698	Write the octets given in C<$octets> to the tty (i.e. as user input
		1699	to the program, see C<cmd_parse> for the opposite direction). To pass
1439	pass characters instead of octets, you should convert your strings first	1700	characters instead of octets, you should convert your strings first to the
1440	to the locale-specific encoding using C<< $term->locale_encode >>.	1701	locale-specific encoding using C<< $term->locale_encode >>.
		1702
		1703	=item $term->tt_write_user_input ($octets)
		1704
		1705	Like C<tt_write>, but should be used when writing strings in response to
		1706	the user pressing a key, to invoke the additional actions requested by
		1707	the user for that case (C<tt_write> doesn't do that).
		1708
		1709	The typical use case would be inside C<on_action> hooks.
		1710
		1711	=item $term->tt_paste ($octets)
		1712
		1713	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1714	CR and bracketing the data with control sequences if bracketed paste mode
		1715	is set.
1441		1716
1442	=item $old_events = $term->pty_ev_events ([$new_events])	1717	=item $old_events = $term->pty_ev_events ([$new_events])
1443		1718
1444	Replaces the event mask of the pty watcher by the given event mask. Can	1719	Replaces the event mask of the pty watcher by the given event mask. Can
1445	be used to suppress input and output handling to the pty/tty. See the	1720	be used to suppress input and output handling to the pty/tty. See the
…		…
1464	Adds the specified events to the vt event mask. Useful e.g. when you want	1739	Adds the specified events to the vt event mask. Useful e.g. when you want
1465	to receive pointer events all the times:	1740	to receive pointer events all the times:
1466		1741
1467	$term->vt_emask_add (urxvt::PointerMotionMask);	1742	$term->vt_emask_add (urxvt::PointerMotionMask);
1468		1743
		1744	=item $term->set_urgency ($set)
		1745
		1746	Enable/disable the urgency hint on the toplevel window.
		1747
1469	=item $term->focus_in	1748	=item $term->focus_in
1470		1749
1471	=item $term->focus_out	1750	=item $term->focus_out
1472		1751
1473	=item $term->key_press ($state, $keycode[, $time])	1752	=item $term->key_press ($state, $keycode[, $time])
1474		1753
1475	=item $term->key_release ($state, $keycode[, $time])	1754	=item $term->key_release ($state, $keycode[, $time])
1476		1755
1477	Deliver various fake events to to terminal.	1756	Deliver various fake events to to terminal.
1478		1757
1479	=item $window_width = $term->width	1758	=item $window_width = $term->width ([$new_value])
1480		1759
1481	=item $window_height = $term->height	1760	=item $window_height = $term->height ([$new_value])
1482		1761
1483	=item $font_width = $term->fwidth	1762	=item $font_width = $term->fwidth ([$new_value])
1484		1763
1485	=item $font_height = $term->fheight	1764	=item $font_height = $term->fheight ([$new_value])
1486		1765
1487	=item $font_ascent = $term->fbase	1766	=item $font_ascent = $term->fbase ([$new_value])
1488		1767
1489	=item $terminal_rows = $term->nrow	1768	=item $terminal_rows = $term->nrow ([$new_value])
1490		1769
1491	=item $terminal_columns = $term->ncol	1770	=item $terminal_columns = $term->ncol ([$new_value])
1492		1771
1493	=item $has_focus = $term->focus	1772	=item $has_focus = $term->focus ([$new_value])
1494		1773
1495	=item $is_mapped = $term->mapped	1774	=item $is_mapped = $term->mapped ([$new_value])
1496		1775
1497	=item $max_scrollback = $term->saveLines	1776	=item $max_scrollback = $term->saveLines ([$new_value])
1498		1777
1499	=item $nrow_plus_saveLines = $term->total_rows	1778	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1500		1779
1501	=item $topmost_scrollback_row = $term->top_row	1780	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1502		1781
1503	Return various integers describing terminal characteristics.	1782	Return various integers describing terminal characteristics. If an
		1783	argument is given, changes the value and returns the previous one.
1504		1784
1505	=item $x_display = $term->display_id	1785	=item $x_display = $term->display_id
1506		1786
1507	Return the DISPLAY used by rxvt-unicode.	1787	Return the DISPLAY used by rxvt-unicode.
1508		1788
…		…
1545		1825
1546	=item $cursor_is_hidden = $term->hidden_cursor	1826	=item $cursor_is_hidden = $term->hidden_cursor
1547		1827
1548	Returns whether the cursor is currently hidden or not.	1828	Returns whether the cursor is currently hidden or not.
1549		1829
		1830	=item $priv_modes = $term->priv_modes
		1831
		1832	Returns a bitset with the state of DEC private modes.
		1833
		1834	Example:
		1835
		1836	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1837	# mouse reporting is turned on
		1838	}
		1839
1550	=item $view_start = $term->view_start ([$newvalue])	1840	=item $view_start = $term->view_start ([$newvalue])
1551		1841
1552	Returns the row number of the topmost displayed line. Maximum value is	1842	Returns the row number of the topmost displayed line and changes it,
1553	C<0>, which displays the normal terminal contents. Lower values scroll	1843	if an argument is given. Values greater than or equal to C<0> display
1554	this many lines into the scrollback buffer.	1844	the terminal contents. Lower values scroll this many lines into the
		1845	scrollback buffer.
1555		1846
1556	=item $term->want_refresh	1847	=item $term->want_refresh
1557		1848
1558	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1849	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1559	compare the on-screen display with its stored representation. If they	1850	compare the on-screen display with its stored representation. If they
1560	differ, it redraws the differences.	1851	differ, it redraws the differences.
1561		1852
1562	Used after changing terminal contents to display them.	1853	Used after changing terminal contents to display them.
1563		1854
		1855	=item $term->refresh_check
		1856
		1857	Checks if a refresh has been requested and, if so, schedules one.
		1858
1564	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1859	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1565		1860
1566	Returns the text of the entire row with number C<$row_number>. Row C<0>	1861	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1567	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1862	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1568	terminal line. The scrollback buffer starts at line C<-1> and extends to
1569	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1863	terminal line. Nothing will be returned if a nonexistent line
1570	is requested.	1864	is requested.
1571		1865
1572	If C<$new_text> is specified, it will replace characters in the current	1866	If C<$new_text> is specified, it will replace characters in the current
1573	line, starting at column C<$start_col> (default C<0>), which is useful	1867	line, starting at column C<$start_col> (default C<0>), which is useful
1574	to replace only parts of a line. The font index in the rendition will	1868	to replace only parts of a line. The font index in the rendition will
1575	automatically be updated.	1869	automatically be updated.
1576		1870
1577	C<$text> is in a special encoding: tabs and wide characters that use more	1871	C<$text> is in a special encoding: tabs and wide characters that use more
1578	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1872	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1579	characters. Characters with combining characters and other characters that	1873	characters. Characters with combining characters and other characters that
1580	do not fit into the normal tetx encoding will be replaced with characters	1874	do not fit into the normal text encoding will be replaced with characters
1581	in the private use area.	1875	in the private use area.
1582		1876
1583	You have to obey this encoding when changing text. The advantage is	1877	You have to obey this encoding when changing text. The advantage is
1584	that C<substr> and similar functions work on screen cells and not on	1878	that C<substr> and similar functions work on screen cells and not on
1585	characters.	1879	characters.
…		…
1614		1908
1615	Create and return a new C<urxvt::line> object that stores information	1909	Create and return a new C<urxvt::line> object that stores information
1616	about the logical line that row C<$row_number> is part of. It supports the	1910	about the logical line that row C<$row_number> is part of. It supports the
1617	following methods:	1911	following methods:
1618		1912
1619	=over 4	1913	=over
1620		1914
1621	=item $text = $line->t ([$new_text])	1915	=item $text = $line->t ([$new_text])
1622		1916
1623	Returns or replaces the full text of the line, similar to C<ROW_t>	1917	Returns or replaces the full text of the line, similar to C<ROW_t>
1624		1918
…		…
1670	}	1964	}
1671		1965
1672	sub urxvt::line::t {	1966	sub urxvt::line::t {
1673	my ($self) = @_;	1967	my ($self) = @_;
1674		1968
1675	if (@_ > 1)	1969	if (@_ > 1) {
1676	{
1677	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1970	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1678	for $self->{beg} .. $self->{end};	1971	for $self->{beg} .. $self->{end};
1679	}	1972	}
1680		1973
1681	defined wantarray &&	1974	defined wantarray &&
1682	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1975	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1683	0, $self->{len}	1976	0, $self->{len}
1684	}	1977	}
1685		1978
1686	sub urxvt::line::r {	1979	sub urxvt::line::r {
1687	my ($self) = @_;	1980	my ($self) = @_;
1688		1981
1689	if (@_ > 1)	1982	if (@_ > 1) {
1690	{
1691	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1983	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1692	for $self->{beg} .. $self->{end};	1984	for $self->{beg} .. $self->{end};
1693	}	1985	}
1694		1986
1695	if (defined wantarray) {	1987	if (defined wantarray) {
1696	my $rend = [	1988	my $rend = [
1697	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1989	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1698	];	1990	];
…		…
1730	where one character corresponds to one screen cell. See	2022	where one character corresponds to one screen cell. See
1731	C<< $term->ROW_t >> for details.	2023	C<< $term->ROW_t >> for details.
1732		2024
1733	=item $string = $term->special_decode $text	2025	=item $string = $term->special_decode $text
1734		2026
1735	Converts rxvt-unicodes text representation into a perl string. See	2027	Converts rxvt-unicode's text representation into a perl string. See
1736	C<< $term->ROW_t >> for details.	2028	C<< $term->ROW_t >> for details.
1737		2029
1738	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2030	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1739		2031
1740	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2032	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1760	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2052	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1761	recent grab.	2053	recent grab.
1762		2054
1763	=item $term->ungrab	2055	=item $term->ungrab
1764		2056
1765	Calls XUngrab for the most recent grab. Is called automatically on	2057	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1766	evaluation errors, as it is better to lose the grab in the error case as	2058	evaluation errors, as it is better to lose the grab in the error case as
1767	the session.	2059	the session.
1768		2060
1769	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2061	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1770		2062
…		…
1772		2064
1773	=item @atoms = $term->XListProperties ($window)	2065	=item @atoms = $term->XListProperties ($window)
1774		2066
1775	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2067	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1776		2068
1777	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2069	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1778		2070
1779	=item $term->XDeleteProperty ($window, $property)	2071	=item $term->XDeleteProperty ($window, $property)
1780		2072
1781	=item $window = $term->DefaultRootWindow	2073	=item $window = $term->DefaultRootWindow
1782		2074
…		…
1789	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2081	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1790		2082
1791	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2083	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1792		2084
1793	=item $term->XChangeInput ($window, $add_events[, $del_events])	2085	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2086
		2087	=item $keysym = $term->XStringToKeysym ($string)
		2088
		2089	=item $string = $term->XKeysymToString ($keysym)
1794		2090
1795	Various X or X-related functions. The C<$term> object only serves as	2091	Various X or X-related functions. The C<$term> object only serves as
1796	the source of the display, otherwise those functions map more-or-less	2092	the source of the display, otherwise those functions map more-or-less
1797	directory onto the X functions of the same name.	2093	directly onto the X functions of the same name.
1798		2094
1799	=back	2095	=back
1800		2096
1801	=cut	2097	=cut
1802		2098
1803	package urxvt::popup;	2099	package urxvt::popup;
1804		2100
1805	=head2 The C<urxvt::popup> Class	2101	=head2 The C<urxvt::popup> Class
1806		2102
1807	=over 4	2103	=over
1808		2104
1809	=cut	2105	=cut
1810		2106
1811	sub add_item {	2107	sub add_item {
1812	my ($self, $item) = @_;	2108	my ($self, $item) = @_;
…		…
1904	my $env = $self->{term}->env;	2200	my $env = $self->{term}->env;
1905	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2201	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1906	delete $env->{LC_ALL};	2202	delete $env->{LC_ALL};
1907	$env->{LC_CTYPE} = $self->{term}->locale;	2203	$env->{LC_CTYPE} = $self->{term}->locale;
1908		2204
1909	urxvt::term->new ($env, "popup",	2205	my $term = urxvt::term->new (
		2206	$env, "popup",
1910	"--perl-lib" => "", "--perl-ext-common" => "",	2207	"--perl-lib" => "", "--perl-ext-common" => "",
1911	"-pty-fd" => -1, "-sl" => 0,	2208	"-pty-fd" => -1, "-sl" => 0,
1912	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2209	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1913	"--transient-for" => $self->{term}->parent,	2210	"--transient-for" => $self->{term}->parent,
1914	"-display" => $self->{term}->display_id,	2211	"-display" => $self->{term}->display_id,
1915	"-pe" => "urxvt-popup")	2212	"-pe" => "urxvt-popup",
1916	or die "unable to create popup window\n";	2213	) or die "unable to create popup window\n";
		2214
		2215	unless (delete $term->{urxvt_popup_init_done}) {
		2216	$term->ungrab;
		2217	$term->destroy;
		2218	die "unable to initialise popup window\n";
		2219	}
1917	}	2220	}
1918		2221
1919	sub DESTROY {	2222	sub DESTROY {
1920	my ($self) = @_;	2223	my ($self) = @_;
1921		2224
…		…
1926	=back	2229	=back
1927		2230
1928	=cut	2231	=cut
1929		2232
1930	package urxvt::watcher;	2233	package urxvt::watcher;
1931
1932	@urxvt::timer::ISA = __PACKAGE__;
1933	@urxvt::iow::ISA = __PACKAGE__;
1934	@urxvt::pw::ISA = __PACKAGE__;
1935	@urxvt::iw::ISA = __PACKAGE__;
1936		2234
1937	=head2 The C<urxvt::timer> Class	2235	=head2 The C<urxvt::timer> Class
1938		2236
1939	This class implements timer watchers/events. Time is represented as a	2237	This class implements timer watchers/events. Time is represented as a
1940	fractional number of seconds since the epoch. Example:	2238	fractional number of seconds since the epoch. Example:
…		…
1944	->new	2242	->new
1945	->interval (1)	2243	->interval (1)
1946	->cb (sub {	2244	->cb (sub {
1947	$term->{overlay}->set (0, 0,	2245	$term->{overlay}->set (0, 0,
1948	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2246	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1949	});	2247	});
1950		2248
1951	=over 4	2249	=over
1952		2250
1953	=item $timer = new urxvt::timer	2251	=item $timer = new urxvt::timer
1954		2252
1955	Create a new timer object in started state. It is scheduled to fire	2253	Create a new timer object in started state. It is scheduled to fire
1956	immediately.	2254	immediately.
1957		2255
1958	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2256	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1959		2257
1960	Set the callback to be called when the timer triggers.	2258	Set the callback to be called when the timer triggers.
1961		2259
1962	=item $tstamp = $timer->at
1963
1964	Return the time this watcher will fire next.
1965
1966	=item $timer = $timer->set ($tstamp)	2260	=item $timer = $timer->set ($tstamp[, $interval])
1967		2261
1968	Set the time the event is generated to $tstamp.	2262	Set the time the event is generated to $tstamp (and optionally specifies a
		2263	new $interval).
1969		2264
1970	=item $timer = $timer->interval ($interval)	2265	=item $timer = $timer->interval ($interval)
1971		2266
1972	Normally (and when C<$interval> is C<0>), the timer will automatically	2267	By default (and when C<$interval> is C<0>), the timer will automatically
1973	stop after it has fired once. If C<$interval> is non-zero, then the timer	2268	stop after it has fired once. If C<$interval> is non-zero, then the timer
1974	is automatically rescheduled at the given intervals.	2269	is automatically rescheduled at the given intervals.
1975		2270
1976	=item $timer = $timer->start	2271	=item $timer = $timer->start
1977		2272
1978	Start the timer.	2273	Start the timer.
1979		2274
1980	=item $timer = $timer->start ($tstamp)	2275	=item $timer = $timer->start ($tstamp[, $interval])
1981		2276
1982	Set the event trigger time to C<$tstamp> and start the timer.	2277	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2278	also replaces the interval.
1983		2279
1984	=item $timer = $timer->after ($delay)	2280	=item $timer = $timer->after ($delay[, $interval])
1985		2281
1986	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2282	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1987		2283
1988	=item $timer = $timer->stop	2284	=item $timer = $timer->stop
1989		2285
…		…
1997		2293
1998	$term->{socket} = ...	2294	$term->{socket} = ...
1999	$term->{iow} = urxvt::iow	2295	$term->{iow} = urxvt::iow
2000	->new	2296	->new
2001	->fd (fileno $term->{socket})	2297	->fd (fileno $term->{socket})
2002	->events (urxvt::EVENT_READ)	2298	->events (urxvt::EV_READ)
2003	->start	2299	->start
2004	->cb (sub {	2300	->cb (sub {
2005	my ($iow, $revents) = @_;	2301	my ($iow, $revents) = @_;
2006	# $revents must be 1 here, no need to check	2302	# $revents must be 1 here, no need to check
2007	sysread $term->{socket}, my $buf, 8192	2303	sysread $term->{socket}, my $buf, 8192
2008	or end-of-file;	2304	or end-of-file;
2009	});	2305	});
2010		2306
2011		2307
2012	=over 4	2308	=over
2013		2309
2014	=item $iow = new urxvt::iow	2310	=item $iow = new urxvt::iow
2015		2311
2016	Create a new io watcher object in stopped state.	2312	Create a new io watcher object in stopped state.
2017		2313
…		…
2025	Set the file descriptor (not handle) to watch.	2321	Set the file descriptor (not handle) to watch.
2026		2322
2027	=item $iow = $iow->events ($eventmask)	2323	=item $iow = $iow->events ($eventmask)
2028		2324
2029	Set the event mask to watch. The only allowed values are	2325	Set the event mask to watch. The only allowed values are
2030	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2326	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2031	together, or C<urxvt::EVENT_NONE>.	2327	together, or C<urxvt::EV_NONE>.
2032		2328
2033	=item $iow = $iow->start	2329	=item $iow = $iow->start
2034		2330
2035	Start watching for requested events on the given handle.	2331	Start watching for requested events on the given handle.
2036		2332
…		…
2044		2340
2045	This class implements idle watchers, that get called automatically when	2341	This class implements idle watchers, that get called automatically when
2046	the process is idle. They should return as fast as possible, after doing	2342	the process is idle. They should return as fast as possible, after doing
2047	some useful work.	2343	some useful work.
2048		2344
2049	=over 4	2345	=over
2050		2346
2051	=item $iw = new urxvt::iw	2347	=item $iw = new urxvt::iw
2052		2348
2053	Create a new idle watcher object in stopped state.	2349	Create a new idle watcher object in stopped state.
2054		2350
…		…
2077	->new	2373	->new
2078	->start ($pid)	2374	->start ($pid)
2079	->cb (sub {	2375	->cb (sub {
2080	my ($pw, $exit_status) = @_;	2376	my ($pw, $exit_status) = @_;
2081	...	2377	...
2082	});	2378	});
2083		2379
2084	=over 4	2380	=over
2085		2381
2086	=item $pw = new urxvt::pw	2382	=item $pw = new urxvt::pw
2087		2383
2088	Create a new process watcher in stopped state.	2384	Create a new process watcher in stopped state.
2089		2385
…		…
2106	=head2 URXVT_PERL_VERBOSITY	2402	=head2 URXVT_PERL_VERBOSITY
2107		2403
2108	This variable controls the verbosity level of the perl extension. Higher	2404	This variable controls the verbosity level of the perl extension. Higher
2109	numbers indicate more verbose output.	2405	numbers indicate more verbose output.
2110		2406
2111	=over 4	2407	=over
2112		2408
2113	=item == 0 - fatal messages	2409	=item == 0 - fatal messages only
		2410
		2411	=item >= 2 - general warnings (default level)
2114		2412
2115	=item >= 3 - script loading and management	2413	=item >= 3 - script loading and management
2116		2414
2117	=item >=10 - all called hooks	2415	=item >=10 - all called hooks
2118		2416
…		…
2120		2418
2121	=back	2419	=back
2122		2420
2123	=head1 AUTHOR	2421	=head1 AUTHOR
2124		2422
2125	Marc Lehmann <pcg@goof.com>	2423	Marc Lehmann <schmorp@schmorp.de>
2126	http://software.schmorp.de/pkg/rxvt-unicode	2424	http://software.schmorp.de/pkg/rxvt-unicode
2127		2425
2128	=cut	2426	=cut
2129		2427
2130	1	2428	1
		2429
		2430	# vim: sw=3:

Diff Legend

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