ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.154 by root, Sat Jun 2 06:43:02 2007 UTC vs.
Revision 1.241 by sf-exg, Fri Oct 10 14:38:02 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	It's sole argument is the popup menu, which can be modified. It should
107	either return nothing or a string, the initial boolean value and a code
108	reference. The string will be used as button text and the code reference
109	will be called when the toggle changes, with the new boolean value as
110	first argument.
111
112	The following will add an entry C<myoption> that changes
113	C<$self->{myoption}>:
114
115	push @{ $self->{term}{option_popup_hook} }, sub {
116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117	};
118
119	=item selection-popup (enabled by default)
120
121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
122	text into various other formats/action (such as uri unescaping, perl
123	evaluation, web-browser starting etc.), depending on content.
124
125	Other extensions can extend this popup menu by pushing a code reference
126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127	popup is being displayed.
128
129	It's sole argument is the popup menu, which can be modified. The selection
130	is in C<$_>, which can be used to decide whether to add something or not.
131	It should either return nothing or a string and a code reference. The
132	string will be used as button text and the code reference will be called
133	when the button gets activated and should transform C<$_>.
134
135	The following will add an entry C<a to b> that transforms all C<a>s in
136	the selection to C<b>s, but only if the selection currently contains any
137	C<a>s:
138
139	push @{ $self->{term}{selection_popup_hook} }, sub {
140	/a/ ? ("a to be" => sub { s/a/b/g }
141	: ()
142	};
143
144	=item searchable-scrollback<hotkey> (enabled by default)
145
146	Adds regex search functionality to the scrollback buffer, triggered
147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
148	input/output is suspended and a regex is displayed at the bottom of the
149	screen.
150
151	Inputting characters appends them to the regex and continues incremental
152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
154	bottom. C<Escape> leaves search mode and returns to the point where search
155	was started, while C<Enter> or C<Return> stay at the current position and
156	additionally stores the first match in the current line into the primary
157	selection.
158
159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
160	get a case-sensitive search you can delete this prefix using C<BackSpace>
161	or simply use an uppercase character which removes the "(?i)" prefix.
162
163	See L<perlre> for more info about perl regular expression syntax.
164
165	=item readline (enabled by default)
166
167	A support package that tries to make editing with readline easier. At
168	the moment, it reacts to clicking shift-left mouse button by trying to
169	move the text cursor to this position. It does so by generating as many
170	cursor-left or cursor-right keypresses as required (the this only works
171	for programs that correctly support wide characters).
172
173	To avoid too many false positives, this is only done when:
174
175	=over 4
176
177	=item - the tty is in ICANON state.
178
179	=item - the text cursor is visible.
180
181	=item - the primary screen is currently being displayed.
182
183	=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185	=back
186
187	The normal selection mechanism isn't disabled, so quick successive clicks
188	might interfere with selection creation in harmless ways.
189
190	=item selection-autotransform
191
192	This selection allows you to do automatic transforms on a selection
193	whenever a selection is made.
194
195	It works by specifying perl snippets (most useful is a single C<s///>
196	operator) that modify C<$_> as resources:
197
198	URxvt.selection-autotransform.0: transform
199	URxvt.selection-autotransform.1: transform
200	...
201
202	For example, the following will transform selections of the form
203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
204	$word>:
205
206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
207
208	And this example matches the same,but replaces it with vi-commands you can
209	paste directly into your (vi :) editor:
210
211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213	Of course, this can be modified to suit your needs and your editor :)
214
215	To expand the example above to typical perl error messages ("XXX at
216	FILENAME line YYY."), you need a slightly more elaborate solution:
217
218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
220
221	The first line tells the selection code to treat the unchanging part of
222	every error message as a selection pattern, and the second line transforms
223	the message into vi commands to load the file.
224
225	=item tabbed
226
227	This transforms the terminal into a tabbar with additional terminals, that
228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230	button per tab.
231
232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
233	B<Shift-Right> will switch to the tab left or right of the current one,
234	while B<Shift-Down> creates a new tab.
235
236	The tabbar itself can be configured similarly to a normal terminal, but
237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
238	following four resources (shown with defaults):
239
240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242	URxvt.tabbed.tab-fg: <colour-index, default 0>
243	URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246	indices.
247
248	=item matcher
249
250	Uses per-line display filtering (C<on_line_update>) to underline text
251	matching a certain pattern and make it clickable. When clicked with the
252	mouse button specified in the C<matcher.button> resource (default 2, or
253	middle), the program specified in the C<matcher.launcher> resource
254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255	with the matched text as first argument. The default configuration is
256	suitable for matching URLs and launching a web browser, like the
257	former "mark-urls" extension.
258
259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.
263
264	Example configuration:
265
266	URxvt.perl-ext: default,matcher
267	URxvt.urlLauncher: sensible-browser
268	URxvt.keysym.C-Delete: perl:matcher
269	URxvt.matcher.button: 1
270	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
271	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
272	URxvt.matcher.launcher.2: gvim +$2 $1
273
274	=item xim-onthespot
275
276	This (experimental) perl extension implements OnTheSpot editing. It does
277	not work perfectly, and some input methods don't seem to work well with
278	OnTheSpot editing in general, but it seems to work at leats for SCIM and
279	kinput2.
280
281	You enable it by specifying this extension and a preedit style of
282	C<OnTheSpot>, i.e.:
283
284	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
285
286	=item kuake<hotkey>
287
288	A very primitive quake-console-like extension. It was inspired by a
289	description of how the programs C<kuake> and C<yakuake> work: Whenever the
290	user presses a global accelerator key (by default C<F10>), the terminal
291	will show or hide itself. Another press of the accelerator key will hide
292	or show it again.
293
294	Initially, the window will not be shown when using this extension.
295
296	This is useful if you need a single terminal thats not using any desktop
297	space most of the time but is quickly available at the press of a key.
298
299	The accelerator key is grabbed regardless of any modifiers, so this
300	extension will actually grab a physical key just for this function.
301
302	If you want a quake-like animation, tell your window manager to do so
303	(fvwm can do it).
304
305	=item automove-background
306
307	This is basically a very small extension that dynamically changes the
308	background pixmap offset to the window position, in effect creating the
309	same effect as pseudo transparency with a custom pixmap. No scaling is
310	supported in this mode. Example:
311
312	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
313
314	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
315	shows how this extension can be used to implement an automatically blurred
316	transparent background.
317
318	=item block-graphics-to-ascii
319
320	A not very useful example of filtering all text output to the terminal
321	by replacing all line-drawing characters (U+2500 .. U+259F) by a
322	similar-looking ascii character.
323
324	=item digital-clock
325
326	Displays a digital clock using the built-in overlay.
327
328	=item remote-clipboard
329
330	Somewhat of a misnomer, this extension adds two menu entries to the
331	selection popup that allows one ti run external commands to store the
332	selection somewhere and fetch it again.
333
334	We use it to implement a "distributed selection mechanism", which just
335	means that one command uploads the file to a remote server, and another
336	reads it.
337
338	The commands can be set using the C<URxvt.remote-selection.store> and
339	C<URxvt.remote-selection.fetch> resources. The first should read the
340	selection to store from STDIN (always in UTF-8), the second should provide
341	the selection data on STDOUT (also in UTF-8).
342
343	The defaults (which are likely useless to you) use rsh and cat:
344
345	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
346	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
347
348	=item selection-pastebin
349
350	This is a little rarely useful extension that Uploads the selection as
351	textfile to a remote site (or does other things). (The implementation is
352	not currently secure for use in a multiuser environment as it writes to
353	F</tmp> directly.).
354
355	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
356	i.e.
357
358	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
359
360	Pressing this combination runs a command with C<%> replaced by the name of
361	the textfile. This command can be set via a resource:
362
363	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
364
365	And the default is likely not useful to anybody but the few people around
366	here :)
367
368	The name of the textfile is the hex encoded md5 sum of the selection, so
369	the same content should lead to the same filename.
370
371	After a successful upload the selection will be replaced by the text given
372	in the C<selection-pastebin-url> resource (again, the % is the placeholder
373	for the filename):
374
375	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
376
377	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
378	the double C</> characters as comment start. Use C<\057\057> instead,
379	which works regardless of wether xrdb is used to parse the resource file
380	or not.
381
382	=item example-refresh-hooks
383
384	Displays a very simple digital clock in the upper right corner of the
385	window. Illustrates overwriting the refresh callbacks to create your own
386	overlays or changes.
387
388	=back
389		50
390	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
391		52
392	=head2 General API Considerations	53	=head2 General API Considerations
393		54
…		…
407		68
408	=over 4	69	=over 4
409		70
410	=item $text	71	=item $text
411		72
412	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
413	always represents one screen cell. See L<ROW_t> for a discussion of this format.	74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
414		75
415	=item $string	76	=item $string
416		77
417	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
…		…
421	=item $octets	82	=item $octets
422		83
423	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
424	locale-specific way.	85	locale-specific way.
425		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
426	=back	93	=back
427		94
428	=head2 Extension Objects	95	=head2 Extension Objects
429		96
430	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
431	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,
432	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
433	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
434	extensions or other terminals, with the exception of methods and members	101	extensions or other terminals, with the exception of methods and members
435	that begin with an underscore character C<_>: these are reserved for	102	that begin with an underscore character C<_>: these are reserved for
436	internal use.	103	internal use.
437		104
438	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
439	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
440		107
441	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
442		109	the C<urxvt::extension> section below.
443	=over 4
444
445	=item $urxvt_term = $self->{term}
446
447	Returns the C<urxvt::term> object associated with this instance of the
448	extension. This member I<must not> be changed in any way.
449
450	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
451
452	Dynamically enable the given hooks (named without the C<on_> prefix) for
453	this extension, replacing any previous hook. This is useful when you want
454	to overwrite time-critical hooks only temporarily.
455
456	=item $self->disable ($hook_name[, $hook_name..])
457
458	Dynamically disable the given hooks.
459
460	=back
461		110
462	=head2 Hooks	111	=head2 Hooks
463		112
464	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
465	called whenever the relevant event happens.	114	called whenever the relevant event happens.
…		…
551		200
552	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,
553	$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
554	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
555		204
556	=item on_osc_seq $term, $op, $args	205	=item on_osc_seq $term, $op, $args, $resp
557		206
558	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
559	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
560	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
561	confused by recursive invocations when you output an osc sequence within	210	confused by recursive invocations when you output an OSC sequence within
562	this callback.	211	this callback.
563		212
564	C<on_osc_seq_perl> should be used for new behaviour.	213	C<on_osc_seq_perl> should be used for new behaviour.
565		214
566	=item on_osc_seq_perl $term, $string	215	=item on_osc_seq_perl $term, $args, $resp
567		216
568	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
569	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
570	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
571	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,
572	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
573	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	}
574		233
575	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,
576	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
577	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.
578		240
579	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
580		242
581	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
582	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
…		…
587	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
588		250
589	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
590	suppress or filter tty input.	252	suppress or filter tty input.
591		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
592	=item on_line_update $term, $row	261	=item on_line_update $term, $row
593		262
594	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
595	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
596	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,
…		…
603	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
604	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
605		274
606	=item on_refresh_begin $term	275	=item on_refresh_begin $term
607		276
608	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
609	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
610	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
611	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
612		281
613	=item on_refresh_end $term	282	=item on_refresh_end $term
614		283
615	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>.
616		285
617	=item on_user_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
618		287
619	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
620	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>
621	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
622		291
623	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
624	slightly in the future.	293	preference to the C<on_action> hook.
625		294
626	=item on_resize_all_windows $tern, $new_width, $new_height	295	=item on_resize_all_windows $term, $new_width, $new_height
627		296
628	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
629	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
630	returns TRUE, setting of the window hints is being skipped.	299	returns a true value, setting of the window hints is being skipped.
631		300
632	=item on_x_event $term, $event	301	=item on_x_event $term, $event
633		302
634	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
635	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
…		…
665		334
666	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
667		336
668	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
669		338
670	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
671	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.
672		341
673	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
674	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
675	(real, not screen-based) row and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
676		345
677	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
678	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
679		348
680	subwindow.
681
682	=item on_client_message $term, $event	349	=item on_client_message $term, $event
683		350
684	=item on_wm_protocols $term, $event	351	=item on_wm_protocols $term, $event
685		352
686	=item on_wm_delete_window $term, $event	353	=item on_wm_delete_window $term, $event
687		354
688	Called when various types of ClientMessage events are received (all with	355	Called when various types of ClientMessage events are received (all with
689	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	356	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
690		357
		358	=item on_bell $term
		359
		360	Called on receipt of a bell character.
		361
691	=back	362	=back
692		363
693	=cut	364	=cut
694		365
695	package urxvt;	366	package urxvt;
696		367
697	use utf8;	368	use utf8;
698	use strict;	369	use strict 'vars';
699	use Carp ();	370	use Carp ();
700	use Scalar::Util ();	371	use Scalar::Util ();
701	use List::Util ();	372	use List::Util ();
702		373
703	our $VERSION = 1;	374	our $VERSION = 1;
704	our $TERM;	375	our $TERM;
705	our @TERM_INIT;	376	our @TERM_INIT; # should go, prevents async I/O etc.
706	our @TERM_EXT;	377	our @TERM_EXT; # should go, prevents async I/O etc.
707	our @HOOKNAME;	378	our @HOOKNAME;
708	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
709	our %OPTION;	380	our %OPTION;
710		381
711	our $LIBDIR;	382	our $LIBDIR;
…		…
759		430
760	=over 4	431	=over 4
761		432
762	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
763		434
764	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
765	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
766	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
767		439
768	=item urxvt::warn $string	440	=item urxvt::warn $string
769		441
770	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
771	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
772	that calls this function.	444	that calls this function.
773		445
774	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
775	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
779	=item @terms = urxvt::termlist	451	=item @terms = urxvt::termlist
780		452
781	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
782	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
783	objects that have perl extensions attached will be returned (because there	455	objects that have perl extensions attached will be returned (because there
784	is no urxvt::term objet associated with others).	456	is no urxvt::term object associated with others).
785		457
786	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
787		459
788	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
789		461
…		…
832		504
833	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
834		506
835	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
836		508
837	=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
838		511
839	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
840	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
841	the bitset.	514	the bitset.
842		515
…		…
879	};	552	};
880	}	553	}
881		554
882	no warnings 'utf8';	555	no warnings 'utf8';
883		556
		557	sub parse_resource {
		558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		559
		560	$term->scan_extensions;
		561
		562	my $r = $term->{meta}{resource};
		563	keys %$r; # reset iterator
		564	while (my ($k, $v) = each %$r) {
		565	my $pattern = $k;
		566	$pattern =~ y/./-/ if $isarg;
		567	my $prefix = $name;
		568	my $suffix;
		569	if ($pattern =~ /\-$/) {
		570	$prefix = substr $name, 0, length $pattern;
		571	$suffix = substr $name, length $pattern;
		572	}
		573	if ($pattern eq $prefix) {
		574	$name = "$urxvt::RESCLASS.$k$suffix";
		575
		576	push @{ $term->{perl_ext_3} }, $v->[0];
		577
		578	if ($v->[1] eq "boolean") {
		579	$term->put_option_db ($name, $flag ? "true" : "false");
		580	return 1;
		581	} else {
		582	$term->put_option_db ($name, $value);
		583	return 1 + 2;
		584	}
		585	}
		586	}
		587
		588	0
		589	}
		590
		591	sub usage {
		592	my ($term, $usage_type) = @_;
		593
		594	$term->scan_extensions;
		595
		596	my $r = $term->{meta}{resource};
		597
		598	for my $pattern (sort keys %$r) {
		599	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		600
		601	$desc .= " (-pe $ext)";
		602
		603	if ($usage_type == 1) {
		604	$pattern =~ y/./-/;
		605	$pattern =~ s/-$/-.../g;
		606
		607	if ($type eq "boolean") {
		608	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		609	} else {
		610	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		611	}
		612	} else {
		613	$pattern =~ s/\.$/.*/g;
		614	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		615	}
		616	}
		617	}
		618
884	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	619	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
885		620
886	sub verbose {	621	sub verbose {
887	my ($level, $msg) = @_;	622	my ($level, $msg) = @_;
888	warn "$msg\n" if $level <= $verbosity;	623	warn "$msg\n" if $level <= $verbosity;
…		…
900	$pkg =~ s/[^[:word:]]/_/g;	635	$pkg =~ s/[^[:word:]]/_/g;
901	$pkg = "urxvt::ext::$pkg";	636	$pkg = "urxvt::ext::$pkg";
902		637
903	verbose 3, "loading extension '$path' into package '$pkg'";	638	verbose 3, "loading extension '$path' into package '$pkg'";
904		639
		640	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		641
905	open my $fh, "<:raw", $path	642	open my $fh, "<:raw", $path
906	or die "$path: $!";	643	or die "$path: $!";
907		644
908	my $source =	645	my $source =
909	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	646	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
910	. "#line 1 \"$path\"\n{\n"	647	. "#line 1 \"$path\"\n{\n"
911	. (do { local $/; <$fh> })	648	. (do { local $/; <$fh> })
912	. "\n};\n1";	649	. "\n};\n1";
913		650
914	eval $source	651	eval $source
…		…
923	# called by the rxvt core	660	# called by the rxvt core
924	sub invoke {	661	sub invoke {
925	local $TERM = shift;	662	local $TERM = shift;
926	my $htype = shift;	663	my $htype = shift;
927		664
928	if ($htype == 0) { # INIT	665	if ($htype == HOOK_INIT) {
929	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	666	my @dirs = $TERM->perl_libdirs;
930		667
		668	$TERM->scan_extensions;
		669
931	my %ext_arg;	670	my %ext_arg;
932		671
933	{	672	{
934	my @init = @TERM_INIT;	673	my @init = @TERM_INIT;
935	@TERM_INIT = ();	674	@TERM_INIT = ();
…		…
937	my @pkg = @TERM_EXT;	676	my @pkg = @TERM_EXT;
938	@TERM_EXT = ();	677	@TERM_EXT = ();
939	$TERM->register_package ($_) for @pkg;	678	$TERM->register_package ($_) for @pkg;
940	}	679	}
941		680
		681	for (
942	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	682	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		683	) {
943	if ($_ eq "default") {	684	if ($_ eq "default") {
944	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	685
		686	$ext_arg{$_} = []
		687	for
		688	qw(selection option-popup selection-popup readline),
		689	@{ delete $TERM->{perl_ext_3} },
		690	map $_->[0], values %{ $TERM->{meta}{binding} };
		691
		692	for ($TERM->_keysym_resources) {
		693	next if /^(?:string|command|builtin|builtin-string|perl)/;
		694	next unless /^([A-Za-z0-9_\-]+):/;
		695
		696	my $ext = $1;
		697
		698	$ext_arg{$ext} = [];
		699	}
		700
945	} elsif (/^-(.*)$/) {	701	} elsif (/^-(.*)$/) {
946	delete $ext_arg{$1};	702	delete $ext_arg{$1};
		703
947	} elsif (/^([^<]+)<(.*)>$/) {	704	} elsif (/^([^<]+)<(.*)>$/) {
948	push @{ $ext_arg{$1} }, $2;	705	push @{ $ext_arg{$1} }, $2;
		706
949	} else {	707	} else {
950	$ext_arg{$_} ||= [];	708	$ext_arg{$_} ||= [];
		709	}
		710	}
		711
		712	# now register default key bindings
		713	for my $ext (sort keys %ext_arg) {
		714	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		715	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
951	}	716	}
952	}	717	}
953		718
954	for my $ext (sort keys %ext_arg) {	719	for my $ext (sort keys %ext_arg) {
955	my @files = grep -f $_, map "$_/$ext", @dirs;	720	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
969		734
970	if (my $cb = $TERM->{_hook}[$htype]) {	735	if (my $cb = $TERM->{_hook}[$htype]) {
971	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
972	if $verbosity >= 10;	737	if $verbosity >= 10;
973		738
		739	if ($htype == HOOK_ACTION) {
		740	# this hook is only sent to the extension with the name
		741	# matching the first arg
		742	my $pkg = shift;
		743	$pkg =~ y/-/_/;
		744	$pkg = "urxvt::ext::$pkg";
		745
		746	$cb = $cb->{$pkg}
		747	or return undef; #TODO: maybe warn user?
		748
		749	$cb = { $pkg => $cb };
		750	}
		751
974	for my $pkg (keys %$cb) {	752	for my $pkg (keys %$cb) {
975	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	753	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
976	$retval ||= $retval_;	754	$retval ||= $retval_;
977		755
978	if ($@) {	756	if ($@) {
979	$TERM->ungrab; # better to lose the grab than the session	757	$TERM->ungrab; # better to lose the grab than the session
980	warn $@;	758	warn $@;
…		…
983		761
984	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	762	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
985	if $verbosity >= 11;	763	if $verbosity >= 11;
986	}	764	}
987		765
988	if ($htype == 1) { # DESTROY	766	if ($htype == HOOK_DESTROY) {
989	# clear package objects	767	# clear package objects
990	%$_ = () for values %{ $TERM->{_pkg} };	768	%$_ = () for values %{ $TERM->{_pkg} };
991		769
992	# clear package	770	# clear package
993	%$TERM = ();	771	%$TERM = ();
…		…
1023	}	801	}
1024	}	802	}
1025	($mask, @color{qw(fg bg)}, \@failed)	803	($mask, @color{qw(fg bg)}, \@failed)
1026	}	804	}
1027		805
1028	# urxvt::term::extension
1029
1030	package urxvt::term::extension;	806	package urxvt::term::extension;
1031		807
1032	sub enable {	808	=head2 The C<urxvt::term::extension> class
1033	my ($self, %hook) = @_;
1034	my $pkg = $self->{_pkg};
1035		809
1036	while (my ($name, $cb) = each %hook) {	810	Each extension attached to a terminal object is represented by
1037	my $htype = $HOOKTYPE{uc $name};	811	a C<urxvt::term::extension> object.
1038	defined $htype
1039	or Carp::croak "unsupported hook type '$name'";
1040		812
1041	$self->set_should_invoke ($htype, +1)	813	You can use these objects, which are passed to all callbacks to store any
1042	unless exists $self->{term}{_hook}[$htype]{$pkg};	814	state related to the terminal and extension instance.
1043		815
1044	$self->{term}{_hook}[$htype]{$pkg} = $cb;	816	The methods (And data members) documented below can be called on extension
1045	}	817	objects, in addition to call methods documented for the <urxvt::term>
1046	}	818	class.
1047		819
1048	sub disable {	820	=over 4
1049	my ($self, @hook) = @_;
1050	my $pkg = $self->{_pkg};
1051		821
1052	for my $name (@hook) {	822	=item $urxvt_term = $self->{term}
1053	my $htype = $HOOKTYPE{uc $name};
1054	defined $htype
1055	or Carp::croak "unsupported hook type '$name'";
1056		823
1057	$self->set_should_invoke ($htype, -1)	824	Returns the C<urxvt::term> object associated with this instance of the
1058	if delete $self->{term}{_hook}[$htype]{$pkg};	825	extension. This member I<must not> be changed in any way.
1059	}	826
1060	}	827	=cut
1061		828
1062	our $AUTOLOAD;	829	our $AUTOLOAD;
1063		830
1064	sub AUTOLOAD {	831	sub AUTOLOAD {
1065	$AUTOLOAD =~ /:([^:]+)$/	832	$AUTOLOAD =~ /:([^:]+)$/
…		…
1078		845
1079	sub DESTROY {	846	sub DESTROY {
1080	# nop	847	# nop
1081	}	848	}
1082		849
1083	# urxvt::destroy_hook	850	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1084		851
1085	sub urxvt::destroy_hook::DESTROY {	852	sub urxvt::destroy_hook::DESTROY {
1086	${$_[0]}->();	853	${$_[0]}->();
1087	}	854	}
1088		855
1089	sub urxvt::destroy_hook(&) {	856	sub urxvt::destroy_hook(&) {
1090	bless \shift, urxvt::destroy_hook::	857	bless \shift, urxvt::destroy_hook::
1091	}	858	}
		859
		860	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		861
		862	Dynamically enable the given hooks (named without the C<on_> prefix) for
		863	this extension, replacing any hook previously installed via C<enable> in
		864	this extension.
		865
		866	This is useful when you want to overwrite time-critical hooks only
		867	temporarily.
		868
		869	To install additional callbacks for the same hook, you can use the C<on>
		870	method of the C<urxvt::term> class.
		871
		872	=item $self->disable ($hook_name[, $hook_name..])
		873
		874	Dynamically disable the given hooks.
		875
		876	=cut
		877
		878	sub enable {
		879	my ($self, %hook) = @_;
		880	my $pkg = $self->{_pkg};
		881
		882	while (my ($name, $cb) = each %hook) {
		883	my $htype = $HOOKTYPE{uc $name};
		884	defined $htype
		885	or Carp::croak "unsupported hook type '$name'";
		886
		887	$self->set_should_invoke ($htype, +1)
		888	unless exists $self->{term}{_hook}[$htype]{$pkg};
		889
		890	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		891	}
		892	}
		893
		894	sub disable {
		895	my ($self, @hook) = @_;
		896	my $pkg = $self->{_pkg};
		897
		898	for my $name (@hook) {
		899	my $htype = $HOOKTYPE{uc $name};
		900	defined $htype
		901	or Carp::croak "unsupported hook type '$name'";
		902
		903	$self->set_should_invoke ($htype, -1)
		904	if delete $self->{term}{_hook}[$htype]{$pkg};
		905	}
		906	}
		907
		908	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		909
		910	Similar to the C<enable> enable, but installs additional callbacks for
		911	the given hook(s) (that is, it doesn't replace existing callbacks), and
		912	returns a guard object. When the guard object is destroyed the callbacks
		913	are disabled again.
		914
		915	=cut
		916
		917	sub urxvt::extension::on_disable::DESTROY {
		918	my $disable = shift;
		919
		920	my $term = delete $disable->{""};
		921
		922	while (my ($htype, $id) = each %$disable) {
		923	delete $term->{_hook}[$htype]{$id};
		924	$term->set_should_invoke ($htype, -1);
		925	}
		926	}
		927
		928	sub on {
		929	my ($self, %hook) = @_;
		930
		931	my $term = $self->{term};
		932
		933	my %disable = ( "" => $term );
		934
		935	while (my ($name, $cb) = each %hook) {
		936	my $htype = $HOOKTYPE{uc $name};
		937	defined $htype
		938	or Carp::croak "unsupported hook type '$name'";
		939
		940	$term->set_should_invoke ($htype, +1);
		941	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		942	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		943	}
		944
		945	bless \%disable, "urxvt::extension::on_disable"
		946	}
		947
		948	=item $self->x_resource ($pattern)
		949
		950	=item $self->x_resource_boolean ($pattern)
		951
		952	These methods support an additional C<%> prefix when called on an
		953	extension object - see the description of these methods in the
		954	C<urxvt::term> class for details.
		955
		956	=cut
		957
		958	sub x_resource {
		959	my ($self, $name) = @_;
		960	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		961	$self->{term}->x_resource ($name)
		962	}
		963
		964	sub x_resource_boolean {
		965	my ($self, $name) = @_;
		966	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		967	$self->{term}->x_resource_boolean ($name)
		968	}
		969
		970	=back
		971
		972	=cut
1092		973
1093	package urxvt::anyevent;	974	package urxvt::anyevent;
1094		975
1095	=head2 The C<urxvt::anyevent> Class	976	=head2 The C<urxvt::anyevent> Class
1096		977
1097	The sole purpose of this class is to deliver an interface to the	978	The sole purpose of this class is to deliver an interface to the
1098	C<AnyEvent> module - any module using it will work inside urxvt without	979	C<AnyEvent> module - any module using it will work inside urxvt without
1099	further programming. The only exception is that you cannot wait on	980	further programming. The only exception is that you cannot wait on
1100	condition variables, but non-blocking condvar use is ok. What this means	981	condition variables, but non-blocking condvar use is ok.
1101	is that you cannot use blocking APIs, but the non-blocking variant should
1102	work.
1103		982
1104	=cut	983	In practical terms this means is that you cannot use blocking APIs, but
		984	the non-blocking variant should work.
1105		985
		986	=cut
		987
1106	our $VERSION = 1;	988	our $VERSION = '5.23';
1107		989
1108	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	990	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1109	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	991	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1110		992
1111	sub timer {	993	sub timer {
…		…
1113		995
1114	my $cb = $arg{cb};	996	my $cb = $arg{cb};
1115		997
1116	urxvt::timer	998	urxvt::timer
1117	->new	999	->new
1118	->start (urxvt::NOW + $arg{after})	1000	->after ($arg{after}, $arg{interval})
1119	->cb (sub {	1001	->cb ($arg{interval} ? $cb : sub {
1120	$_[0]->stop; # need to cancel manually	1002	$_[0]->stop; # need to cancel manually
1121	$cb->();	1003	$cb->();
1122	})	1004	})
1123	}	1005	}
1124		1006
1125	sub io {	1007	sub io {
1126	my ($class, %arg) = @_;	1008	my ($class, %arg) = @_;
1127		1009
1128	my $cb = $arg{cb};	1010	my $cb = $arg{cb};
		1011	my $fd = fileno $arg{fh};
		1012	defined $fd or $fd = $arg{fh};
1129		1013
1130	bless [$arg{fh}, urxvt::iow	1014	bless [$arg{fh}, urxvt::iow
1131	->new	1015	->new
1132	->fd (fileno $arg{fh})	1016	->fd ($fd)
1133	->events (($arg{poll} =~ /r/ ? 1 : 0)	1017	->events (($arg{poll} =~ /r/ ? 1 : 0)
1134	| ($arg{poll} =~ /w/ ? 2 : 0))	1018	| ($arg{poll} =~ /w/ ? 2 : 0))
1135	->start	1019	->start
1136	->cb (sub {	1020	->cb ($cb)
1137	$cb->(($_[1] & 1 ? 'r' : '')
1138	. ($_[1] & 2 ? 'w' : ''));
1139	})],
1140	urxvt::anyevent::	1021	], urxvt::anyevent::
		1022	}
		1023
		1024	sub idle {
		1025	my ($class, %arg) = @_;
		1026
		1027	my $cb = $arg{cb};
		1028
		1029	urxvt::iw
		1030	->new
		1031	->start
		1032	->cb ($cb)
		1033	}
		1034
		1035	sub child {
		1036	my ($class, %arg) = @_;
		1037
		1038	my $cb = $arg{cb};
		1039
		1040	urxvt::pw
		1041	->new
		1042	->start ($arg{pid})
		1043	->cb (sub {
		1044	$_[0]->stop; # need to cancel manually
		1045	$cb->($_[0]->rpid, $_[0]->rstatus);
		1046	})
1141	}	1047	}
1142		1048
1143	sub DESTROY {	1049	sub DESTROY {
1144	$_[0][1]->stop;	1050	$_[0][1]->stop;
1145	}	1051	}
1146		1052
1147	sub condvar {	1053	# only needed for AnyEvent < 6 compatibility
1148	bless \my $flag, urxvt::anyevent::
1149	}
1150
1151	sub broadcast {
1152	${$_[0]}++;
1153	}
1154
1155	sub wait {
1156	unless (${$_[0]}) {
1157	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1158	}
1159	}
1160
1161	sub one_event {	1054	sub one_event {
1162	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1055	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1163	}	1056	}
1164		1057
1165	package urxvt::term;	1058	package urxvt::term;
…		…
1180	urxvt::verbose 6, "register package $pkg to $self";	1073	urxvt::verbose 6, "register package $pkg to $self";
1181		1074
1182	@{"$pkg\::ISA"} = urxvt::term::extension::;	1075	@{"$pkg\::ISA"} = urxvt::term::extension::;
1183		1076
1184	my $proxy = bless {	1077	my $proxy = bless {
1185	_pkg => $pkg,	1078	_pkg => $pkg,
		1079	_name => ${"$pkg\::_NAME"}, # hackish
1186	argv => $argv,	1080	argv => $argv,
1187	}, $pkg;	1081	}, $pkg;
1188	Scalar::Util::weaken ($proxy->{term} = $self);	1082	Scalar::Util::weaken ($proxy->{term} = $self);
1189		1083
1190	$self->{_pkg}{$pkg} = $proxy;	1084	$self->{_pkg}{$pkg} = $proxy;
1191		1085
…		…
1194	$proxy->enable ($name => $ref);	1088	$proxy->enable ($name => $ref);
1195	}	1089	}
1196	}	1090	}
1197	}	1091	}
1198		1092
		1093	sub perl_libdirs {
		1094	map { split /:/ }
		1095	$_[0]->resource ("perl_lib"),
		1096	$ENV{URXVT_PERL_LIB},
		1097	"$ENV{HOME}/.urxvt/ext",
		1098	"$LIBDIR/perl"
		1099	}
		1100
		1101	# scan for available extensions and collect their metadata
		1102	sub scan_extensions {
		1103	my ($self) = @_;
		1104
		1105	return if exists $self->{meta};
		1106
		1107	my @libdirs = perl_libdirs $self;
		1108
		1109	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1110
		1111	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1112	$self->{meta} = \my %meta;
		1113
		1114	# first gather extensions
		1115	for my $dir (reverse @libdirs) {
		1116	opendir my $fh, $dir
		1117	or next;
		1118	for my $ext (readdir $fh) {
		1119	$ext !~ /^\./
		1120	and open my $fh, "<", "$dir/$ext"
		1121	or next;
		1122
		1123	my %ext = (dir => $dir);
		1124
		1125	while (<$fh>) {
		1126	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1127	my ($pattern, $type, $desc) = split /:/, $1;
		1128	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1129	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1130	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1131	} else {
		1132	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1133	}
		1134	} elsif (/^#:META:BINDING:(.*)/) {
		1135	my ($keysym, $action) = split /:/, $1;
		1136	$ext{binding}{$keysym} = [$ext, $action];
		1137	} elsif (/^\s*(?:#|$)/) {
		1138	# skip other comments and empty lines
		1139	} else {
		1140	last; # stop parsing on first non-empty non-comment line
		1141	}
		1142	}
		1143
		1144	$meta{ext}{$ext} = \%ext;
		1145	}
		1146	}
		1147
		1148	# and now merge resources and bindings
		1149	while (my ($k, $v) = each %{ $meta{ext} }) {
		1150	#TODO: should check for extensions overriding each other
		1151	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1152	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1153	}
		1154	}
		1155
1199	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1156	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1200		1157
1201	Creates a new terminal, very similar as if you had started it with system	1158	Creates a new terminal, very similar as if you had started it with system
1202	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1159	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1203	hash which defines the environment of the new terminal.	1160	hash which defines the environment of the new terminal.
…		…
1220	}	1177	}
1221		1178
1222	=item $term->destroy	1179	=item $term->destroy
1223		1180
1224	Destroy the terminal object (close the window, free resources	1181	Destroy the terminal object (close the window, free resources
1225	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1182	etc.). Please note that urxvt will not exit as long as any event
1226	watchers (timers, io watchers) are still active.	1183	watchers (timers, io watchers) are still active.
1227		1184
1228	=item $term->exec_async ($cmd[, @args])	1185	=item $term->exec_async ($cmd[, @args])
1229		1186
1230	Works like the combination of the C<fork>/C<exec> builtins, which executes	1187	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1257	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1214	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1258		1215
1259	Here is a likely non-exhaustive list of option names, please see the	1216	Here is a likely non-exhaustive list of option names, please see the
1260	source file F</src/optinc.h> to see the actual list:	1217	source file F</src/optinc.h> to see the actual list:
1261		1218
1262	borderLess console cursorBlink cursorUnderline hold iconic insecure	1219	borderLess buffered console cursorBlink cursorUnderline hold iconic
1263	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1220	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1264	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1221	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1265	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1222	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1266	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1223	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1267	transparent tripleclickwords utmpInhibit visualBell	1224	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1225	urgentOnBell utmpInhibit visualBell
1268		1226
1269	=item $value = $term->resource ($name[, $newval])	1227	=item $value = $term->resource ($name[, $newval])
1270		1228
1271	Returns the current resource value associated with a given name and	1229	Returns the current resource value associated with a given name and
1272	optionally sets a new value. Setting values is most useful in the C<init>	1230	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1285		1243
1286	Here is a likely non-exhaustive list of resource names, not all of which	1244	Here is a likely non-exhaustive list of resource names, not all of which
1287	are supported in every build, please see the source file F</src/rsinc.h>	1245	are supported in every build, please see the source file F</src/rsinc.h>
1288	to see the actual list:	1246	to see the actual list:
1289		1247
1290	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1248	answerbackstring backgroundPixmap backspace_key blurradius
1291	borderLess color cursorBlink cursorUnderline cutchars delete_key	1249	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1292	display_name embed ext_bwidth fade font geometry hold iconName	1250	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1293	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1251	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1252	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1294	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1253	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1295	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1254	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1296	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1255	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1297	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1256	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1298	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1257	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1299	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1258	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1300	secondaryScreen secondaryScroll selectstyle shade term_name title	1259	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1301	transient_for transparent transparent_all tripleclickwords utmpInhibit	1260	term_name title transient_for transparent tripleclickwords urgentOnBell
1302	visualBell	1261	utmpInhibit visualBell
1303		1262
1304	=cut	1263	=cut
1305		1264
1306	sub resource($$;$) {	1265	sub resource($$;$) {
1307	my ($self, $name) = (shift, shift);	1266	my ($self, $name) = (shift, shift);
1308	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1267	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1309	&urxvt::term::_resource	1268	goto &urxvt::term::_resource
1310	}	1269	}
1311		1270
1312	=item $value = $term->x_resource ($pattern)	1271	=item $value = $term->x_resource ($pattern)
1313		1272
1314	Returns the X-Resource for the given pattern, excluding the program or	1273	Returns the X-Resource for the given pattern, excluding the program or
1315	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1274	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1316	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1275	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1317	resource with that pattern exists.	1276	resource with that pattern exists.
1318		1277
		1278	Extensions that define extra resource or command line arguments also need
		1279	to call this method to access their values.
		1280
		1281	If the method is called on an extension object (basically, from an
		1282	extension), then the special prefix C<%.> will be replaced by the name of
		1283	the extension and a dot, and the lone string C<%> will be replaced by the
		1284	extension name itself. This makes it possible to code extensions so you
		1285	can rename them and get a new set of commandline switches and resources
		1286	without having to change the actual code.
		1287
1319	This method should only be called during the C<on_start> hook, as there is	1288	This method should only be called during the C<on_start> hook, as there is
1320	only one resource database per display, and later invocations might return	1289	only one resource database per display, and later invocations might return
1321	the wrong resources.	1290	the wrong resources.
1322		1291
1323	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1292	=item $value = $term->x_resource_boolean ($pattern)
1324		1293
		1294	Like C<x_resource>, above, but interprets the string value as a boolean
		1295	and returns C<1> for true values, C<0> for false values and C<undef> if
		1296	the resource or option isn't specified.
		1297
		1298	You should always use this method to parse boolean resources.
		1299
		1300	=cut
		1301
		1302	sub x_resource_boolean {
		1303	my $res = &x_resource;
		1304
		1305	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1306	}
		1307
		1308	=item $success = $term->bind_action ($key, $octets)
		1309
1325	Adds a keymap translation exactly as specified via a resource. See the	1310	Adds a key binding exactly as specified via a C<keysym> resource. See the
1326	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1311	C<keysym> resource in the urxvt(1) manpage.
1327		1312
1328	=item $rend = $term->rstyle ([$new_rstyle])	1313	=item $rend = $term->rstyle ([$new_rstyle])
1329		1314
1330	Return and optionally change the current rendition. Text that is output by	1315	Return and optionally change the current rendition. Text that is output by
1331	the terminal application will use this style.	1316	the terminal application will use this style.
…		…
1339		1324
1340	=item ($row, $col) = $term->selection_beg ([$row, $col])	1325	=item ($row, $col) = $term->selection_beg ([$row, $col])
1341		1326
1342	=item ($row, $col) = $term->selection_end ([$row, $col])	1327	=item ($row, $col) = $term->selection_end ([$row, $col])
1343		1328
1344	Return the current values of the selection mark, begin or end positions,	1329	Return the current values of the selection mark, begin or end positions.
1345	and optionally set them to new values.	1330
		1331	When arguments are given, then the selection coordinates are set to
		1332	C<$row> and C<$col>, and the selection screen is set to the current
		1333	screen.
		1334
		1335	=item $screen = $term->selection_screen ([$screen])
		1336
		1337	Returns the current selection screen, and then optionally sets it.
1346		1338
1347	=item $term->selection_make ($eventtime[, $rectangular])	1339	=item $term->selection_make ($eventtime[, $rectangular])
1348		1340
1349	Tries to make a selection as set by C<selection_beg> and	1341	Tries to make a selection as set by C<selection_beg> and
1350	C<selection_end>. If C<$rectangular> is true (default: false), a	1342	C<selection_end>. If C<$rectangular> is true (default: false), a
1351	rectangular selection will be made. This is the prefered function to make	1343	rectangular selection will be made. This is the preferred function to make
1352	a selection.	1344	a selection.
1353		1345
1354	=item $success = $term->selection_grab ($eventtime)	1346	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1355		1347
1356	Try to request the primary selection text from the server (for example, as	1348	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1349	true) selection from the server. The corresponding text can be set
1357	set by the next method). No visual feedback will be given. This function	1350	with the next method. No visual feedback will be given. This function
1358	is mostly useful from within C<on_sel_grab> hooks.	1351	is mostly useful from within C<on_sel_grab> hooks.
1359		1352
1360	=item $oldtext = $term->selection ([$newtext])	1353	=item $oldtext = $term->selection ([$newtext, $clipboard])
1361		1354
1362	Return the current selection text and optionally replace it by C<$newtext>.	1355	Return the current selection (clipboard if C<$clipboard> is true) text
		1356	and optionally replace it by C<$newtext>.
		1357
		1358	=item $term->selection_clear ([$clipboard])
		1359
		1360	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1363		1361
1364	=item $term->overlay_simple ($x, $y, $text)	1362	=item $term->overlay_simple ($x, $y, $text)
1365		1363
1366	Create a simple multi-line overlay box. See the next method for details.	1364	Create a simple multi-line overlay box. See the next method for details.
1367		1365
…		…
1397		1395
1398	The methods currently supported on C<urxvt::overlay> objects are:	1396	The methods currently supported on C<urxvt::overlay> objects are:
1399		1397
1400	=over 4	1398	=over 4
1401		1399
1402	=item $overlay->set ($x, $y, $text, $rend)	1400	=item $overlay->set ($x, $y, $text[, $rend])
1403		1401
1404	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1402	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1405	text in rxvt-unicode's special encoding and an array of rendition values	1403	text in rxvt-unicode's special encoding and an array of rendition values
1406	at a specific position inside the overlay.	1404	at a specific position inside the overlay.
		1405
		1406	If C<$rend> is missing, then the rendition will not be changed.
1407		1407
1408	=item $overlay->hide	1408	=item $overlay->hide
1409		1409
1410	If visible, hide the overlay, but do not destroy it.	1410	If visible, hide the overlay, but do not destroy it.
1411		1411
…		…
1493	locale-specific encoding of the terminal and can contain command sequences	1493	locale-specific encoding of the terminal and can contain command sequences
1494	(escape codes) that will be interpreted.	1494	(escape codes) that will be interpreted.
1495		1495
1496	=item $term->tt_write ($octets)	1496	=item $term->tt_write ($octets)
1497		1497
1498	Write the octets given in C<$data> to the tty (i.e. as program input). To	1498	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1499	pass characters instead of octets, you should convert your strings first	1499	pass characters instead of octets, you should convert your strings first
1500	to the locale-specific encoding using C<< $term->locale_encode >>.	1500	to the locale-specific encoding using C<< $term->locale_encode >>.
		1501
		1502	=item $term->tt_write_user_input ($octets)
		1503
		1504	Like C<tt_write>, but should be used when writing strings in response to
		1505	the user pressing a key, to invoke the additional actions requested by
		1506	the user for that case (C<tt_write> doesn't do that).
		1507
		1508	The typical use case would be inside C<on_action> hooks.
		1509
		1510	=item $term->tt_paste ($octets)
		1511
		1512	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1513	CR and bracketing the data with control sequences if bracketed paste mode
		1514	is set.
1501		1515
1502	=item $old_events = $term->pty_ev_events ([$new_events])	1516	=item $old_events = $term->pty_ev_events ([$new_events])
1503		1517
1504	Replaces the event mask of the pty watcher by the given event mask. Can	1518	Replaces the event mask of the pty watcher by the given event mask. Can
1505	be used to suppress input and output handling to the pty/tty. See the	1519	be used to suppress input and output handling to the pty/tty. See the
…		…
1524	Adds the specified events to the vt event mask. Useful e.g. when you want	1538	Adds the specified events to the vt event mask. Useful e.g. when you want
1525	to receive pointer events all the times:	1539	to receive pointer events all the times:
1526		1540
1527	$term->vt_emask_add (urxvt::PointerMotionMask);	1541	$term->vt_emask_add (urxvt::PointerMotionMask);
1528		1542
		1543	=item $term->set_urgency ($set)
		1544
		1545	Enable/disable the urgency hint on the toplevel window.
		1546
1529	=item $term->focus_in	1547	=item $term->focus_in
1530		1548
1531	=item $term->focus_out	1549	=item $term->focus_out
1532		1550
1533	=item $term->key_press ($state, $keycode[, $time])	1551	=item $term->key_press ($state, $keycode[, $time])
…		…
1621		1639
1622	Used after changing terminal contents to display them.	1640	Used after changing terminal contents to display them.
1623		1641
1624	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1642	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1625		1643
1626	Returns the text of the entire row with number C<$row_number>. Row C<0>	1644	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1627	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1645	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1628	terminal line. The scrollback buffer starts at line C<-1> and extends to
1629	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1646	terminal line. Nothing will be returned if a nonexistent line
1630	is requested.	1647	is requested.
1631		1648
1632	If C<$new_text> is specified, it will replace characters in the current	1649	If C<$new_text> is specified, it will replace characters in the current
1633	line, starting at column C<$start_col> (default C<0>), which is useful	1650	line, starting at column C<$start_col> (default C<0>), which is useful
1634	to replace only parts of a line. The font index in the rendition will	1651	to replace only parts of a line. The font index in the rendition will
1635	automatically be updated.	1652	automatically be updated.
1636		1653
1637	C<$text> is in a special encoding: tabs and wide characters that use more	1654	C<$text> is in a special encoding: tabs and wide characters that use more
1638	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1655	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1639	characters. Characters with combining characters and other characters that	1656	characters. Characters with combining characters and other characters that
1640	do not fit into the normal tetx encoding will be replaced with characters	1657	do not fit into the normal text encoding will be replaced with characters
1641	in the private use area.	1658	in the private use area.
1642		1659
1643	You have to obey this encoding when changing text. The advantage is	1660	You have to obey this encoding when changing text. The advantage is
1644	that C<substr> and similar functions work on screen cells and not on	1661	that C<substr> and similar functions work on screen cells and not on
1645	characters.	1662	characters.
…		…
1730	}	1747	}
1731		1748
1732	sub urxvt::line::t {	1749	sub urxvt::line::t {
1733	my ($self) = @_;	1750	my ($self) = @_;
1734		1751
1735	if (@_ > 1)	1752	if (@_ > 1) {
1736	{
1737	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1753	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1738	for $self->{beg} .. $self->{end};	1754	for $self->{beg} .. $self->{end};
1739	}	1755	}
1740		1756
1741	defined wantarray &&	1757	defined wantarray &&
1742	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1758	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1743	0, $self->{len}	1759	0, $self->{len}
1744	}	1760	}
1745		1761
1746	sub urxvt::line::r {	1762	sub urxvt::line::r {
1747	my ($self) = @_;	1763	my ($self) = @_;
1748		1764
1749	if (@_ > 1)	1765	if (@_ > 1) {
1750	{
1751	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1766	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1752	for $self->{beg} .. $self->{end};	1767	for $self->{beg} .. $self->{end};
1753	}	1768	}
1754		1769
1755	if (defined wantarray) {	1770	if (defined wantarray) {
1756	my $rend = [	1771	my $rend = [
1757	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1772	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1758	];	1773	];
…		…
1820	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1835	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1821	recent grab.	1836	recent grab.
1822		1837
1823	=item $term->ungrab	1838	=item $term->ungrab
1824		1839
1825	Calls XUngrab for the most recent grab. Is called automatically on	1840	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1826	evaluation errors, as it is better to lose the grab in the error case as	1841	evaluation errors, as it is better to lose the grab in the error case as
1827	the session.	1842	the session.
1828		1843
1829	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1844	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1830		1845
…		…
1832		1847
1833	=item @atoms = $term->XListProperties ($window)	1848	=item @atoms = $term->XListProperties ($window)
1834		1849
1835	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1850	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1836		1851
1837	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1852	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1838		1853
1839	=item $term->XDeleteProperty ($window, $property)	1854	=item $term->XDeleteProperty ($window, $property)
1840		1855
1841	=item $window = $term->DefaultRootWindow	1856	=item $window = $term->DefaultRootWindow
1842		1857
…		…
1849	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1864	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1850		1865
1851	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1866	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1852		1867
1853	=item $term->XChangeInput ($window, $add_events[, $del_events])	1868	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1869
		1870	=item $keysym = $term->XStringToKeysym ($string)
		1871
		1872	=item $string = $term->XKeysymToString ($keysym)
1854		1873
1855	Various X or X-related functions. The C<$term> object only serves as	1874	Various X or X-related functions. The C<$term> object only serves as
1856	the source of the display, otherwise those functions map more-or-less	1875	the source of the display, otherwise those functions map more-or-less
1857	directory onto the X functions of the same name.	1876	directly onto the X functions of the same name.
1858		1877
1859	=back	1878	=back
1860		1879
1861	=cut	1880	=cut
1862		1881
…		…
1964	my $env = $self->{term}->env;	1983	my $env = $self->{term}->env;
1965	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1984	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1966	delete $env->{LC_ALL};	1985	delete $env->{LC_ALL};
1967	$env->{LC_CTYPE} = $self->{term}->locale;	1986	$env->{LC_CTYPE} = $self->{term}->locale;
1968		1987
1969	urxvt::term->new ($env, "popup",	1988	my $term = urxvt::term->new (
		1989	$env, "popup",
1970	"--perl-lib" => "", "--perl-ext-common" => "",	1990	"--perl-lib" => "", "--perl-ext-common" => "",
1971	"-pty-fd" => -1, "-sl" => 0,	1991	"-pty-fd" => -1, "-sl" => 0,
1972	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1992	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1973	"--transient-for" => $self->{term}->parent,	1993	"--transient-for" => $self->{term}->parent,
1974	"-display" => $self->{term}->display_id,	1994	"-display" => $self->{term}->display_id,
1975	"-pe" => "urxvt-popup")	1995	"-pe" => "urxvt-popup",
1976	or die "unable to create popup window\n";	1996	) or die "unable to create popup window\n";
		1997
		1998	unless (delete $term->{urxvt_popup_init_done}) {
		1999	$term->ungrab;
		2000	$term->destroy;
		2001	die "unable to initialise popup window\n";
		2002	}
1977	}	2003	}
1978		2004
1979	sub DESTROY {	2005	sub DESTROY {
1980	my ($self) = @_;	2006	my ($self) = @_;
1981		2007
…		…
1999	->new	2025	->new
2000	->interval (1)	2026	->interval (1)
2001	->cb (sub {	2027	->cb (sub {
2002	$term->{overlay}->set (0, 0,	2028	$term->{overlay}->set (0, 0,
2003	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2029	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2004	});	2030	});
2005		2031
2006	=over 4	2032	=over 4
2007		2033
2008	=item $timer = new urxvt::timer	2034	=item $timer = new urxvt::timer
2009		2035
…		…
2012		2038
2013	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2039	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2014		2040
2015	Set the callback to be called when the timer triggers.	2041	Set the callback to be called when the timer triggers.
2016		2042
2017	=item $tstamp = $timer->at
2018
2019	Return the time this watcher will fire next.
2020
2021	=item $timer = $timer->set ($tstamp)	2043	=item $timer = $timer->set ($tstamp[, $interval])
2022		2044
2023	Set the time the event is generated to $tstamp.	2045	Set the time the event is generated to $tstamp (and optionally specifies a
		2046	new $interval).
2024		2047
2025	=item $timer = $timer->interval ($interval)	2048	=item $timer = $timer->interval ($interval)
2026		2049
2027	Normally (and when C<$interval> is C<0>), the timer will automatically	2050	By default (and when C<$interval> is C<0>), the timer will automatically
2028	stop after it has fired once. If C<$interval> is non-zero, then the timer	2051	stop after it has fired once. If C<$interval> is non-zero, then the timer
2029	is automatically rescheduled at the given intervals.	2052	is automatically rescheduled at the given intervals.
2030		2053
2031	=item $timer = $timer->start	2054	=item $timer = $timer->start
2032		2055
2033	Start the timer.	2056	Start the timer.
2034		2057
2035	=item $timer = $timer->start ($tstamp)	2058	=item $timer = $timer->start ($tstamp[, $interval])
2036		2059
2037	Set the event trigger time to C<$tstamp> and start the timer.	2060	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2061	also replaces the interval.
2038		2062
2039	=item $timer = $timer->after ($delay)	2063	=item $timer = $timer->after ($delay[, $interval])
2040		2064
2041	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2065	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2042		2066
2043	=item $timer = $timer->stop	2067	=item $timer = $timer->stop
2044		2068
…		…
2052		2076
2053	$term->{socket} = ...	2077	$term->{socket} = ...
2054	$term->{iow} = urxvt::iow	2078	$term->{iow} = urxvt::iow
2055	->new	2079	->new
2056	->fd (fileno $term->{socket})	2080	->fd (fileno $term->{socket})
2057	->events (urxvt::EVENT_READ)	2081	->events (urxvt::EV_READ)
2058	->start	2082	->start
2059	->cb (sub {	2083	->cb (sub {
2060	my ($iow, $revents) = @_;	2084	my ($iow, $revents) = @_;
2061	# $revents must be 1 here, no need to check	2085	# $revents must be 1 here, no need to check
2062	sysread $term->{socket}, my $buf, 8192	2086	sysread $term->{socket}, my $buf, 8192
…		…
2080	Set the file descriptor (not handle) to watch.	2104	Set the file descriptor (not handle) to watch.
2081		2105
2082	=item $iow = $iow->events ($eventmask)	2106	=item $iow = $iow->events ($eventmask)
2083		2107
2084	Set the event mask to watch. The only allowed values are	2108	Set the event mask to watch. The only allowed values are
2085	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2109	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2086	together, or C<urxvt::EVENT_NONE>.	2110	together, or C<urxvt::EV_NONE>.
2087		2111
2088	=item $iow = $iow->start	2112	=item $iow = $iow->start
2089		2113
2090	Start watching for requested events on the given handle.	2114	Start watching for requested events on the given handle.
2091		2115
…		…
2132	->new	2156	->new
2133	->start ($pid)	2157	->start ($pid)
2134	->cb (sub {	2158	->cb (sub {
2135	my ($pw, $exit_status) = @_;	2159	my ($pw, $exit_status) = @_;
2136	...	2160	...
2137	});	2161	});
2138		2162
2139	=over 4	2163	=over 4
2140		2164
2141	=item $pw = new urxvt::pw	2165	=item $pw = new urxvt::pw
2142		2166
…		…
2175		2199
2176	=back	2200	=back
2177		2201
2178	=head1 AUTHOR	2202	=head1 AUTHOR
2179		2203
2180	Marc Lehmann <pcg@goof.com>	2204	Marc Lehmann <schmorp@schmorp.de>
2181	http://software.schmorp.de/pkg/rxvt-unicode	2205	http://software.schmorp.de/pkg/rxvt-unicode
2182		2206
2183	=cut	2207	=cut
2184		2208
2185	1	2209	1

Diff Legend

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