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.159 by root, Sun Nov 11 04:08:00 2007 UTC vs.
Revision 1.234 by root, Sat May 17 15:25:04 2014 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,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
46		47
47	=over 4	48	Extensions that add command line parameters or resources on their own are
48		49	loaded automatically when used.
49	=item selection (enabled by default)
50
51	(More) intelligent selection. This extension tries to be more intelligent
52	when the user extends selections (double-click and further clicks). Right
53	now, it tries to select words, urls and complete shell-quoted
54	arguments, which is very convenient, too, if your F<ls> supports
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 (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	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 automove-background
309
310	This is basically a very small extension that dynamically changes the
311	background pixmap offset to the window position, in effect creating the
312	same effect as pseudo transparency with a custom pixmap. No scaling is
313	supported in this mode. Example:
314
315	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
316
317	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
318	shows how this extension can be used to implement an automatically blurred
319	transparent background.
320
321	=item block-graphics-to-ascii
322
323	A not very useful example of filtering all text output to the terminal
324	by replacing all line-drawing characters (U+2500 .. U+259F) by a
325	similar-looking ascii character.
326
327	=item digital-clock
328
329	Displays a digital clock using the built-in overlay.
330
331	=item remote-clipboard
332
333	Somewhat of a misnomer, this extension adds two menu entries to the
334	selection popup that allows one to run external commands to store the
335	selection somewhere and fetch it again.
336
337	We use it to implement a "distributed selection mechanism", which just
338	means that one command uploads the file to a remote server, and another
339	reads it.
340
341	The commands can be set using the C<URxvt.remote-selection.store> and
342	C<URxvt.remote-selection.fetch> resources. The first should read the
343	selection to store from STDIN (always in UTF-8), the second should provide
344	the selection data on STDOUT (also in UTF-8).
345
346	The defaults (which are likely useless to you) use rsh and cat:
347
348	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
349	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
350
351	=item selection-pastebin
352
353	This is a little rarely useful extension that Uploads the selection as
354	textfile to a remote site (or does other things). (The implementation is
355	not currently secure for use in a multiuser environment as it writes to
356	F</tmp> directly.).
357
358	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
359	i.e.
360
361	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
362
363	Pressing this combination runs a command with C<%> replaced by the name of
364	the textfile. This command can be set via a resource:
365
366	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
367
368	And the default is likely not useful to anybody but the few people around
369	here :)
370
371	The name of the textfile is the hex encoded md5 sum of the selection, so
372	the same content should lead to the same filename.
373
374	After a successful upload the selection will be replaced by the text given
375	in the C<selection-pastebin-url> resource (again, the % is the placeholder
376	for the filename):
377
378	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
379
380	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
381	the double C</> characters as comment start. Use C<\057\057> instead,
382	which works regardless of wether xrdb is used to parse the resource file
383	or not.
384
385	=item example-refresh-hooks
386
387	Displays a very simple digital clock in the upper right corner of the
388	window. Illustrates overwriting the refresh callbacks to create your own
389	overlays or changes.
390
391	=back
392		50
393	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
394		52
395	=head2 General API Considerations	53	=head2 General API Considerations
396		54
…		…
410		68
411	=over 4	69	=over 4
412		70
413	=item $text	71	=item $text
414		72
415	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
416	always represents one screen cell. See L<ROW_t> for a discussion of this format.	74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
417		75
418	=item $string	76	=item $string
419		77
420	A perl text string, with an emphasis on I<text>. It can store all unicode	78	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
424	=item $octets	82	=item $octets
425		83
426	Either binary data or - more common - a text string encoded in a	84	Either binary data or - more common - a text string encoded in a
427	locale-specific way.	85	locale-specific way.
428		86
		87	=item $keysym
		88
		89	an integer that is a valid X11 keysym code. You can convert a string
		90	into a keysym and viceversa by using C<XStringToKeysym> and
		91	C<XKeysymToString>.
		92
429	=back	93	=back
430		94
431	=head2 Extension Objects	95	=head2 Extension Objects
432		96
433	Every perl extension is a perl class. A separate perl object is created	97	Every perl extension is a perl class. A separate perl object is created
434	for each terminal, and each terminal has its own set of extenion objects,	98	for each terminal, and each terminal has its own set of extension objects,
435	which are passed as the first parameter to hooks. So extensions can use	99	which are passed as the first parameter to hooks. So extensions can use
436	their C<$self> object without having to think about clashes with other	100	their C<$self> object without having to think about clashes with other
437	extensions or other terminals, with the exception of methods and members	101	extensions or other terminals, with the exception of methods and members
438	that begin with an underscore character C<_>: these are reserved for	102	that begin with an underscore character C<_>: these are reserved for
439	internal use.	103	internal use.
440		104
441	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
442	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
443		107
444	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
445		109	the C<urxvt::extension> section below.
446	=over 4
447
448	=item $urxvt_term = $self->{term}
449
450	Returns the C<urxvt::term> object associated with this instance of the
451	extension. This member I<must not> be changed in any way.
452
453	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
454
455	Dynamically enable the given hooks (named without the C<on_> prefix) for
456	this extension, replacing any previous hook. This is useful when you want
457	to overwrite time-critical hooks only temporarily.
458
459	=item $self->disable ($hook_name[, $hook_name..])
460
461	Dynamically disable the given hooks.
462
463	=back
464		110
465	=head2 Hooks	111	=head2 Hooks
466		112
467	The following subroutines can be declared in extension files, and will be	113	The following subroutines can be declared in extension files, and will be
468	called whenever the relevant event happens.	114	called whenever the relevant event happens.
…		…
554		200
555	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
556	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
557	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
558		204
559	=item on_osc_seq $term, $op, $args	205	=item on_osc_seq $term, $op, $args, $resp
560		206
561	Called on every OSC sequence and can be used to suppress it or modify its	207	Called on every OSC sequence and can be used to suppress it or modify its
562	behaviour. The default should be to return an empty list. A true value	208	behaviour. The default should be to return an empty list. A true value
563	suppresses execution of the request completely. Make sure you don't get	209	suppresses execution of the request completely. Make sure you don't get
564	confused by recursive invocations when you output an osc sequence within	210	confused by recursive invocations when you output an OSC sequence within
565	this callback.	211	this callback.
566		212
567	C<on_osc_seq_perl> should be used for new behaviour.	213	C<on_osc_seq_perl> should be used for new behaviour.
568		214
569	=item on_osc_seq_perl $term, $string	215	=item on_osc_seq_perl $term, $args, $resp
570		216
571	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
572	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
573	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
574	string should start with the extension name and a colon, to distinguish	220	string should start with the extension name (sans -osc) and a semicolon,
575	it from commands for other extensions, and this might be enforced in the	221	to distinguish it from commands for other extensions, and this might be
576	future.	222	enforced in the future.
		223
		224	For example, C<overlay-osc> uses this:
		225
		226	sub on_osc_seq_perl {
		227	my ($self, $osc, $resp) = @_;
		228
		229	return unless $osc =~ s/^overlay;//;
		230
		231	... process remaining $osc string
		232	}
577		233
578	Be careful not ever to trust (in a security sense) the data you receive,	234	Be careful not ever to trust (in a security sense) the data you receive,
579	as its source can not easily be controlled (e-mail content, messages from	235	as its source can not easily be controlled (e-mail content, messages from
580	other users on the same system etc.).	236	other users on the same system etc.).
		237
		238	For responses, C<$resp> contains the end-of-args separator used by the
		239	sender.
581		240
582	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
583		242
584	Called whenever text is about to be output, with the text as argument. You	243	Called whenever text is about to be output, with the text as argument. You
585	can filter/change and output the text yourself by returning a true value	244	can filter/change and output the text yourself by returning a true value
…		…
590	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
591		250
592	Called whenever some data is written to the tty/pty and can be used to	251	Called whenever some data is written to the tty/pty and can be used to
593	suppress or filter tty input.	252	suppress or filter tty input.
594		253
		254	=item on_tt_paste $term, $octets
		255
		256	Called whenever text is about to be pasted, with the text as argument. You
		257	can filter/change and paste the text yourself by returning a true value
		258	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		259	locale-encoded.
		260
595	=item on_line_update $term, $row	261	=item on_line_update $term, $row
596		262
597	Called whenever a line was updated or changed. Can be used to filter	263	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	264	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,	265	that are being shown will be filtered, and, due to performance reasons,
…		…
606	later with the already-modified line (e.g. if unrelated parts change), so	272	later with the already-modified line (e.g. if unrelated parts change), so
607	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
608		274
609	=item on_refresh_begin $term	275	=item on_refresh_begin $term
610		276
611	Called just before the screen gets redrawn. Can be used for overlay	277	Called just before the screen gets redrawn. Can be used for overlay or
612	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
613	restoring them in refresh_end. The built-in overlay and selection display	279	restoring them in refresh_end. The built-in overlay and selection display
614	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
615		281
616	=item on_refresh_end $term	282	=item on_refresh_end $term
617		283
618	Called just after the screen gets redrawn. See C<on_refresh_begin>.	284	Called just after the screen gets redrawn. See C<on_refresh_begin>.
619		285
620	=item on_user_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
621		287
622	Called whenever a user-configured event is being activated (e.g. via	288	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>	289	a C<perl:string> action bound to a key, see description of the B<keysym>
624	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
625		291
626	The event is simply the action string. This interface is assumed to change	292	The event is simply the action string. This interface is going away in
627	slightly in the future.	293	preference to the C<< ->register_keysym_action >> method.
628		294
629	=item on_resize_all_windows $tern, $new_width, $new_height	295	=item on_resize_all_windows $term, $new_width, $new_height
630		296
631	Called just after the new window size has been calculated, but before	297	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	298	windows are actually being resized or hints are being set. If this hook
633	returns TRUE, setting of the window hints is being skipped.	299	returns a true value, setting of the window hints is being skipped.
634		300
635	=item on_x_event $term, $event	301	=item on_x_event $term, $event
636		302
637	Called on every X event received on the vt window (and possibly other	303	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	304	windows). Should only be used as a last resort. Most event structure
…		…
668		334
669	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
670		336
671	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
672		338
673	Called whenever the corresponding X event is received for the terminal If	339	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.	340	the hook returns true, then the event will be ignored by rxvt-unicode.
675		341
676	The event is a hash with most values as named by Xlib (see the XEvent	342	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	343	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.	344	(real, not screen-based) row and column under the mouse cursor.
679		345
680	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
681	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
682		348
683	subwindow.
684
685	=item on_client_message $term, $event	349	=item on_client_message $term, $event
686		350
687	=item on_wm_protocols $term, $event	351	=item on_wm_protocols $term, $event
688		352
689	=item on_wm_delete_window $term, $event	353	=item on_wm_delete_window $term, $event
690		354
691	Called when various types of ClientMessage events are received (all with	355	Called when various types of ClientMessage events are received (all with
692	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	356	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
693		357
		358	=item on_bell $term
		359
		360	Called on receipt of a bell character.
		361
694	=back	362	=back
695		363
696	=cut	364	=cut
697		365
698	package urxvt;	366	package urxvt;
699		367
700	use utf8;	368	use utf8;
701	use strict;	369	use strict 'vars';
702	use Carp ();	370	use Carp ();
703	use Scalar::Util ();	371	use Scalar::Util ();
704	use List::Util ();	372	use List::Util ();
705		373
706	our $VERSION = 1;	374	our $VERSION = 1;
707	our $TERM;	375	our $TERM;
708	our @TERM_INIT;	376	our @TERM_INIT; # should go, prevents async I/O etc.
709	our @TERM_EXT;	377	our @TERM_EXT; # should go, prevents async I/O etc.
710	our @HOOKNAME;	378	our @HOOKNAME;
711	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
712	our %OPTION;	380	our %OPTION;
713		381
714	our $LIBDIR;	382	our $LIBDIR;
…		…
762		430
763	=over 4	431	=over 4
764		432
765	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
766		434
767	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
768	costs! The only time this is acceptable is when the terminal process	436	include a trailing newline). Avoid at all costs! The only time this
769	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
770		439
771	=item urxvt::warn $string	440	=item urxvt::warn $string
772		441
773	Calls C<rxvt_warn> with the given string which should not include a	442	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	443	newline. The module also overwrites the C<warn> builtin with a function
775	that calls this function.	444	that calls this function.
776		445
777	Using this function has the advantage that its output ends up in the	446	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.	447	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
782	=item @terms = urxvt::termlist	451	=item @terms = urxvt::termlist
783		452
784	Returns all urxvt::term objects that exist in this process, regardless of	453	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	454	whether they are started, being destroyed etc., so be careful. Only term
786	objects that have perl extensions attached will be returned (because there	455	objects that have perl extensions attached will be returned (because there
787	is no urxvt::term objet associated with others).	456	is no urxvt::term object associated with others).
788		457
789	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
790		459
791	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
792		461
…		…
835		504
836	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
837		506
838	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
839		508
840	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	509	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		510	urxvt::RS_RVid, urxvt::RS_Uline
841		511
842	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
843	underline, respectively. To enable such a style, just logically OR it into	513	underline, respectively. To enable such a style, just logically OR it into
844	the bitset.	514	the bitset.
845		515
…		…
882	};	552	};
883	}	553	}
884		554
885	no warnings 'utf8';	555	no warnings 'utf8';
886		556
		557	sub parse_resource {
		558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		559
		560	$name =~ y/-/./ if $isarg;
		561
		562	$term->scan_extensions;
		563
		564	my $r = $term->{meta}{resource};
		565	keys %$r; # reset iterator
		566	while (my ($pattern, $v) = each %$r) {
		567	if (
		568	$pattern =~ /\.$/
		569	? $pattern eq substr $name, 0, length $pattern
		570	: $pattern eq $name
		571	) {
		572	$name = "$urxvt::RESCLASS.$name";
		573
		574	push @{ $term->{perl_ext_3} }, $v->[0];
		575
		576	if ($v->[1] eq "boolean") {
		577	$term->put_option_db ($name, $flag ? "true" : "false");
		578	return 1;
		579	} else {
		580	$term->put_option_db ($name, $value);
		581	return 1 + 2;
		582	}
		583	}
		584	}
		585
		586	0
		587	}
		588
		589	sub usage {
		590	my ($term, $usage_type) = @_;
		591
		592	$term->scan_extensions;
		593
		594	my $r = $term->{meta}{resource};
		595
		596	for my $pattern (sort keys %$r) {
		597	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		598
		599	$desc .= " (-pe $ext)";
		600
		601	if ($usage_type == 1) {
		602	$pattern =~ y/./-/;
		603	$pattern =~ s/-$/-.../g;
		604
		605	if ($type eq "boolean") {
		606	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		607	} else {
		608	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		609	}
		610	} else {
		611	$pattern =~ s/\.$/.*/g;
		612	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		613	}
		614	}
		615	}
		616
887	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
888		618
889	sub verbose {	619	sub verbose {
890	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
891	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
…		…
903	$pkg =~ s/[^[:word:]]/_/g;	633	$pkg =~ s/[^[:word:]]/_/g;
904	$pkg = "urxvt::ext::$pkg";	634	$pkg = "urxvt::ext::$pkg";
905		635
906	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
907		637
		638	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		639
908	open my $fh, "<:raw", $path	640	open my $fh, "<:raw", $path
909	or die "$path: $!";	641	or die "$path: $!";
910		642
911	my $source =	643	my $source =
912	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	644	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
913	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
914	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
915	. "\n};\n1";	647	. "\n};\n1";
916		648
917	eval $source	649	eval $source
…		…
926	# called by the rxvt core	658	# called by the rxvt core
927	sub invoke {	659	sub invoke {
928	local $TERM = shift;	660	local $TERM = shift;
929	my $htype = shift;	661	my $htype = shift;
930		662
931	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = $TERM->perl_libdirs;
		665
		666	$TERM->scan_extensions;
933		667
934	my %ext_arg;	668	my %ext_arg;
935		669
936	{	670	{
937	my @init = @TERM_INIT;	671	my @init = @TERM_INIT;
…		…
940	my @pkg = @TERM_EXT;	674	my @pkg = @TERM_EXT;
941	@TERM_EXT = ();	675	@TERM_EXT = ();
942	$TERM->register_package ($_) for @pkg;	676	$TERM->register_package ($_) for @pkg;
943	}	677	}
944		678
		679	for (
		680	@{ delete $TERM->{perl_ext_3} },
945	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	681	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		682	) {
946	if ($_ eq "default") {	683	if ($_ eq "default") {
947	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	684	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
948	} elsif (/^-(.*)$/) {	685	} elsif (/^-(.*)$/) {
949	delete $ext_arg{$1};	686	delete $ext_arg{$1};
950	} elsif (/^([^<]+)<(.*)>$/) {	687	} elsif (/^([^<]+)<(.*)>$/) {
…		…
972		709
973	if (my $cb = $TERM->{_hook}[$htype]) {	710	if (my $cb = $TERM->{_hook}[$htype]) {
974	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	711	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
975	if $verbosity >= 10;	712	if $verbosity >= 10;
976		713
		714	if ($htype == HOOK_ACTION) {
		715	# this hook is only sent to the extension with the name
		716	# matching the first arg
		717	my $pkg = shift;
		718	$pkg =~ y/-/_/;
		719	$pkg = "urxvt::ext::$pkg";
		720
		721	$cb = $cb->{$pkg}
		722	or return undef; #TODO: maybe warn user?
		723
		724	$cb = { $pkg => $cb };
		725	}
		726
977	for my $pkg (keys %$cb) {	727	for my $pkg (keys %$cb) {
978	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	728	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
979	$retval ||= $retval_;	729	$retval ||= $retval_;
980		730
981	if ($@) {	731	if ($@) {
982	$TERM->ungrab; # better to lose the grab than the session	732	$TERM->ungrab; # better to lose the grab than the session
983	warn $@;	733	warn $@;
…		…
986		736
987	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	737	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
988	if $verbosity >= 11;	738	if $verbosity >= 11;
989	}	739	}
990		740
991	if ($htype == 1) { # DESTROY	741	if ($htype == HOOK_DESTROY) {
992	# clear package objects	742	# clear package objects
993	%$_ = () for values %{ $TERM->{_pkg} };	743	%$_ = () for values %{ $TERM->{_pkg} };
994		744
995	# clear package	745	# clear package
996	%$TERM = ();	746	%$TERM = ();
…		…
1026	}	776	}
1027	}	777	}
1028	($mask, @color{qw(fg bg)}, \@failed)	778	($mask, @color{qw(fg bg)}, \@failed)
1029	}	779	}
1030		780
1031	# urxvt::term::extension
1032
1033	package urxvt::term::extension;	781	package urxvt::term::extension;
1034		782
1035	sub enable {	783	=head2 The C<urxvt::term::extension> class
1036	my ($self, %hook) = @_;
1037	my $pkg = $self->{_pkg};
1038		784
1039	while (my ($name, $cb) = each %hook) {	785	Each extension attached to a terminal object is represented by
1040	my $htype = $HOOKTYPE{uc $name};	786	a C<urxvt::term::extension> object.
1041	defined $htype
1042	or Carp::croak "unsupported hook type '$name'";
1043		787
1044	$self->set_should_invoke ($htype, +1)	788	You can use these objects, which are passed to all callbacks to store any
1045	unless exists $self->{term}{_hook}[$htype]{$pkg};	789	state related to the terminal and extension instance.
1046		790
1047	$self->{term}{_hook}[$htype]{$pkg} = $cb;	791	The methods (And data members) documented below can be called on extension
1048	}	792	objects, in addition to call methods documented for the <urxvt::term>
1049	}	793	class.
1050		794
1051	sub disable {	795	=over 4
1052	my ($self, @hook) = @_;
1053	my $pkg = $self->{_pkg};
1054		796
1055	for my $name (@hook) {	797	=item $urxvt_term = $self->{term}
1056	my $htype = $HOOKTYPE{uc $name};
1057	defined $htype
1058	or Carp::croak "unsupported hook type '$name'";
1059		798
1060	$self->set_should_invoke ($htype, -1)	799	Returns the C<urxvt::term> object associated with this instance of the
1061	if delete $self->{term}{_hook}[$htype]{$pkg};	800	extension. This member I<must not> be changed in any way.
1062	}	801
1063	}	802	=cut
1064		803
1065	our $AUTOLOAD;	804	our $AUTOLOAD;
1066		805
1067	sub AUTOLOAD {	806	sub AUTOLOAD {
1068	$AUTOLOAD =~ /:([^:]+)$/	807	$AUTOLOAD =~ /:([^:]+)$/
…		…
1081		820
1082	sub DESTROY {	821	sub DESTROY {
1083	# nop	822	# nop
1084	}	823	}
1085		824
1086	# urxvt::destroy_hook	825	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1087		826
1088	sub urxvt::destroy_hook::DESTROY {	827	sub urxvt::destroy_hook::DESTROY {
1089	${$_[0]}->();	828	${$_[0]}->();
1090	}	829	}
1091		830
1092	sub urxvt::destroy_hook(&) {	831	sub urxvt::destroy_hook(&) {
1093	bless \shift, urxvt::destroy_hook::	832	bless \shift, urxvt::destroy_hook::
1094	}	833	}
		834
		835	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		836
		837	Dynamically enable the given hooks (named without the C<on_> prefix) for
		838	this extension, replacing any hook previously installed via C<enable> in
		839	this extension.
		840
		841	This is useful when you want to overwrite time-critical hooks only
		842	temporarily.
		843
		844	To install additional callbacks for the same hook, you can use the C<on>
		845	method of the C<urxvt::term> class.
		846
		847	=item $self->disable ($hook_name[, $hook_name..])
		848
		849	Dynamically disable the given hooks.
		850
		851	=cut
		852
		853	sub enable {
		854	my ($self, %hook) = @_;
		855	my $pkg = $self->{_pkg};
		856
		857	while (my ($name, $cb) = each %hook) {
		858	my $htype = $HOOKTYPE{uc $name};
		859	defined $htype
		860	or Carp::croak "unsupported hook type '$name'";
		861
		862	$self->set_should_invoke ($htype, +1)
		863	unless exists $self->{term}{_hook}[$htype]{$pkg};
		864
		865	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		866	}
		867	}
		868
		869	sub disable {
		870	my ($self, @hook) = @_;
		871	my $pkg = $self->{_pkg};
		872
		873	for my $name (@hook) {
		874	my $htype = $HOOKTYPE{uc $name};
		875	defined $htype
		876	or Carp::croak "unsupported hook type '$name'";
		877
		878	$self->set_should_invoke ($htype, -1)
		879	if delete $self->{term}{_hook}[$htype]{$pkg};
		880	}
		881	}
		882
		883	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		884
		885	Similar to the C<enable> enable, but installs additional callbacks for
		886	the given hook(s) (that is, it doesn't replace existing callbacks), and
		887	returns a guard object. When the guard object is destroyed the callbacks
		888	are disabled again.
		889
		890	=cut
		891
		892	sub urxvt::extension::on_disable::DESTROY {
		893	my $disable = shift;
		894
		895	my $term = delete $disable->{""};
		896
		897	while (my ($htype, $id) = each %$disable) {
		898	delete $term->{_hook}[$htype]{$id};
		899	$term->set_should_invoke ($htype, -1);
		900	}
		901	}
		902
		903	sub on {
		904	my ($self, %hook) = @_;
		905
		906	my $term = $self->{term};
		907
		908	my %disable = ( "" => $term );
		909
		910	while (my ($name, $cb) = each %hook) {
		911	my $htype = $HOOKTYPE{uc $name};
		912	defined $htype
		913	or Carp::croak "unsupported hook type '$name'";
		914
		915	$term->set_should_invoke ($htype, +1);
		916	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		917	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		918	}
		919
		920	bless \%disable, "urxvt::extension::on_disable"
		921	}
		922
		923	=item $self->x_resource ($pattern)
		924
		925	=item $self->x_resource_boolean ($pattern)
		926
		927	These methods support an additional C<%> prefix when called on an
		928	extension object - see the description of these methods in the
		929	C<urxvt::term> class for details.
		930
		931	=cut
		932
		933	sub x_resource {
		934	my ($self, $name) = @_;
		935	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		936	$self->{term}->x_resource ($name)
		937	}
		938
		939	sub x_resource_boolean {
		940	my ($self, $name) = @_;
		941	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		942	$self->{term}->x_resource_boolean ($name)
		943	}
		944
		945	=back
		946
		947	=cut
1095		948
1096	package urxvt::anyevent;	949	package urxvt::anyevent;
1097		950
1098	=head2 The C<urxvt::anyevent> Class	951	=head2 The C<urxvt::anyevent> Class
1099		952
1100	The sole purpose of this class is to deliver an interface to the	953	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	954	C<AnyEvent> module - any module using it will work inside urxvt without
1102	further programming. The only exception is that you cannot wait on	955	further programming. The only exception is that you cannot wait on
1103	condition variables, but non-blocking condvar use is ok. What this means	956	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		957
1107	=cut	958	In practical terms this means is that you cannot use blocking APIs, but
		959	the non-blocking variant should work.
1108		960
		961	=cut
		962
1109	our $VERSION = 1;	963	our $VERSION = '5.23';
1110		964
1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	965	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	966	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113		967
1114	sub timer {	968	sub timer {
…		…
1116		970
1117	my $cb = $arg{cb};	971	my $cb = $arg{cb};
1118		972
1119	urxvt::timer	973	urxvt::timer
1120	->new	974	->new
1121	->start (urxvt::NOW + $arg{after})	975	->after ($arg{after}, $arg{interval})
1122	->cb (sub {	976	->cb ($arg{interval} ? $cb : sub {
1123	$_[0]->stop; # need to cancel manually	977	$_[0]->stop; # need to cancel manually
1124	$cb->();	978	$cb->();
1125	})	979	})
1126	}	980	}
1127		981
1128	sub io {	982	sub io {
1129	my ($class, %arg) = @_;	983	my ($class, %arg) = @_;
1130		984
1131	my $cb = $arg{cb};	985	my $cb = $arg{cb};
		986	my $fd = fileno $arg{fh};
		987	defined $fd or $fd = $arg{fh};
1132		988
1133	bless [$arg{fh}, urxvt::iow	989	bless [$arg{fh}, urxvt::iow
1134	->new	990	->new
1135	->fd (fileno $arg{fh})	991	->fd ($fd)
1136	->events (($arg{poll} =~ /r/ ? 1 : 0)	992	->events (($arg{poll} =~ /r/ ? 1 : 0)
1137	| ($arg{poll} =~ /w/ ? 2 : 0))	993	| ($arg{poll} =~ /w/ ? 2 : 0))
1138	->start	994	->start
1139	->cb (sub {	995	->cb ($cb)
1140	$cb->(($_[1] & 1 ? 'r' : '')
1141	. ($_[1] & 2 ? 'w' : ''));
1142	})],
1143	urxvt::anyevent::	996	], urxvt::anyevent::
		997	}
		998
		999	sub idle {
		1000	my ($class, %arg) = @_;
		1001
		1002	my $cb = $arg{cb};
		1003
		1004	urxvt::iw
		1005	->new
		1006	->start
		1007	->cb ($cb)
		1008	}
		1009
		1010	sub child {
		1011	my ($class, %arg) = @_;
		1012
		1013	my $cb = $arg{cb};
		1014
		1015	urxvt::pw
		1016	->new
		1017	->start ($arg{pid})
		1018	->cb (sub {
		1019	$_[0]->stop; # need to cancel manually
		1020	$cb->($_[0]->rpid, $_[0]->rstatus);
		1021	})
1144	}	1022	}
1145		1023
1146	sub DESTROY {	1024	sub DESTROY {
1147	$_[0][1]->stop;	1025	$_[0][1]->stop;
1148	}	1026	}
1149		1027
1150	sub condvar {	1028	# only needed for AnyEvent < 6 compatibility
1151	bless \my $flag, urxvt::anyevent::
1152	}
1153
1154	sub broadcast {
1155	${$_[0]}++;
1156	}
1157
1158	sub wait {
1159	unless (${$_[0]}) {
1160	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1161	}
1162	}
1163
1164	sub one_event {	1029	sub one_event {
1165	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1030	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1166	}	1031	}
1167		1032
1168	package urxvt::term;	1033	package urxvt::term;
…		…
1183	urxvt::verbose 6, "register package $pkg to $self";	1048	urxvt::verbose 6, "register package $pkg to $self";
1184		1049
1185	@{"$pkg\::ISA"} = urxvt::term::extension::;	1050	@{"$pkg\::ISA"} = urxvt::term::extension::;
1186		1051
1187	my $proxy = bless {	1052	my $proxy = bless {
1188	_pkg => $pkg,	1053	_pkg => $pkg,
		1054	_name => ${"$pkg\::_NAME"}, # hackish
1189	argv => $argv,	1055	argv => $argv,
1190	}, $pkg;	1056	}, $pkg;
1191	Scalar::Util::weaken ($proxy->{term} = $self);	1057	Scalar::Util::weaken ($proxy->{term} = $self);
1192		1058
1193	$self->{_pkg}{$pkg} = $proxy;	1059	$self->{_pkg}{$pkg} = $proxy;
1194		1060
…		…
1197	$proxy->enable ($name => $ref);	1063	$proxy->enable ($name => $ref);
1198	}	1064	}
1199	}	1065	}
1200	}	1066	}
1201		1067
		1068	sub perl_libdirs {
		1069	map { split /:/ }
		1070	$_[0]->resource ("perl_lib"),
		1071	$ENV{URXVT_PERL_LIB},
		1072	"$ENV{HOME}/.urxvt/ext",
		1073	"$LIBDIR/perl"
		1074	}
		1075
		1076	# scan for available extensions and collect their metadata
		1077	sub scan_extensions {
		1078	my ($self) = @_;
		1079
		1080	return if exists $self->{meta};
		1081
		1082	my @libdirs = perl_libdirs $self;
		1083
		1084	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1085
		1086	my %meta;
		1087
		1088	$self->{meta_libdirs} = join "\x00", @libdirs;
		1089	$self->{meta} = \%meta;
		1090
		1091	my %ext;
		1092
		1093	# first gather extensions
		1094	for my $dir (reverse @libdirs) {
		1095	opendir my $fh, $dir
		1096	or next;
		1097	for my $ext (readdir $fh) {
		1098	$ext !~ /^\./
		1099	and open my $fh, "<", "$dir/$ext"
		1100	or next;
		1101
		1102	my %ext = (dir => $dir);
		1103
		1104	while (<$fh>) {
		1105	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1106	my ($pattern, $type, $desc) = split /:/, $1;
		1107	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1108	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1109	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1110	} else {
		1111	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1112	}
		1113	} elsif (/^#:META:BINDING:(.*)/) {
		1114	my ($keysym, $action) = split /:/, $1;
		1115	$ext{binding}{$keysym} = $action;
		1116	} elsif (/^\s*(?:#|$)/) {
		1117	# skip other comments and empty lines
		1118	} else {
		1119	last; # stop parsing on first non-empty non-comment line
		1120	}
		1121	}
		1122
		1123	$meta{$ext} = \%ext;
		1124	}
		1125	}
		1126
		1127	# and now merge resources and bindings
		1128	while (my ($k, $v) = each %ext) {
		1129	#TODO: should check for extensions overriding each other
		1130	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1131	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1132	}
		1133	}
		1134
1202	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1135	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1203		1136
1204	Creates a new terminal, very similar as if you had started it with system	1137	Creates a new terminal, very similar as if you had started it with system
1205	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1138	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1206	hash which defines the environment of the new terminal.	1139	hash which defines the environment of the new terminal.
…		…
1223	}	1156	}
1224		1157
1225	=item $term->destroy	1158	=item $term->destroy
1226		1159
1227	Destroy the terminal object (close the window, free resources	1160	Destroy the terminal object (close the window, free resources
1228	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1161	etc.). Please note that urxvt will not exit as long as any event
1229	watchers (timers, io watchers) are still active.	1162	watchers (timers, io watchers) are still active.
1230		1163
1231	=item $term->exec_async ($cmd[, @args])	1164	=item $term->exec_async ($cmd[, @args])
1232		1165
1233	Works like the combination of the C<fork>/C<exec> builtins, which executes	1166	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1260	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1193	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1261		1194
1262	Here is a likely non-exhaustive list of option names, please see the	1195	Here is a likely non-exhaustive list of option names, please see the
1263	source file F</src/optinc.h> to see the actual list:	1196	source file F</src/optinc.h> to see the actual list:
1264		1197
1265	borderLess console cursorBlink cursorUnderline hold iconic insecure	1198	borderLess buffered console cursorBlink cursorUnderline hold iconic
1266	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1199	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1267	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1200	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1268	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1201	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1269	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1202	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1270	transparent tripleclickwords utmpInhibit visualBell	1203	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1204	urgentOnBell utmpInhibit visualBell
1271		1205
1272	=item $value = $term->resource ($name[, $newval])	1206	=item $value = $term->resource ($name[, $newval])
1273		1207
1274	Returns the current resource value associated with a given name and	1208	Returns the current resource value associated with a given name and
1275	optionally sets a new value. Setting values is most useful in the C<init>	1209	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1288		1222
1289	Here is a likely non-exhaustive list of resource names, not all of which	1223	Here is a likely non-exhaustive list of resource names, not all of which
1290	are supported in every build, please see the source file F</src/rsinc.h>	1224	are supported in every build, please see the source file F</src/rsinc.h>
1291	to see the actual list:	1225	to see the actual list:
1292		1226
1293	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1227	answerbackstring backgroundPixmap backspace_key blurradius
1294	borderLess color cursorBlink cursorUnderline cutchars delete_key	1228	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1295	display_name embed ext_bwidth fade font geometry hold iconName	1229	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1296	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1230	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1231	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1297	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1232	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1298	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1233	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1299	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1234	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1235	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1236	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1237	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303	secondaryScreen secondaryScroll selectstyle shade term_name title	1238	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1304	transient_for transparent transparent_all tripleclickwords utmpInhibit	1239	term_name title transient_for transparent tripleclickwords urgentOnBell
1305	visualBell	1240	utmpInhibit visualBell
1306		1241
1307	=cut	1242	=cut
1308		1243
1309	sub resource($$;$) {	1244	sub resource($$;$) {
1310	my ($self, $name) = (shift, shift);	1245	my ($self, $name) = (shift, shift);
1311	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1246	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1312	&urxvt::term::_resource	1247	goto &urxvt::term::_resource
1313	}	1248	}
1314		1249
1315	=item $value = $term->x_resource ($pattern)	1250	=item $value = $term->x_resource ($pattern)
1316		1251
1317	Returns the X-Resource for the given pattern, excluding the program or	1252	Returns the X-Resource for the given pattern, excluding the program or
1318	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1253	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1319	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1254	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1320	resource with that pattern exists.	1255	resource with that pattern exists.
1321		1256
		1257	Extensions that define extra resource or command line arguments also need
		1258	to call this method to access their values.
		1259
		1260	If the method is called on an extension object (basically, from an
		1261	extension), then the special prefix C<%.> will be replaced by the name of
		1262	the extension and a dot, and the lone string C<%> will be replaced by the
		1263	extension name itself. This makes it possible to code extensions so you
		1264	can rename them and get a new set of commandline switches and resources
		1265	without having to change the actual code.
		1266
1322	This method should only be called during the C<on_start> hook, as there is	1267	This method should only be called during the C<on_start> hook, as there is
1323	only one resource database per display, and later invocations might return	1268	only one resource database per display, and later invocations might return
1324	the wrong resources.	1269	the wrong resources.
1325		1270
1326	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1271	=item $value = $term->x_resource_boolean ($pattern)
1327		1272
		1273	Like C<x_resource>, above, but interprets the string value as a boolean
		1274	and returns C<1> for true values, C<0> for false values and C<undef> if
		1275	the resource or option isn't specified.
		1276
		1277	You should always use this method to parse boolean resources.
		1278
		1279	=cut
		1280
		1281	sub x_resource_boolean {
		1282	my $res = &x_resource;
		1283
		1284	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1285	}
		1286
		1287	=item $success = $term->bind_action ($key, $octets)
		1288
1328	Adds a keymap translation exactly as specified via a resource. See the	1289	Adds a key binding exactly as specified via a C<keysym> resource. See the
1329	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1290	C<keysym> resource in the urxvt(1) manpage.
1330		1291
1331	=item $rend = $term->rstyle ([$new_rstyle])	1292	=item $rend = $term->rstyle ([$new_rstyle])
1332		1293
1333	Return and optionally change the current rendition. Text that is output by	1294	Return and optionally change the current rendition. Text that is output by
1334	the terminal application will use this style.	1295	the terminal application will use this style.
…		…
1342		1303
1343	=item ($row, $col) = $term->selection_beg ([$row, $col])	1304	=item ($row, $col) = $term->selection_beg ([$row, $col])
1344		1305
1345	=item ($row, $col) = $term->selection_end ([$row, $col])	1306	=item ($row, $col) = $term->selection_end ([$row, $col])
1346		1307
1347	Return the current values of the selection mark, begin or end positions,	1308	Return the current values of the selection mark, begin or end positions.
1348	and optionally set them to new values.	1309
		1310	When arguments are given, then the selection coordinates are set to
		1311	C<$row> and C<$col>, and the selection screen is set to the current
		1312	screen.
		1313
		1314	=item $screen = $term->selection_screen ([$screen])
		1315
		1316	Returns the current selection screen, and then optionally sets it.
1349		1317
1350	=item $term->selection_make ($eventtime[, $rectangular])	1318	=item $term->selection_make ($eventtime[, $rectangular])
1351		1319
1352	Tries to make a selection as set by C<selection_beg> and	1320	Tries to make a selection as set by C<selection_beg> and
1353	C<selection_end>. If C<$rectangular> is true (default: false), a	1321	C<selection_end>. If C<$rectangular> is true (default: false), a
1354	rectangular selection will be made. This is the prefered function to make	1322	rectangular selection will be made. This is the preferred function to make
1355	a selection.	1323	a selection.
1356		1324
1357	=item $success = $term->selection_grab ($eventtime)	1325	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1358		1326
1359	Try to request the primary selection text from the server (for example, as	1327	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1328	true) selection from the server. The corresponding text can be set
1360	set by the next method). No visual feedback will be given. This function	1329	with the next method. No visual feedback will be given. This function
1361	is mostly useful from within C<on_sel_grab> hooks.	1330	is mostly useful from within C<on_sel_grab> hooks.
1362		1331
1363	=item $oldtext = $term->selection ([$newtext])	1332	=item $oldtext = $term->selection ([$newtext, $clipboard])
1364		1333
1365	Return the current selection text and optionally replace it by C<$newtext>.	1334	Return the current selection (clipboard if C<$clipboard> is true) text
		1335	and optionally replace it by C<$newtext>.
		1336
		1337	=item $term->selection_clear ([$clipboard])
		1338
		1339	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1366		1340
1367	=item $term->overlay_simple ($x, $y, $text)	1341	=item $term->overlay_simple ($x, $y, $text)
1368		1342
1369	Create a simple multi-line overlay box. See the next method for details.	1343	Create a simple multi-line overlay box. See the next method for details.
1370		1344
…		…
1400		1374
1401	The methods currently supported on C<urxvt::overlay> objects are:	1375	The methods currently supported on C<urxvt::overlay> objects are:
1402		1376
1403	=over 4	1377	=over 4
1404		1378
1405	=item $overlay->set ($x, $y, $text, $rend)	1379	=item $overlay->set ($x, $y, $text[, $rend])
1406		1380
1407	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1381	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1408	text in rxvt-unicode's special encoding and an array of rendition values	1382	text in rxvt-unicode's special encoding and an array of rendition values
1409	at a specific position inside the overlay.	1383	at a specific position inside the overlay.
		1384
		1385	If C<$rend> is missing, then the rendition will not be changed.
1410		1386
1411	=item $overlay->hide	1387	=item $overlay->hide
1412		1388
1413	If visible, hide the overlay, but do not destroy it.	1389	If visible, hide the overlay, but do not destroy it.
1414		1390
…		…
1496	locale-specific encoding of the terminal and can contain command sequences	1472	locale-specific encoding of the terminal and can contain command sequences
1497	(escape codes) that will be interpreted.	1473	(escape codes) that will be interpreted.
1498		1474
1499	=item $term->tt_write ($octets)	1475	=item $term->tt_write ($octets)
1500		1476
1501	Write the octets given in C<$data> to the tty (i.e. as program input). To	1477	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1502	pass characters instead of octets, you should convert your strings first	1478	pass characters instead of octets, you should convert your strings first
1503	to the locale-specific encoding using C<< $term->locale_encode >>.	1479	to the locale-specific encoding using C<< $term->locale_encode >>.
		1480
		1481	=item $term->tt_write_user_input ($octets)
		1482
		1483	Like C<tt_write>, but should be used when writing strings in response to
		1484	the user pressing a key, to invokes the additional actions requested by
		1485	the user for that case (C<tt_write> doesn't do that).
		1486
		1487	The typical use case would be inside C<on_action> hooks.
		1488
		1489	=item $term->tt_paste ($octets)
		1490
		1491	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1492	CR and bracketing the data with control sequences if bracketed paste mode
		1493	is set.
1504		1494
1505	=item $old_events = $term->pty_ev_events ([$new_events])	1495	=item $old_events = $term->pty_ev_events ([$new_events])
1506		1496
1507	Replaces the event mask of the pty watcher by the given event mask. Can	1497	Replaces the event mask of the pty watcher by the given event mask. Can
1508	be used to suppress input and output handling to the pty/tty. See the	1498	be used to suppress input and output handling to the pty/tty. See the
…		…
1527	Adds the specified events to the vt event mask. Useful e.g. when you want	1517	Adds the specified events to the vt event mask. Useful e.g. when you want
1528	to receive pointer events all the times:	1518	to receive pointer events all the times:
1529		1519
1530	$term->vt_emask_add (urxvt::PointerMotionMask);	1520	$term->vt_emask_add (urxvt::PointerMotionMask);
1531		1521
		1522	=item $term->set_urgency ($set)
		1523
		1524	Enable/disable the urgency hint on the toplevel window.
		1525
1532	=item $term->focus_in	1526	=item $term->focus_in
1533		1527
1534	=item $term->focus_out	1528	=item $term->focus_out
1535		1529
1536	=item $term->key_press ($state, $keycode[, $time])	1530	=item $term->key_press ($state, $keycode[, $time])
…		…
1624		1618
1625	Used after changing terminal contents to display them.	1619	Used after changing terminal contents to display them.
1626		1620
1627	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1621	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1628		1622
1629	Returns the text of the entire row with number C<$row_number>. Row C<0>	1623	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1630	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1624	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1631	terminal line. The scrollback buffer starts at line C<-1> and extends to
1632	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1625	terminal line. Nothing will be returned if a nonexistent line
1633	is requested.	1626	is requested.
1634		1627
1635	If C<$new_text> is specified, it will replace characters in the current	1628	If C<$new_text> is specified, it will replace characters in the current
1636	line, starting at column C<$start_col> (default C<0>), which is useful	1629	line, starting at column C<$start_col> (default C<0>), which is useful
1637	to replace only parts of a line. The font index in the rendition will	1630	to replace only parts of a line. The font index in the rendition will
1638	automatically be updated.	1631	automatically be updated.
1639		1632
1640	C<$text> is in a special encoding: tabs and wide characters that use more	1633	C<$text> is in a special encoding: tabs and wide characters that use more
1641	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1634	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642	characters. Characters with combining characters and other characters that	1635	characters. Characters with combining characters and other characters that
1643	do not fit into the normal tetx encoding will be replaced with characters	1636	do not fit into the normal text encoding will be replaced with characters
1644	in the private use area.	1637	in the private use area.
1645		1638
1646	You have to obey this encoding when changing text. The advantage is	1639	You have to obey this encoding when changing text. The advantage is
1647	that C<substr> and similar functions work on screen cells and not on	1640	that C<substr> and similar functions work on screen cells and not on
1648	characters.	1641	characters.
…		…
1733	}	1726	}
1734		1727
1735	sub urxvt::line::t {	1728	sub urxvt::line::t {
1736	my ($self) = @_;	1729	my ($self) = @_;
1737		1730
1738	if (@_ > 1)	1731	if (@_ > 1) {
1739	{
1740	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1732	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1741	for $self->{beg} .. $self->{end};	1733	for $self->{beg} .. $self->{end};
1742	}	1734	}
1743		1735
1744	defined wantarray &&	1736	defined wantarray &&
1745	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1737	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1746	0, $self->{len}	1738	0, $self->{len}
1747	}	1739	}
1748		1740
1749	sub urxvt::line::r {	1741	sub urxvt::line::r {
1750	my ($self) = @_;	1742	my ($self) = @_;
1751		1743
1752	if (@_ > 1)	1744	if (@_ > 1) {
1753	{
1754	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1745	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1755	for $self->{beg} .. $self->{end};	1746	for $self->{beg} .. $self->{end};
1756	}	1747	}
1757		1748
1758	if (defined wantarray) {	1749	if (defined wantarray) {
1759	my $rend = [	1750	my $rend = [
1760	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1751	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1761	];	1752	];
…		…
1823	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1814	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1824	recent grab.	1815	recent grab.
1825		1816
1826	=item $term->ungrab	1817	=item $term->ungrab
1827		1818
1828	Calls XUngrab for the most recent grab. Is called automatically on	1819	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1829	evaluation errors, as it is better to lose the grab in the error case as	1820	evaluation errors, as it is better to lose the grab in the error case as
1830	the session.	1821	the session.
1831		1822
1832	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1823	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1833		1824
…		…
1835		1826
1836	=item @atoms = $term->XListProperties ($window)	1827	=item @atoms = $term->XListProperties ($window)
1837		1828
1838	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1829	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1839		1830
1840	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1831	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1841		1832
1842	=item $term->XDeleteProperty ($window, $property)	1833	=item $term->XDeleteProperty ($window, $property)
1843		1834
1844	=item $window = $term->DefaultRootWindow	1835	=item $window = $term->DefaultRootWindow
1845		1836
…		…
1852	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1843	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1853		1844
1854	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1845	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1855		1846
1856	=item $term->XChangeInput ($window, $add_events[, $del_events])	1847	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1848
		1849	=item $keysym = $term->XStringToKeysym ($string)
		1850
		1851	=item $string = $term->XKeysymToString ($keysym)
1857		1852
1858	Various X or X-related functions. The C<$term> object only serves as	1853	Various X or X-related functions. The C<$term> object only serves as
1859	the source of the display, otherwise those functions map more-or-less	1854	the source of the display, otherwise those functions map more-or-less
1860	directory onto the X functions of the same name.	1855	directly onto the X functions of the same name.
1861		1856
1862	=back	1857	=back
1863		1858
1864	=cut	1859	=cut
1865		1860
…		…
1967	my $env = $self->{term}->env;	1962	my $env = $self->{term}->env;
1968	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1963	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969	delete $env->{LC_ALL};	1964	delete $env->{LC_ALL};
1970	$env->{LC_CTYPE} = $self->{term}->locale;	1965	$env->{LC_CTYPE} = $self->{term}->locale;
1971		1966
1972	urxvt::term->new ($env, "popup",	1967	my $term = urxvt::term->new (
		1968	$env, "popup",
1973	"--perl-lib" => "", "--perl-ext-common" => "",	1969	"--perl-lib" => "", "--perl-ext-common" => "",
1974	"-pty-fd" => -1, "-sl" => 0,	1970	"-pty-fd" => -1, "-sl" => 0,
1975	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1971	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976	"--transient-for" => $self->{term}->parent,	1972	"--transient-for" => $self->{term}->parent,
1977	"-display" => $self->{term}->display_id,	1973	"-display" => $self->{term}->display_id,
1978	"-pe" => "urxvt-popup")	1974	"-pe" => "urxvt-popup",
1979	or die "unable to create popup window\n";	1975	) or die "unable to create popup window\n";
		1976
		1977	unless (delete $term->{urxvt_popup_init_done}) {
		1978	$term->ungrab;
		1979	$term->destroy;
		1980	die "unable to initialise popup window\n";
		1981	}
1980	}	1982	}
1981		1983
1982	sub DESTROY {	1984	sub DESTROY {
1983	my ($self) = @_;	1985	my ($self) = @_;
1984		1986
…		…
2015		2017
2016	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2018	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017		2019
2018	Set the callback to be called when the timer triggers.	2020	Set the callback to be called when the timer triggers.
2019		2021
2020	=item $tstamp = $timer->at
2021
2022	Return the time this watcher will fire next.
2023
2024	=item $timer = $timer->set ($tstamp)	2022	=item $timer = $timer->set ($tstamp[, $interval])
2025		2023
2026	Set the time the event is generated to $tstamp.	2024	Set the time the event is generated to $tstamp (and optionally specifies a
		2025	new $interval).
2027		2026
2028	=item $timer = $timer->interval ($interval)	2027	=item $timer = $timer->interval ($interval)
2029		2028
2030	Normally (and when C<$interval> is C<0>), the timer will automatically	2029	By default (and when C<$interval> is C<0>), the timer will automatically
2031	stop after it has fired once. If C<$interval> is non-zero, then the timer	2030	stop after it has fired once. If C<$interval> is non-zero, then the timer
2032	is automatically rescheduled at the given intervals.	2031	is automatically rescheduled at the given intervals.
2033		2032
2034	=item $timer = $timer->start	2033	=item $timer = $timer->start
2035		2034
2036	Start the timer.	2035	Start the timer.
2037		2036
2038	=item $timer = $timer->start ($tstamp)	2037	=item $timer = $timer->start ($tstamp[, $interval])
2039		2038
2040	Set the event trigger time to C<$tstamp> and start the timer.	2039	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2040	also replaces the interval.
2041		2041
2042	=item $timer = $timer->after ($delay)	2042	=item $timer = $timer->after ($delay[, $interval])
2043		2043
2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045		2045
2046	=item $timer = $timer->stop	2046	=item $timer = $timer->stop
2047		2047
…		…
2178		2178
2179	=back	2179	=back
2180		2180
2181	=head1 AUTHOR	2181	=head1 AUTHOR
2182		2182
2183	Marc Lehmann <pcg@goof.com>	2183	Marc Lehmann <schmorp@schmorp.de>
2184	http://software.schmorp.de/pkg/rxvt-unicode	2184	http://software.schmorp.de/pkg/rxvt-unicode
2185		2185
2186	=cut	2186	=cut
2187		2187
2188	1	2188	1

Diff Legend

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