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.154 by root, Sat Jun 2 06:43:02 2007 UTC vs.
Revision 1.267 by sf-exg, Sat Jul 24 12:17:08 2021 UTC

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

Diff Legend

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