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.172 by root, Fri Oct 10 00:21:15 2008 UTC vs.
Revision 1.256 by sf-exg, Thu Jul 14 05:10:06 2016 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 $HOME:
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 using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -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 "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	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,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	Its 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	Its 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 b" => 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 if the C<Shift> modifier is active.
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 (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	It is possible to activate the most recently seen match from the keyboard.
265	Simply bind a keysym to "perl:matcher" as seen in the example below.
266
267	Example configuration:
268
269	URxvt.perl-ext: default,matcher
270	URxvt.urlLauncher: sensible-browser
271	URxvt.keysym.C-Delete: perl:matcher
272	URxvt.matcher.button: 1
273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275	URxvt.matcher.launcher.2: gvim +$2 $1
276
277	=item xim-onthespot
278
279	This (experimental) perl extension implements OnTheSpot editing. It does
280	not work perfectly, and some input methods don't seem to work well with
281	OnTheSpot editing in general, but it seems to work at least for SCIM and
282	kinput2.
283
284	You enable it by specifying this extension and a preedit style of
285	C<OnTheSpot>, i.e.:
286
287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
288
289	=item kuake<hotkey>
290
291	A very primitive quake-console-like extension. It was inspired by a
292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
293	user presses a global accelerator key (by default C<F10>), the terminal
294	will show or hide itself. Another press of the accelerator key will hide
295	or show it again.
296
297	Initially, the window will not be shown when using this extension.
298
299	This is useful if you need a single terminal that is not using any desktop
300	space most of the time but is quickly available at the press of a key.
301
302	The accelerator key is grabbed regardless of any modifiers, so this
303	extension will actually grab a physical key just for this function.
304
305	If you want a quake-like animation, tell your window manager to do so
306	(fvwm can do it).
307
308	=item block-graphics-to-ascii
309
310	A not very useful example of filtering all text output to the terminal
311	by replacing all line-drawing characters (U+2500 .. U+259F) by a
312	similar-looking ascii character.
313
314	=item digital-clock
315
316	Displays a digital clock using the built-in overlay.
317
318	=item remote-clipboard
319
320	Somewhat of a misnomer, this extension adds two menu entries to the
321	selection popup that allows one to run external commands to store the
322	selection somewhere and fetch it again.
323
324	We use it to implement a "distributed selection mechanism", which just
325	means that one command uploads the file to a remote server, and another
326	reads it.
327
328	The commands can be set using the C<URxvt.remote-selection.store> and
329	C<URxvt.remote-selection.fetch> resources. The first should read the
330	selection to store from STDIN (always in UTF-8), the second should provide
331	the selection data on STDOUT (also in UTF-8).
332
333	The defaults (which are likely useless to you) use rsh and cat:
334
335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
337
338	=item selection-pastebin
339
340	This is a little rarely useful extension that Uploads the selection as
341	textfile to a remote site (or does other things). (The implementation is
342	not currently secure for use in a multiuser environment as it writes to
343	F</tmp> directly.).
344
345	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
346	i.e.
347
348	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
349
350	Pressing this combination runs a command with C<%> replaced by the name of
351	the textfile. This command can be set via a resource:
352
353	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
354
355	And the default is likely not useful to anybody but the few people around
356	here :)
357
358	The name of the textfile is the hex encoded md5 sum of the selection, so
359	the same content should lead to the same filename.
360
361	After a successful upload the selection will be replaced by the text given
362	in the C<selection-pastebin-url> resource (again, the % is the placeholder
363	for the filename):
364
365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366
367	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
368	the double C</> characters as comment start. Use C<\057\057> instead,
369	which works regardless of wether xrdb is used to parse the resource file
370	or not.
371
372	=item example-refresh-hooks
373
374	Displays a very simple digital clock in the upper right corner of the
375	window. Illustrates overwriting the refresh callbacks to create your own
376	overlays or changes.
377
378	=back
379		56
380	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
381		58
382	=head2 General API Considerations	59	=head2 General API Considerations
383		60
…		…
397		74
398	=over 4	75	=over 4
399		76
400	=item $text	77	=item $text
401		78
402	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
403	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.
404		81
405	=item $string	82	=item $string
406		83
407	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
…		…
411	=item $octets	88	=item $octets
412		89
413	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
414	locale-specific way.	91	locale-specific way.
415		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
416	=back	99	=back
417		100
418	=head2 Extension Objects	101	=head2 Extension Objects
419		102
420	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
421	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,
422	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
423	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
424	extensions or other terminals, with the exception of methods and members	107	extensions or other terminals, with the exception of methods and members
425	that begin with an underscore character C<_>: these are reserved for	108	that begin with an underscore character C<_>: these are reserved for
426	internal use.	109	internal use.
427		110
428	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
429	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
430		113
431	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.
		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata.
		121
		122	Currently, it recognises only one such comment:
432		123
433	=over 4	124	=over 4
434		125
435	=item $urxvt_term = $self->{term}	126	=item #:META:RESOURCE:name:type:desc
436		127
437	Returns the C<urxvt::term> object associated with this instance of the	128	The RESOURCE comment defines a resource used by the extension, where
438	extension. This member I<must not> be changed in any way.	129	C<name> is the resource name, C<type> is the resource type, C<boolean>
439		130	or C<string>, and C<desc> is the resource description.
440	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
441
442	Dynamically enable the given hooks (named without the C<on_> prefix) for
443	this extension, replacing any previous hook. This is useful when you want
444	to overwrite time-critical hooks only temporarily.
445
446	=item $self->disable ($hook_name[, $hook_name..])
447
448	Dynamically disable the given hooks.
449		131
450	=back	132	=back
451		133
452	=head2 Hooks	134	=head2 Hooks
453		135
…		…
590	=item on_tt_write $term, $octets	272	=item on_tt_write $term, $octets
591		273
592	Called whenever some data is written to the tty/pty and can be used to	274	Called whenever some data is written to the tty/pty and can be used to
593	suppress or filter tty input.	275	suppress or filter tty input.
594		276
		277	=item on_tt_paste $term, $octets
		278
		279	Called whenever text is about to be pasted, with the text as argument. You
		280	can filter/change and paste the text yourself by returning a true value
		281	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		282	locale-encoded.
		283
595	=item on_line_update $term, $row	284	=item on_line_update $term, $row
596		285
597	Called whenever a line was updated or changed. Can be used to filter	286	Called whenever a line was updated or changed. Can be used to filter
598	screen output (e.g. underline urls or other useless stuff). Only lines	287	screen output (e.g. underline urls or other useless stuff). Only lines
599	that are being shown will be filtered, and, due to performance reasons,	288	that are being shown will be filtered, and, due to performance reasons,
…		…
615		304
616	=item on_refresh_end $term	305	=item on_refresh_end $term
617		306
618	Called just after the screen gets redrawn. See C<on_refresh_begin>.	307	Called just after the screen gets redrawn. See C<on_refresh_begin>.
619		308
		309	=item on_action $term, $string
		310
		311	Called whenever an action is invoked for the corresponding extension
		312	(e.g. via a C<extension:string> builtin action bound to a key, see
		313	description of the B<keysym> resource in the urxvt(1) manpage). The
		314	event is simply the action string. Note that an action event is always
		315	associated to a single extension.
		316
620	=item on_user_command $term, $string	317	=item on_user_command $term, $string *DEPRECATED*
621		318
622	Called whenever a user-configured event is being activated (e.g. via	319	Called whenever a user-configured event is being activated (e.g. via
623	a C<perl:string> action bound to a key, see description of the B<keysym>	320	a C<perl:string> action bound to a key, see description of the B<keysym>
624	resource in the @@RXVT_NAME@@(1) manpage).	321	resource in the urxvt(1) manpage).
625		322
626	The event is simply the action string. This interface is assumed to change	323	The event is simply the action string. This interface is going away in
627	slightly in the future.	324	preference to the C<on_action> hook.
628		325
629	=item on_resize_all_windows $tern, $new_width, $new_height	326	=item on_resize_all_windows $term, $new_width, $new_height
630		327
631	Called just after the new window size has been calculated, but before	328	Called just after the new window size has been calculated, but before
632	windows are actually being resized or hints are being set. If this hook	329	windows are actually being resized or hints are being set. If this hook
633	returns TRUE, setting of the window hints is being skipped.	330	returns a true value, setting of the window hints is being skipped.
634		331
635	=item on_x_event $term, $event	332	=item on_x_event $term, $event
636		333
637	Called on every X event received on the vt window (and possibly other	334	Called on every X event received on the vt window (and possibly other
638	windows). Should only be used as a last resort. Most event structure	335	windows). Should only be used as a last resort. Most event structure
…		…
668		365
669	=item on_map_notify $term, $event	366	=item on_map_notify $term, $event
670		367
671	=item on_unmap_notify $term, $event	368	=item on_unmap_notify $term, $event
672		369
673	Called whenever the corresponding X event is received for the terminal If	370	Called whenever the corresponding X event is received for the terminal. If
674	the hook returns true, then the even will be ignored by rxvt-unicode.	371	the hook returns true, then the event will be ignored by rxvt-unicode.
675		372
676	The event is a hash with most values as named by Xlib (see the XEvent	373	The event is a hash with most values as named by Xlib (see the XEvent
677	manpage), with the additional members C<row> and C<col>, which are the	374	manpage), with the additional members C<row> and C<col>, which are the
678	(real, not screen-based) row and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
679		376
680	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
681	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
682		379
683	subwindow.
684
685	=item on_client_message $term, $event	380	=item on_client_message $term, $event
686		381
687	=item on_wm_protocols $term, $event	382	=item on_wm_protocols $term, $event
688		383
689	=item on_wm_delete_window $term, $event	384	=item on_wm_delete_window $term, $event
690		385
691	Called when various types of ClientMessage events are received (all with	386	Called when various types of ClientMessage events are received (all with
692	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	387	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
693		388
		389	=item on_bell $term
		390
		391	Called on receipt of a bell character.
		392
694	=back	393	=back
695		394
696	=cut	395	=cut
697		396
698	package urxvt;	397	package urxvt;
699		398
700	use utf8;	399	use utf8;
701	use strict;	400	use strict 'vars';
702	use Carp ();	401	use Carp ();
703	use Scalar::Util ();	402	use Scalar::Util ();
704	use List::Util ();	403	use List::Util ();
705		404
706	our $VERSION = 1;	405	our $VERSION = 1;
707	our $TERM;	406	our $TERM;
708	our @TERM_INIT;	407	our @TERM_INIT; # should go, prevents async I/O etc.
709	our @TERM_EXT;	408	our @TERM_EXT; # should go, prevents async I/O etc.
710	our @HOOKNAME;	409	our @HOOKNAME;
711	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	410	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
712	our %OPTION;	411	our %OPTION;
713		412
714	our $LIBDIR;	413	our $LIBDIR;
…		…
762		461
763	=over 4	462	=over 4
764		463
765	=item urxvt::fatal $errormessage	464	=item urxvt::fatal $errormessage
766		465
767	Fatally aborts execution with the given error message. Avoid at all	466	Fatally aborts execution with the given error message (which should
768	costs! The only time this is acceptable is when the terminal process	467	include a trailing newline). Avoid at all costs! The only time this
769	starts up.	468	is acceptable (and useful) is in the init hook, where it prevents the
		469	terminal from starting up.
770		470
771	=item urxvt::warn $string	471	=item urxvt::warn $string
772		472
773	Calls C<rxvt_warn> with the given string which should not include a	473	Calls C<rxvt_warn> with the given string which should include a trailing
774	newline. The module also overwrites the C<warn> builtin with a function	474	newline. The module also overwrites the C<warn> builtin with a function
775	that calls this function.	475	that calls this function.
776		476
777	Using this function has the advantage that its output ends up in the	477	Using this function has the advantage that its output ends up in the
778	correct place, e.g. on stderr of the connecting urxvtc client.	478	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
782	=item @terms = urxvt::termlist	482	=item @terms = urxvt::termlist
783		483
784	Returns all urxvt::term objects that exist in this process, regardless of	484	Returns all urxvt::term objects that exist in this process, regardless of
785	whether they are started, being destroyed etc., so be careful. Only term	485	whether they are started, being destroyed etc., so be careful. Only term
786	objects that have perl extensions attached will be returned (because there	486	objects that have perl extensions attached will be returned (because there
787	is no urxvt::term objet associated with others).	487	is no urxvt::term object associated with others).
788		488
789	=item $time = urxvt::NOW	489	=item $time = urxvt::NOW
790		490
791	Returns the "current time" (as per the event loop).	491	Returns the "current time" (as per the event loop).
792		492
…		…
835		535
836	=item $rend = urxvt::OVERLAY_RSTYLE	536	=item $rend = urxvt::OVERLAY_RSTYLE
837		537
838	Return the rendition mask used for overlays by default.	538	Return the rendition mask used for overlays by default.
839		539
840	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	540	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		541	urxvt::RS_RVid, urxvt::RS_Uline
841		542
842	Return the bit that enabled bold, italic, blink, reverse-video and	543	Return the bit that enabled bold, italic, blink, reverse-video and
843	underline, respectively. To enable such a style, just logically OR it into	544	underline, respectively. To enable such a style, just logically OR it into
844	the bitset.	545	the bitset.
845		546
…		…
882	};	583	};
883	}	584	}
884		585
885	no warnings 'utf8';	586	no warnings 'utf8';
886		587
		588	sub parse_resource {
		589	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		590
		591	$term->scan_extensions;
		592
		593	my $r = $term->{meta}{resource};
		594	keys %$r; # reset iterator
		595	while (my ($k, $v) = each %$r) {
		596	my $pattern = $k;
		597	$pattern =~ y/./-/ if $isarg;
		598	my $prefix = $name;
		599	my $suffix;
		600	if ($pattern =~ /\-$/) {
		601	$prefix = substr $name, 0, length $pattern;
		602	$suffix = substr $name, length $pattern;
		603	}
		604	if ($pattern eq $prefix) {
		605	$name = "$urxvt::RESCLASS.$k$suffix";
		606
		607	push @{ $term->{perl_ext_3} }, $v->[0];
		608
		609	return 1 unless $isarg;
		610
		611	if ($v->[1] eq "boolean") {
		612	$term->put_option_db ($name, $flag ? "true" : "false");
		613	return 1;
		614	} else {
		615	$term->put_option_db ($name, $value);
		616	return 1 + 2;
		617	}
		618	}
		619	}
		620
		621	0
		622	}
		623
		624	sub usage {
		625	my ($term, $usage_type) = @_;
		626
		627	$term->scan_extensions;
		628
		629	my $r = $term->{meta}{resource};
		630
		631	for my $pattern (sort keys %$r) {
		632	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		633
		634	$desc .= " (-pe $ext)";
		635
		636	if ($usage_type == 1) {
		637	$pattern =~ y/./-/;
		638	$pattern =~ s/-$/-.../g;
		639
		640	if ($type eq "boolean") {
		641	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		642	} else {
		643	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		644	}
		645	} else {
		646	$pattern =~ s/\.$/.*/g;
		647	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		648	}
		649	}
		650	}
		651
887	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	652	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
888		653
889	sub verbose {	654	sub verbose {
890	my ($level, $msg) = @_;	655	my ($level, $msg) = @_;
891	warn "$msg\n" if $level <= $verbosity;	656	warn "$msg\n" if $level <= $verbosity;
…		…
903	$pkg =~ s/[^[:word:]]/_/g;	668	$pkg =~ s/[^[:word:]]/_/g;
904	$pkg = "urxvt::ext::$pkg";	669	$pkg = "urxvt::ext::$pkg";
905		670
906	verbose 3, "loading extension '$path' into package '$pkg'";	671	verbose 3, "loading extension '$path' into package '$pkg'";
907		672
		673	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		674
908	open my $fh, "<:raw", $path	675	open my $fh, "<:raw", $path
909	or die "$path: $!";	676	or die "$path: $!";
910		677
911	my $source =	678	my $source =
912	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	679	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
913	. "#line 1 \"$path\"\n{\n"	680	. "#line 1 \"$path\"\n{\n"
914	. (do { local $/; <$fh> })	681	. (do { local $/; <$fh> })
915	. "\n};\n1";	682	. "\n};\n1";
916		683
917	eval $source	684	eval $source
…		…
926	# called by the rxvt core	693	# called by the rxvt core
927	sub invoke {	694	sub invoke {
928	local $TERM = shift;	695	local $TERM = shift;
929	my $htype = shift;	696	my $htype = shift;
930		697
931	if ($htype == 0) { # INIT	698	if ($htype == HOOK_INIT) {
932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	699	my @dirs = $TERM->perl_libdirs;
		700
		701	$TERM->scan_extensions;
933		702
934	my %ext_arg;	703	my %ext_arg;
935		704
936	{	705	{
937	my @init = @TERM_INIT;	706	my @init = @TERM_INIT;
…		…
940	my @pkg = @TERM_EXT;	709	my @pkg = @TERM_EXT;
941	@TERM_EXT = ();	710	@TERM_EXT = ();
942	$TERM->register_package ($_) for @pkg;	711	$TERM->register_package ($_) for @pkg;
943	}	712	}
944		713
		714	for (
945	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	715	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		716	@{ delete $TERM->{perl_ext_3} }
		717	) {
946	if ($_ eq "default") {	718	if ($_ eq "default") {
		719
		720	$ext_arg{$_} = []
947	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	721	for qw(selection option-popup selection-popup readline searchable-scrollback);
		722
		723	for ($TERM->_keysym_resources) {
		724	next if /^(?:string|command|builtin|builtin-string|perl)/;
		725	next unless /^([A-Za-z0-9_\-]+):/;
		726
		727	my $ext = $1;
		728
		729	$ext_arg{$ext} = [];
		730	}
		731
948	} elsif (/^-(.*)$/) {	732	} elsif (/^-(.*)$/) {
949	delete $ext_arg{$1};	733	delete $ext_arg{$1};
		734
950	} elsif (/^([^<]+)<(.*)>$/) {	735	} elsif (/^([^<]+)<(.*)>$/) {
951	push @{ $ext_arg{$1} }, $2;	736	push @{ $ext_arg{$1} }, $2;
		737
952	} else {	738	} else {
953	$ext_arg{$_} ||= [];	739	$ext_arg{$_} ||= [];
954	}	740	}
955	}	741	}
956		742
…		…
972		758
973	if (my $cb = $TERM->{_hook}[$htype]) {	759	if (my $cb = $TERM->{_hook}[$htype]) {
974	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	760	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
975	if $verbosity >= 10;	761	if $verbosity >= 10;
976		762
		763	if ($htype == HOOK_ACTION) {
		764	# this hook is only sent to the extension with the name
		765	# matching the first arg
		766	my $pkg = shift;
		767	$pkg =~ y/-/_/;
		768	$pkg = "urxvt::ext::$pkg";
		769
		770	$cb = $cb->{$pkg}
		771	or return undef; #TODO: maybe warn user?
		772
		773	$cb = { $pkg => $cb };
		774	}
		775
977	for my $pkg (keys %$cb) {	776	for my $pkg (keys %$cb) {
978	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	777	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
979	$retval ||= $retval_;	778	$retval ||= $retval_;
980		779
981	if ($@) {	780	if ($@) {
982	$TERM->ungrab; # better to lose the grab than the session	781	$TERM->ungrab; # better to lose the grab than the session
983	warn $@;	782	warn $@;
…		…
986		785
987	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	786	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
988	if $verbosity >= 11;	787	if $verbosity >= 11;
989	}	788	}
990		789
991	if ($htype == 1) { # DESTROY	790	if ($htype == HOOK_DESTROY) {
992	# clear package objects	791	# clear package objects
993	%$_ = () for values %{ $TERM->{_pkg} };	792	%$_ = () for values %{ $TERM->{_pkg} };
994		793
995	# clear package	794	# clear package
996	%$TERM = ();	795	%$TERM = ();
…		…
1026	}	825	}
1027	}	826	}
1028	($mask, @color{qw(fg bg)}, \@failed)	827	($mask, @color{qw(fg bg)}, \@failed)
1029	}	828	}
1030		829
1031	# urxvt::term::extension
1032
1033	package urxvt::term::extension;	830	package urxvt::term::extension;
1034		831
1035	sub enable {	832	=head2 The C<urxvt::term::extension> class
1036	my ($self, %hook) = @_;
1037	my $pkg = $self->{_pkg};
1038		833
1039	while (my ($name, $cb) = each %hook) {	834	Each extension attached to a terminal object is represented by
1040	my $htype = $HOOKTYPE{uc $name};	835	a C<urxvt::term::extension> object.
1041	defined $htype
1042	or Carp::croak "unsupported hook type '$name'";
1043		836
1044	$self->set_should_invoke ($htype, +1)	837	You can use these objects, which are passed to all callbacks to store any
1045	unless exists $self->{term}{_hook}[$htype]{$pkg};	838	state related to the terminal and extension instance.
1046		839
1047	$self->{term}{_hook}[$htype]{$pkg} = $cb;	840	The methods (And data members) documented below can be called on extension
1048	}	841	objects, in addition to call methods documented for the <urxvt::term>
1049	}	842	class.
1050		843
1051	sub disable {	844	=over 4
1052	my ($self, @hook) = @_;
1053	my $pkg = $self->{_pkg};
1054		845
1055	for my $name (@hook) {	846	=item $urxvt_term = $self->{term}
1056	my $htype = $HOOKTYPE{uc $name};
1057	defined $htype
1058	or Carp::croak "unsupported hook type '$name'";
1059		847
1060	$self->set_should_invoke ($htype, -1)	848	Returns the C<urxvt::term> object associated with this instance of the
1061	if delete $self->{term}{_hook}[$htype]{$pkg};	849	extension. This member I<must not> be changed in any way.
1062	}	850
1063	}	851	=cut
1064		852
1065	our $AUTOLOAD;	853	our $AUTOLOAD;
1066		854
1067	sub AUTOLOAD {	855	sub AUTOLOAD {
1068	$AUTOLOAD =~ /:([^:]+)$/	856	$AUTOLOAD =~ /:([^:]+)$/
…		…
1081		869
1082	sub DESTROY {	870	sub DESTROY {
1083	# nop	871	# nop
1084	}	872	}
1085		873
1086	# urxvt::destroy_hook	874	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1087		875
1088	sub urxvt::destroy_hook::DESTROY {	876	sub urxvt::destroy_hook::DESTROY {
1089	${$_[0]}->();	877	${$_[0]}->();
1090	}	878	}
1091		879
1092	sub urxvt::destroy_hook(&) {	880	sub urxvt::destroy_hook(&) {
1093	bless \shift, urxvt::destroy_hook::	881	bless \shift, urxvt::destroy_hook::
1094	}	882	}
		883
		884	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		885
		886	Dynamically enable the given hooks (named without the C<on_> prefix) for
		887	this extension, replacing any hook previously installed via C<enable> in
		888	this extension.
		889
		890	This is useful when you want to overwrite time-critical hooks only
		891	temporarily.
		892
		893	To install additional callbacks for the same hook, you can use the C<on>
		894	method of the C<urxvt::term> class.
		895
		896	=item $self->disable ($hook_name[, $hook_name..])
		897
		898	Dynamically disable the given hooks.
		899
		900	=cut
		901
		902	sub enable {
		903	my ($self, %hook) = @_;
		904	my $pkg = $self->{_pkg};
		905
		906	while (my ($name, $cb) = each %hook) {
		907	my $htype = $HOOKTYPE{uc $name};
		908	defined $htype
		909	or Carp::croak "unsupported hook type '$name'";
		910
		911	$self->set_should_invoke ($htype, +1)
		912	unless exists $self->{term}{_hook}[$htype]{$pkg};
		913
		914	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		915	}
		916	}
		917
		918	sub disable {
		919	my ($self, @hook) = @_;
		920	my $pkg = $self->{_pkg};
		921
		922	for my $name (@hook) {
		923	my $htype = $HOOKTYPE{uc $name};
		924	defined $htype
		925	or Carp::croak "unsupported hook type '$name'";
		926
		927	$self->set_should_invoke ($htype, -1)
		928	if delete $self->{term}{_hook}[$htype]{$pkg};
		929	}
		930	}
		931
		932	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		933
		934	Similar to the C<enable> enable, but installs additional callbacks for
		935	the given hook(s) (that is, it doesn't replace existing callbacks), and
		936	returns a guard object. When the guard object is destroyed the callbacks
		937	are disabled again.
		938
		939	=cut
		940
		941	sub urxvt::extension::on_disable::DESTROY {
		942	my $disable = shift;
		943
		944	my $term = delete $disable->{""};
		945
		946	while (my ($htype, $id) = each %$disable) {
		947	delete $term->{_hook}[$htype]{$id};
		948	$term->set_should_invoke ($htype, -1);
		949	}
		950	}
		951
		952	sub on {
		953	my ($self, %hook) = @_;
		954
		955	my $term = $self->{term};
		956
		957	my %disable = ( "" => $term );
		958
		959	while (my ($name, $cb) = each %hook) {
		960	my $htype = $HOOKTYPE{uc $name};
		961	defined $htype
		962	or Carp::croak "unsupported hook type '$name'";
		963
		964	$term->set_should_invoke ($htype, +1);
		965	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		966	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		967	}
		968
		969	bless \%disable, "urxvt::extension::on_disable"
		970	}
		971
		972	=item $self->bind_action ($hotkey, $action)
		973
		974	=item $self->x_resource ($pattern)
		975
		976	=item $self->x_resource_boolean ($pattern)
		977
		978	These methods support an additional C<%> prefix for C<$action> or
		979	C<$pattern> when called on an extension object, compared to the
		980	C<urxvt::term> methods of the same name - see the description of these
		981	methods in the C<urxvt::term> class for details.
		982
		983	=cut
		984
		985	sub bind_action {
		986	my ($self, $hotkey, $action) = @_;
		987	$action =~ s/^%:/$_[0]{_name}:/;
		988	$self->{term}->bind_action ($hotkey, $action)
		989	}
		990
		991	sub x_resource {
		992	my ($self, $name) = @_;
		993	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		994	$self->{term}->x_resource ($name)
		995	}
		996
		997	sub x_resource_boolean {
		998	my ($self, $name) = @_;
		999	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1000	$self->{term}->x_resource_boolean ($name)
		1001	}
		1002
		1003	=back
		1004
		1005	=cut
1095		1006
1096	package urxvt::anyevent;	1007	package urxvt::anyevent;
1097		1008
1098	=head2 The C<urxvt::anyevent> Class	1009	=head2 The C<urxvt::anyevent> Class
1099		1010
1100	The sole purpose of this class is to deliver an interface to the	1011	The sole purpose of this class is to deliver an interface to the
1101	C<AnyEvent> module - any module using it will work inside urxvt without	1012	C<AnyEvent> module - any module using it will work inside urxvt without
1102	further programming. The only exception is that you cannot wait on	1013	further programming. The only exception is that you cannot wait on
1103	condition variables, but non-blocking condvar use is ok. What this means	1014	condition variables, but non-blocking condvar use is ok.
1104	is that you cannot use blocking APIs, but the non-blocking variant should
1105	work.
1106		1015
1107	=cut	1016	In practical terms this means is that you cannot use blocking APIs, but
		1017	the non-blocking variant should work.
1108		1018
		1019	=cut
		1020
1109	our $VERSION = '3.4';	1021	our $VERSION = '5.23';
1110		1022
1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1023	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1024	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113		1025
1114	sub timer {	1026	sub timer {
…		…
1116		1028
1117	my $cb = $arg{cb};	1029	my $cb = $arg{cb};
1118		1030
1119	urxvt::timer	1031	urxvt::timer
1120	->new	1032	->new
1121	->start (urxvt::NOW + $arg{after})	1033	->after ($arg{after}, $arg{interval})
1122	->cb (sub {	1034	->cb ($arg{interval} ? $cb : sub {
1123	$_[0]->stop; # need to cancel manually	1035	$_[0]->stop; # need to cancel manually
1124	$cb->();	1036	$cb->();
1125	})	1037	})
1126	}	1038	}
1127		1039
1128	sub io {	1040	sub io {
1129	my ($class, %arg) = @_;	1041	my ($class, %arg) = @_;
1130		1042
1131	my $cb = $arg{cb};	1043	my $cb = $arg{cb};
		1044	my $fd = fileno $arg{fh};
		1045	defined $fd or $fd = $arg{fh};
1132		1046
1133	bless [$arg{fh}, urxvt::iow	1047	bless [$arg{fh}, urxvt::iow
1134	->new	1048	->new
1135	->fd (fileno $arg{fh})	1049	->fd ($fd)
1136	->events (($arg{poll} =~ /r/ ? 1 : 0)	1050	->events (($arg{poll} =~ /r/ ? 1 : 0)
1137	| ($arg{poll} =~ /w/ ? 2 : 0))	1051	| ($arg{poll} =~ /w/ ? 2 : 0))
1138	->start	1052	->start
1139	->cb (sub {	1053	->cb ($cb)
1140	$cb->(($_[1] & 1 ? 'r' : '')
1141	. ($_[1] & 2 ? 'w' : ''));
1142	})],
1143	urxvt::anyevent::	1054	], urxvt::anyevent::
		1055	}
		1056
		1057	sub idle {
		1058	my ($class, %arg) = @_;
		1059
		1060	my $cb = $arg{cb};
		1061
		1062	urxvt::iw
		1063	->new
		1064	->start
		1065	->cb ($cb)
		1066	}
		1067
		1068	sub child {
		1069	my ($class, %arg) = @_;
		1070
		1071	my $cb = $arg{cb};
		1072
		1073	urxvt::pw
		1074	->new
		1075	->start ($arg{pid})
		1076	->cb (sub {
		1077	$_[0]->stop; # need to cancel manually
		1078	$cb->($_[0]->rpid, $_[0]->rstatus);
		1079	})
1144	}	1080	}
1145		1081
1146	sub DESTROY {	1082	sub DESTROY {
1147	$_[0][1]->stop;	1083	$_[0][1]->stop;
1148	}	1084	}
1149		1085
		1086	# only needed for AnyEvent < 6 compatibility
1150	sub one_event {	1087	sub one_event {
1151	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1088	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1152	}	1089	}
1153		1090
1154	package urxvt::term;	1091	package urxvt::term;
…		…
1169	urxvt::verbose 6, "register package $pkg to $self";	1106	urxvt::verbose 6, "register package $pkg to $self";
1170		1107
1171	@{"$pkg\::ISA"} = urxvt::term::extension::;	1108	@{"$pkg\::ISA"} = urxvt::term::extension::;
1172		1109
1173	my $proxy = bless {	1110	my $proxy = bless {
1174	_pkg => $pkg,	1111	_pkg => $pkg,
		1112	_name => ${"$pkg\::_NAME"}, # hackish
1175	argv => $argv,	1113	argv => $argv,
1176	}, $pkg;	1114	}, $pkg;
1177	Scalar::Util::weaken ($proxy->{term} = $self);	1115	Scalar::Util::weaken ($proxy->{term} = $self);
1178		1116
1179	$self->{_pkg}{$pkg} = $proxy;	1117	$self->{_pkg}{$pkg} = $proxy;
1180		1118
…		…
1183	$proxy->enable ($name => $ref);	1121	$proxy->enable ($name => $ref);
1184	}	1122	}
1185	}	1123	}
1186	}	1124	}
1187		1125
		1126	sub perl_libdirs {
		1127	map { split /:/ }
		1128	$_[0]->resource ("perl_lib"),
		1129	$ENV{URXVT_PERL_LIB},
		1130	"$ENV{HOME}/.urxvt/ext",
		1131	"$LIBDIR/perl"
		1132	}
		1133
		1134	# scan for available extensions and collect their metadata
		1135	sub scan_extensions {
		1136	my ($self) = @_;
		1137
		1138	return if exists $self->{meta};
		1139
		1140	my @urxvtdirs = perl_libdirs $self;
		1141	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1142
		1143	$self->{meta} = \my %meta;
		1144
		1145	# first gather extensions
		1146
		1147	my $gather = sub {
		1148	my ($dir, $core) = @_;
		1149
		1150	opendir my $fh, $dir
		1151	or return;
		1152
		1153	for my $ext (readdir $fh) {
		1154	$ext !~ /^\./
		1155	or next;
		1156
		1157	open my $fh, "<", "$dir/$ext"
		1158	or next;
		1159
		1160	-f $fh
		1161	or next;
		1162
		1163	$ext =~ s/\.uext$// or $core
		1164	or next;
		1165
		1166	my %ext = (dir => $dir);
		1167
		1168	while (<$fh>) {
		1169	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1170	my ($pattern, $type, $desc) = split /:/, $1;
		1171	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1172	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1173	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1174	} else {
		1175	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1176	}
		1177	} elsif (/^\s*(?:#|$)/) {
		1178	# skip other comments and empty lines
		1179	} else {
		1180	last; # stop parsing on first non-empty non-comment line
		1181	}
		1182	}
		1183
		1184	$meta{ext}{$ext} = \%ext;
		1185	}
		1186	};
		1187
		1188	# $gather->($_, 0) for @cpandirs;
		1189	$gather->($_, 1) for @urxvtdirs;
		1190
		1191	# and now merge resources
		1192
		1193	$meta{resource} = \my %resource;
		1194
		1195	while (my ($k, $v) = each %{ $meta{ext} }) {
		1196	#TODO: should check for extensions overriding each other
		1197	%resource = (%resource, %{ $v->{resource} });
		1198	}
		1199	}
		1200
1188	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1201	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1189		1202
1190	Creates a new terminal, very similar as if you had started it with system	1203	Creates a new terminal, very similar as if you had started it with system
1191	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1204	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1192	hash which defines the environment of the new terminal.	1205	hash which defines the environment of the new terminal.
…		…
1209	}	1222	}
1210		1223
1211	=item $term->destroy	1224	=item $term->destroy
1212		1225
1213	Destroy the terminal object (close the window, free resources	1226	Destroy the terminal object (close the window, free resources
1214	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1227	etc.). Please note that urxvt will not exit as long as any event
1215	watchers (timers, io watchers) are still active.	1228	watchers (timers, io watchers) are still active.
1216		1229
1217	=item $term->exec_async ($cmd[, @args])	1230	=item $term->exec_async ($cmd[, @args])
1218		1231
1219	Works like the combination of the C<fork>/C<exec> builtins, which executes	1232	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1246	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1259	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1247		1260
1248	Here is a likely non-exhaustive list of option names, please see the	1261	Here is a likely non-exhaustive list of option names, please see the
1249	source file F</src/optinc.h> to see the actual list:	1262	source file F</src/optinc.h> to see the actual list:
1250		1263
1251	borderLess console cursorBlink cursorUnderline hold iconic insecure	1264	borderLess buffered console cursorBlink cursorUnderline hold iconic
1252	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1265	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1253	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1266	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1254	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1267	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1255	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1268	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1256	transparent tripleclickwords utmpInhibit visualBell	1269	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1270	urgentOnBell utmpInhibit visualBell
1257		1271
1258	=item $value = $term->resource ($name[, $newval])	1272	=item $value = $term->resource ($name[, $newval])
1259		1273
1260	Returns the current resource value associated with a given name and	1274	Returns the current resource value associated with a given name and
1261	optionally sets a new value. Setting values is most useful in the C<init>	1275	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1274		1288
1275	Here is a likely non-exhaustive list of resource names, not all of which	1289	Here is a likely non-exhaustive list of resource names, not all of which
1276	are supported in every build, please see the source file F</src/rsinc.h>	1290	are supported in every build, please see the source file F</src/rsinc.h>
1277	to see the actual list:	1291	to see the actual list:
1278		1292
1279	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1293	answerbackstring backgroundPixmap backspace_key blurradius
1280	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1294	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1281	display_name embed ext_bwidth fade font geometry hold iconName	1295	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1282	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1296	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1297	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1283	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1298	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1284	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1299	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1285	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1300	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1286	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1301	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1287	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1302	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1288	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1303	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1289	secondaryScreen secondaryScroll shade term_name title	1304	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1290	transient_for transparent transparent_all tripleclickwords utmpInhibit	1305	term_name title transient_for transparent tripleclickwords urgentOnBell
1291	visualBell	1306	utmpInhibit visualBell
1292		1307
1293	=cut	1308	=cut
1294		1309
1295	sub resource($$;$) {	1310	sub resource($$;$) {
1296	my ($self, $name) = (shift, shift);	1311	my ($self, $name) = (shift, shift);
…		…
1303	Returns the X-Resource for the given pattern, excluding the program or	1318	Returns the X-Resource for the given pattern, excluding the program or
1304	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1319	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1305	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1320	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1306	resource with that pattern exists.	1321	resource with that pattern exists.
1307		1322
		1323	Extensions that define extra resources also need to call this method
		1324	to access their values.
		1325
		1326	If the method is called on an extension object (basically, from an
		1327	extension), then the special prefix C<%.> will be replaced by the name of
		1328	the extension and a dot, and the lone string C<%> will be replaced by the
		1329	extension name itself. This makes it possible to code extensions so you
		1330	can rename them and get a new set of resources without having to change
		1331	the actual code.
		1332
1308	This method should only be called during the C<on_start> hook, as there is	1333	This method should only be called during the C<on_start> hook, as there is
1309	only one resource database per display, and later invocations might return	1334	only one resource database per display, and later invocations might return
1310	the wrong resources.	1335	the wrong resources.
1311		1336
1312	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1337	=item $value = $term->x_resource_boolean ($pattern)
1313		1338
		1339	Like C<x_resource>, above, but interprets the string value as a boolean
		1340	and returns C<1> for true values, C<0> for false values and C<undef> if
		1341	the resource or option isn't specified.
		1342
		1343	You should always use this method to parse boolean resources.
		1344
		1345	=cut
		1346
		1347	sub x_resource_boolean {
		1348	my $res = &x_resource;
		1349
		1350	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1351	}
		1352
		1353	=item $action = $term->lookup_keysym ($keysym, $state)
		1354
		1355	Returns the action bound to key combination C<($keysym, $state)>,
		1356	if a binding for it exists, and C<undef> otherwise.
		1357
		1358	=item $success = $term->bind_action ($key, $action)
		1359
1314	Adds a keymap translation exactly as specified via a resource. See the	1360	Adds a key binding exactly as specified via a C<keysym> resource. See the
1315	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1361	C<keysym> resource in the urxvt(1) manpage.
		1362
		1363	To add default bindings for actions, an extension should call C<<
		1364	->bind_action >> in its C<init> hook for every such binding. Doing it
		1365	in the C<init> hook allows users to override or remove the binding
		1366	again.
		1367
		1368	Example: the C<searchable-scrollback> by default binds itself
		1369	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1370	$term->bind_action >>.
		1371
		1372	sub init {
		1373	my ($self) = @_;
		1374
		1375	$self->bind_action ("M-s" => "%:start");
		1376	}
1316		1377
1317	=item $rend = $term->rstyle ([$new_rstyle])	1378	=item $rend = $term->rstyle ([$new_rstyle])
1318		1379
1319	Return and optionally change the current rendition. Text that is output by	1380	Return and optionally change the current rendition. Text that is output by
1320	the terminal application will use this style.	1381	the terminal application will use this style.
…		…
1328		1389
1329	=item ($row, $col) = $term->selection_beg ([$row, $col])	1390	=item ($row, $col) = $term->selection_beg ([$row, $col])
1330		1391
1331	=item ($row, $col) = $term->selection_end ([$row, $col])	1392	=item ($row, $col) = $term->selection_end ([$row, $col])
1332		1393
1333	Return the current values of the selection mark, begin or end positions,	1394	Return the current values of the selection mark, begin or end positions.
1334	and optionally set them to new values.	1395
		1396	When arguments are given, then the selection coordinates are set to
		1397	C<$row> and C<$col>, and the selection screen is set to the current
		1398	screen.
		1399
		1400	=item $screen = $term->selection_screen ([$screen])
		1401
		1402	Returns the current selection screen, and then optionally sets it.
1335		1403
1336	=item $term->selection_make ($eventtime[, $rectangular])	1404	=item $term->selection_make ($eventtime[, $rectangular])
1337		1405
1338	Tries to make a selection as set by C<selection_beg> and	1406	Tries to make a selection as set by C<selection_beg> and
1339	C<selection_end>. If C<$rectangular> is true (default: false), a	1407	C<selection_end>. If C<$rectangular> is true (default: false), a
1340	rectangular selection will be made. This is the prefered function to make	1408	rectangular selection will be made. This is the preferred function to make
1341	a selection.	1409	a selection.
1342		1410
1343	=item $success = $term->selection_grab ($eventtime)	1411	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1344		1412
1345	Try to request the primary selection text from the server (for example, as	1413	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1414	true) selection from the server. The corresponding text can be set
1346	set by the next method). No visual feedback will be given. This function	1415	with the next method. No visual feedback will be given. This function
1347	is mostly useful from within C<on_sel_grab> hooks.	1416	is mostly useful from within C<on_sel_grab> hooks.
1348		1417
1349	=item $oldtext = $term->selection ([$newtext])	1418	=item $oldtext = $term->selection ([$newtext, $clipboard])
1350		1419
1351	Return the current selection text and optionally replace it by C<$newtext>.	1420	Return the current selection (clipboard if C<$clipboard> is true) text
		1421	and optionally replace it by C<$newtext>.
		1422
		1423	=item $term->selection_clear ([$clipboard])
		1424
		1425	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1352		1426
1353	=item $term->overlay_simple ($x, $y, $text)	1427	=item $term->overlay_simple ($x, $y, $text)
1354		1428
1355	Create a simple multi-line overlay box. See the next method for details.	1429	Create a simple multi-line overlay box. See the next method for details.
1356		1430
…		…
1465		1539
1466	=item $term->scr_add_lines ($string)	1540	=item $term->scr_add_lines ($string)
1467		1541
1468	Write the given text string to the screen, as if output by the application	1542	Write the given text string to the screen, as if output by the application
1469	running inside the terminal. It may not contain command sequences (escape	1543	running inside the terminal. It may not contain command sequences (escape
1470	codes), but is free to use line feeds, carriage returns and tabs. The	1544	codes - see C<cmd_parse> for that), but is free to use line feeds,
1471	string is a normal text string, not in locale-dependent encoding.	1545	carriage returns and tabs. The string is a normal text string, not in
		1546	locale-dependent encoding.
1472		1547
1473	Normally its not a good idea to use this function, as programs might be	1548	Normally its not a good idea to use this function, as programs might be
1474	confused by changes in cursor position or scrolling. Its useful inside a	1549	confused by changes in cursor position or scrolling. Its useful inside a
1475	C<on_add_lines> hook, though.	1550	C<on_add_lines> hook, though.
1476		1551
…		…
1484	locale-specific encoding of the terminal and can contain command sequences	1559	locale-specific encoding of the terminal and can contain command sequences
1485	(escape codes) that will be interpreted.	1560	(escape codes) that will be interpreted.
1486		1561
1487	=item $term->tt_write ($octets)	1562	=item $term->tt_write ($octets)
1488		1563
1489	Write the octets given in C<$data> to the tty (i.e. as program input). To	1564	Write the octets given in C<$octets> to the tty (i.e. as user input
		1565	to the program, see C<cmd_parse> for the opposite direction). To pass
1490	pass characters instead of octets, you should convert your strings first	1566	characters instead of octets, you should convert your strings first to the
1491	to the locale-specific encoding using C<< $term->locale_encode >>.	1567	locale-specific encoding using C<< $term->locale_encode >>.
		1568
		1569	=item $term->tt_write_user_input ($octets)
		1570
		1571	Like C<tt_write>, but should be used when writing strings in response to
		1572	the user pressing a key, to invoke the additional actions requested by
		1573	the user for that case (C<tt_write> doesn't do that).
		1574
		1575	The typical use case would be inside C<on_action> hooks.
		1576
		1577	=item $term->tt_paste ($octets)
		1578
		1579	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1580	CR and bracketing the data with control sequences if bracketed paste mode
		1581	is set.
1492		1582
1493	=item $old_events = $term->pty_ev_events ([$new_events])	1583	=item $old_events = $term->pty_ev_events ([$new_events])
1494		1584
1495	Replaces the event mask of the pty watcher by the given event mask. Can	1585	Replaces the event mask of the pty watcher by the given event mask. Can
1496	be used to suppress input and output handling to the pty/tty. See the	1586	be used to suppress input and output handling to the pty/tty. See the
…		…
1515	Adds the specified events to the vt event mask. Useful e.g. when you want	1605	Adds the specified events to the vt event mask. Useful e.g. when you want
1516	to receive pointer events all the times:	1606	to receive pointer events all the times:
1517		1607
1518	$term->vt_emask_add (urxvt::PointerMotionMask);	1608	$term->vt_emask_add (urxvt::PointerMotionMask);
1519		1609
		1610	=item $term->set_urgency ($set)
		1611
		1612	Enable/disable the urgency hint on the toplevel window.
		1613
1520	=item $term->focus_in	1614	=item $term->focus_in
1521		1615
1522	=item $term->focus_out	1616	=item $term->focus_out
1523		1617
1524	=item $term->key_press ($state, $keycode[, $time])	1618	=item $term->key_press ($state, $keycode[, $time])
1525		1619
1526	=item $term->key_release ($state, $keycode[, $time])	1620	=item $term->key_release ($state, $keycode[, $time])
1527		1621
1528	Deliver various fake events to to terminal.	1622	Deliver various fake events to to terminal.
1529		1623
1530	=item $window_width = $term->width	1624	=item $window_width = $term->width ([$new_value])
1531		1625
1532	=item $window_height = $term->height	1626	=item $window_height = $term->height ([$new_value])
1533		1627
1534	=item $font_width = $term->fwidth	1628	=item $font_width = $term->fwidth ([$new_value])
1535		1629
1536	=item $font_height = $term->fheight	1630	=item $font_height = $term->fheight ([$new_value])
1537		1631
1538	=item $font_ascent = $term->fbase	1632	=item $font_ascent = $term->fbase ([$new_value])
1539		1633
1540	=item $terminal_rows = $term->nrow	1634	=item $terminal_rows = $term->nrow ([$new_value])
1541		1635
1542	=item $terminal_columns = $term->ncol	1636	=item $terminal_columns = $term->ncol ([$new_value])
1543		1637
1544	=item $has_focus = $term->focus	1638	=item $has_focus = $term->focus ([$new_value])
1545		1639
1546	=item $is_mapped = $term->mapped	1640	=item $is_mapped = $term->mapped ([$new_value])
1547		1641
1548	=item $max_scrollback = $term->saveLines	1642	=item $max_scrollback = $term->saveLines ([$new_value])
1549		1643
1550	=item $nrow_plus_saveLines = $term->total_rows	1644	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1551		1645
1552	=item $topmost_scrollback_row = $term->top_row	1646	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1553		1647
1554	Return various integers describing terminal characteristics.	1648	Return various integers describing terminal characteristics. If an
		1649	argument is given, changes the value and returns the previous one.
1555		1650
1556	=item $x_display = $term->display_id	1651	=item $x_display = $term->display_id
1557		1652
1558	Return the DISPLAY used by rxvt-unicode.	1653	Return the DISPLAY used by rxvt-unicode.
1559		1654
…		…
1609	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1704	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1610	compare the on-screen display with its stored representation. If they	1705	compare the on-screen display with its stored representation. If they
1611	differ, it redraws the differences.	1706	differ, it redraws the differences.
1612		1707
1613	Used after changing terminal contents to display them.	1708	Used after changing terminal contents to display them.
		1709
		1710	=item $term->refresh_check
		1711
		1712	Checks if a refresh has been requested and, if so, schedules one.
1614		1713
1615	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1714	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1616		1715
1617	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1716	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1618	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1717	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1720	}	1819	}
1721		1820
1722	sub urxvt::line::t {	1821	sub urxvt::line::t {
1723	my ($self) = @_;	1822	my ($self) = @_;
1724		1823
1725	if (@_ > 1)	1824	if (@_ > 1) {
1726	{
1727	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1825	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1728	for $self->{beg} .. $self->{end};	1826	for $self->{beg} .. $self->{end};
1729	}	1827	}
1730		1828
1731	defined wantarray &&	1829	defined wantarray &&
1732	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1830	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1733	0, $self->{len}	1831	0, $self->{len}
1734	}	1832	}
1735		1833
1736	sub urxvt::line::r {	1834	sub urxvt::line::r {
1737	my ($self) = @_;	1835	my ($self) = @_;
1738		1836
1739	if (@_ > 1)	1837	if (@_ > 1) {
1740	{
1741	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1838	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1742	for $self->{beg} .. $self->{end};	1839	for $self->{beg} .. $self->{end};
1743	}	1840	}
1744		1841
1745	if (defined wantarray) {	1842	if (defined wantarray) {
1746	my $rend = [	1843	my $rend = [
1747	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1844	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1748	];	1845	];
…		…
1810	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1907	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1811	recent grab.	1908	recent grab.
1812		1909
1813	=item $term->ungrab	1910	=item $term->ungrab
1814		1911
1815	Calls XUngrab for the most recent grab. Is called automatically on	1912	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1816	evaluation errors, as it is better to lose the grab in the error case as	1913	evaluation errors, as it is better to lose the grab in the error case as
1817	the session.	1914	the session.
1818		1915
1819	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1916	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820		1917
…		…
1840		1937
1841	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1938	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1842		1939
1843	=item $term->XChangeInput ($window, $add_events[, $del_events])	1940	=item $term->XChangeInput ($window, $add_events[, $del_events])
1844		1941
		1942	=item $keysym = $term->XStringToKeysym ($string)
		1943
		1944	=item $string = $term->XKeysymToString ($keysym)
		1945
1845	Various X or X-related functions. The C<$term> object only serves as	1946	Various X or X-related functions. The C<$term> object only serves as
1846	the source of the display, otherwise those functions map more-or-less	1947	the source of the display, otherwise those functions map more-or-less
1847	directory onto the X functions of the same name.	1948	directly onto the X functions of the same name.
1848		1949
1849	=back	1950	=back
1850		1951
1851	=cut	1952	=cut
1852		1953
…		…
2009		2110
2010	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2111	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2011		2112
2012	Set the callback to be called when the timer triggers.	2113	Set the callback to be called when the timer triggers.
2013		2114
2014	=item $tstamp = $timer->at
2015
2016	Return the time this watcher will fire next.
2017
2018	=item $timer = $timer->set ($tstamp)	2115	=item $timer = $timer->set ($tstamp[, $interval])
2019		2116
2020	Set the time the event is generated to $tstamp.	2117	Set the time the event is generated to $tstamp (and optionally specifies a
		2118	new $interval).
2021		2119
2022	=item $timer = $timer->interval ($interval)	2120	=item $timer = $timer->interval ($interval)
2023		2121
2024	Normally (and when C<$interval> is C<0>), the timer will automatically	2122	By default (and when C<$interval> is C<0>), the timer will automatically
2025	stop after it has fired once. If C<$interval> is non-zero, then the timer	2123	stop after it has fired once. If C<$interval> is non-zero, then the timer
2026	is automatically rescheduled at the given intervals.	2124	is automatically rescheduled at the given intervals.
2027		2125
2028	=item $timer = $timer->start	2126	=item $timer = $timer->start
2029		2127
2030	Start the timer.	2128	Start the timer.
2031		2129
2032	=item $timer = $timer->start ($tstamp)	2130	=item $timer = $timer->start ($tstamp[, $interval])
2033		2131
2034	Set the event trigger time to C<$tstamp> and start the timer.	2132	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2133	also replaces the interval.
2035		2134
2036	=item $timer = $timer->after ($delay)	2135	=item $timer = $timer->after ($delay[, $interval])
2037		2136
2038	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2137	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2039		2138
2040	=item $timer = $timer->stop	2139	=item $timer = $timer->stop
2041		2140
…		…
2172		2271
2173	=back	2272	=back
2174		2273
2175	=head1 AUTHOR	2274	=head1 AUTHOR
2176		2275
2177	Marc Lehmann <pcg@goof.com>	2276	Marc Lehmann <schmorp@schmorp.de>
2178	http://software.schmorp.de/pkg/rxvt-unicode	2277	http://software.schmorp.de/pkg/rxvt-unicode
2179		2278
2180	=cut	2279	=cut
2181		2280
2182	1	2281	1

Diff Legend

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