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.156 by ayin, Wed Aug 1 17:55:37 2007 UTC vs.
Revision 1.231 by root, Sun Apr 27 20:26:28 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 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 leats 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 thats 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 ti 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
		295	=item on_register_command $term, $keysym, $modifiermask, $string
		296
		297	Called after parsing a keysym resource but before registering the
		298	associated binding. If this hook returns a true value the binding
		299	is not registered. It can be used to modify a binding by calling
		300	C<register_command>.
		301
629	=item on_resize_all_windows $tern, $new_width, $new_height	302	=item on_resize_all_windows $term, $new_width, $new_height
630		303
631	Called just after the new window size has been calculated, but before	304	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	305	windows are actually being resized or hints are being set. If this hook
633	returns TRUE, setting of the window hints is being skipped.	306	returns a true value, setting of the window hints is being skipped.
634		307
635	=item on_x_event $term, $event	308	=item on_x_event $term, $event
636		309
637	Called on every X event received on the vt window (and possibly other	310	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	311	windows). Should only be used as a last resort. Most event structure
…		…
668		341
669	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
670		343
671	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
672		345
673	Called whenever the corresponding X event is received for the terminal If	346	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.	347	the hook returns true, then the event will be ignored by rxvt-unicode.
675		348
676	The event is a hash with most values as named by Xlib (see the XEvent	349	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	350	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.	351	(real, not screen-based) row and column under the mouse cursor.
679		352
680	C<on_key_press> additionally receives the string rxvt-unicode would	353	C<on_key_press> additionally receives the string rxvt-unicode would
681	output, if any, in locale-specific encoding.	354	output, if any, in locale-specific encoding.
682		355
683	subwindow.
684
685	=item on_client_message $term, $event	356	=item on_client_message $term, $event
686		357
687	=item on_wm_protocols $term, $event	358	=item on_wm_protocols $term, $event
688		359
689	=item on_wm_delete_window $term, $event	360	=item on_wm_delete_window $term, $event
690		361
691	Called when various types of ClientMessage events are received (all with	362	Called when various types of ClientMessage events are received (all with
692	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	363	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
693		364
		365	=item on_bell $term
		366
		367	Called on receipt of a bell character.
		368
694	=back	369	=back
695		370
696	=cut	371	=cut
697		372
698	package urxvt;	373	package urxvt;
699		374
700	use utf8;	375	use utf8;
701	use strict;	376	use strict 'vars';
702	use Carp ();	377	use Carp ();
703	use Scalar::Util ();	378	use Scalar::Util ();
704	use List::Util ();	379	use List::Util ();
705		380
706	our $VERSION = 1;	381	our $VERSION = 1;
707	our $TERM;	382	our $TERM;
708	our @TERM_INIT;	383	our @TERM_INIT; # should go, prevents async I/O etc.
709	our @TERM_EXT;	384	our @TERM_EXT; # should go, prevents async I/O etc.
710	our @HOOKNAME;	385	our @HOOKNAME;
711	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	386	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
712	our %OPTION;	387	our %OPTION;
713		388
714	our $LIBDIR;	389	our $LIBDIR;
…		…
762		437
763	=over 4	438	=over 4
764		439
765	=item urxvt::fatal $errormessage	440	=item urxvt::fatal $errormessage
766		441
767	Fatally aborts execution with the given error message. Avoid at all	442	Fatally aborts execution with the given error message (which should
768	costs! The only time this is acceptable is when the terminal process	443	include a trailing newline). Avoid at all costs! The only time this
769	starts up.	444	is acceptable (and useful) is in the init hook, where it prevents the
		445	terminal from starting up.
770		446
771	=item urxvt::warn $string	447	=item urxvt::warn $string
772		448
773	Calls C<rxvt_warn> with the given string which should not include a	449	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	450	newline. The module also overwrites the C<warn> builtin with a function
775	that calls this function.	451	that calls this function.
776		452
777	Using this function has the advantage that its output ends up in the	453	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.	454	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
782	=item @terms = urxvt::termlist	458	=item @terms = urxvt::termlist
783		459
784	Returns all urxvt::term objects that exist in this process, regardless of	460	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	461	whether they are started, being destroyed etc., so be careful. Only term
786	objects that have perl extensions attached will be returned (because there	462	objects that have perl extensions attached will be returned (because there
787	is no urxvt::term objet associated with others).	463	is no urxvt::term object associated with others).
788		464
789	=item $time = urxvt::NOW	465	=item $time = urxvt::NOW
790		466
791	Returns the "current time" (as per the event loop).	467	Returns the "current time" (as per the event loop).
792		468
…		…
835		511
836	=item $rend = urxvt::OVERLAY_RSTYLE	512	=item $rend = urxvt::OVERLAY_RSTYLE
837		513
838	Return the rendition mask used for overlays by default.	514	Return the rendition mask used for overlays by default.
839		515
840	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	516	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		517	urxvt::RS_RVid, urxvt::RS_Uline
841		518
842	Return the bit that enabled bold, italic, blink, reverse-video and	519	Return the bit that enabled bold, italic, blink, reverse-video and
843	underline, respectively. To enable such a style, just logically OR it into	520	underline, respectively. To enable such a style, just logically OR it into
844	the bitset.	521	the bitset.
845		522
…		…
882	};	559	};
883	}	560	}
884		561
885	no warnings 'utf8';	562	no warnings 'utf8';
886		563
		564	sub parse_resource {
		565	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		566
		567	$name =~ y/-/./ if $isarg;
		568
		569	$term->scan_meta;
		570
		571	my $r = $term->{meta}{resource};
		572	keys %$r; # reset iterator
		573	while (my ($pattern, $v) = each %$r) {
		574	if (
		575	$pattern =~ /\.$/
		576	? $pattern eq substr $name, 0, length $pattern
		577	: $pattern eq $name
		578	) {
		579	$name = "$urxvt::RESCLASS.$name";
		580
		581	push @{ $term->{perl_ext_3} }, $v->[0];
		582
		583	if ($v->[1] eq "boolean") {
		584	$term->put_option_db ($name, $flag ? "true" : "false");
		585	return 1;
		586	} else {
		587	$term->put_option_db ($name, $value);
		588	return 1 + 2;
		589	}
		590	}
		591	}
		592
		593	0
		594	}
		595
		596	sub usage {
		597	my ($term, $usage_type) = @_;
		598
		599	$term->scan_meta;
		600
		601	my $r = $term->{meta}{resource};
		602
		603	for my $pattern (sort keys %$r) {
		604	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		605
		606	$desc .= " (-pe $ext)";
		607
		608	if ($usage_type == 1) {
		609	$pattern =~ y/./-/;
		610	$pattern =~ s/-$/-.../g;
		611
		612	if ($type eq "boolean") {
		613	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		614	} else {
		615	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		616	}
		617	} else {
		618	$pattern =~ s/\.$/.*/g;
		619	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		620	}
		621	}
		622	}
		623
887	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	624	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
888		625
889	sub verbose {	626	sub verbose {
890	my ($level, $msg) = @_;	627	my ($level, $msg) = @_;
891	warn "$msg\n" if $level <= $verbosity;	628	warn "$msg\n" if $level <= $verbosity;
…		…
903	$pkg =~ s/[^[:word:]]/_/g;	640	$pkg =~ s/[^[:word:]]/_/g;
904	$pkg = "urxvt::ext::$pkg";	641	$pkg = "urxvt::ext::$pkg";
905		642
906	verbose 3, "loading extension '$path' into package '$pkg'";	643	verbose 3, "loading extension '$path' into package '$pkg'";
907		644
		645	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		646
908	open my $fh, "<:raw", $path	647	open my $fh, "<:raw", $path
909	or die "$path: $!";	648	or die "$path: $!";
910		649
911	my $source =	650	my $source =
912	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	651	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
913	. "#line 1 \"$path\"\n{\n"	652	. "#line 1 \"$path\"\n{\n"
914	. (do { local $/; <$fh> })	653	. (do { local $/; <$fh> })
915	. "\n};\n1";	654	. "\n};\n1";
916		655
917	eval $source	656	eval $source
…		…
926	# called by the rxvt core	665	# called by the rxvt core
927	sub invoke {	666	sub invoke {
928	local $TERM = shift;	667	local $TERM = shift;
929	my $htype = shift;	668	my $htype = shift;
930		669
931	if ($htype == 0) { # INIT	670	if ($htype == HOOK_INIT) {
932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	671	my @dirs = $TERM->perl_libdirs;
933		672
934	my %ext_arg;	673	my %ext_arg;
935		674
936	{	675	{
937	my @init = @TERM_INIT;	676	my @init = @TERM_INIT;
938	@TERM_INIT = ();	677	@TERM_INIT = ();
…		…
940	my @pkg = @TERM_EXT;	679	my @pkg = @TERM_EXT;
941	@TERM_EXT = ();	680	@TERM_EXT = ();
942	$TERM->register_package ($_) for @pkg;	681	$TERM->register_package ($_) for @pkg;
943	}	682	}
944		683
		684	for (
		685	@{ delete $TERM->{perl_ext_3} },
945	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	686	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		687	) {
946	if ($_ eq "default") {	688	if ($_ eq "default") {
947	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	689	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
948	} elsif (/^-(.*)$/) {	690	} elsif (/^-(.*)$/) {
949	delete $ext_arg{$1};	691	delete $ext_arg{$1};
950	} elsif (/^([^<]+)<(.*)>$/) {	692	} elsif (/^([^<]+)<(.*)>$/) {
…		…
972		714
973	if (my $cb = $TERM->{_hook}[$htype]) {	715	if (my $cb = $TERM->{_hook}[$htype]) {
974	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	716	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
975	if $verbosity >= 10;	717	if $verbosity >= 10;
976		718
977	for my $pkg (keys %$cb) {	719	for my $pkg (
		720	# this hook is only sent to the extension with the name
		721	# matching the first arg
		722	$htype == HOOK_KEYBOARD_DISPATCH
		723	? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
		724	: keys %$cb
		725	) {
978	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	726	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
979	$retval ||= $retval_;	727	$retval ||= $retval_;
980		728
981	if ($@) {	729	if ($@) {
982	$TERM->ungrab; # better to lose the grab than the session	730	$TERM->ungrab; # better to lose the grab than the session
983	warn $@;	731	warn $@;
…		…
986		734
987	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	735	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
988	if $verbosity >= 11;	736	if $verbosity >= 11;
989	}	737	}
990		738
991	if ($htype == 1) { # DESTROY	739	if ($htype == HOOK_DESTROY) {
992	# clear package objects	740	# clear package objects
993	%$_ = () for values %{ $TERM->{_pkg} };	741	%$_ = () for values %{ $TERM->{_pkg} };
994		742
995	# clear package	743	# clear package
996	%$TERM = ();	744	%$TERM = ();
…		…
1026	}	774	}
1027	}	775	}
1028	($mask, @color{qw(fg bg)}, \@failed)	776	($mask, @color{qw(fg bg)}, \@failed)
1029	}	777	}
1030		778
1031	# urxvt::term::extension
1032
1033	package urxvt::term::extension;	779	package urxvt::term::extension;
1034		780
1035	sub enable {	781	=head2 The C<urxvt::term::extension> class
1036	my ($self, %hook) = @_;
1037	my $pkg = $self->{_pkg};
1038		782
1039	while (my ($name, $cb) = each %hook) {	783	Each extension attached to a terminal object is represented by
1040	my $htype = $HOOKTYPE{uc $name};	784	a C<urxvt::term::extension> object.
1041	defined $htype
1042	or Carp::croak "unsupported hook type '$name'";
1043		785
1044	$self->set_should_invoke ($htype, +1)	786	You can use these objects, which are passed to all callbacks to store any
1045	unless exists $self->{term}{_hook}[$htype]{$pkg};	787	state related to the terminal and extension instance.
1046		788
1047	$self->{term}{_hook}[$htype]{$pkg} = $cb;	789	The methods (And data members) documented below can be called on extension
1048	}	790	objects, in addition to call methods documented for the <urxvt::term>
1049	}	791	class.
1050		792
1051	sub disable {	793	=over 4
1052	my ($self, @hook) = @_;
1053	my $pkg = $self->{_pkg};
1054		794
1055	for my $name (@hook) {	795	=item $urxvt_term = $self->{term}
1056	my $htype = $HOOKTYPE{uc $name};
1057	defined $htype
1058	or Carp::croak "unsupported hook type '$name'";
1059		796
1060	$self->set_should_invoke ($htype, -1)	797	Returns the C<urxvt::term> object associated with this instance of the
1061	if delete $self->{term}{_hook}[$htype]{$pkg};	798	extension. This member I<must not> be changed in any way.
1062	}	799
1063	}	800	=cut
1064		801
1065	our $AUTOLOAD;	802	our $AUTOLOAD;
1066		803
1067	sub AUTOLOAD {	804	sub AUTOLOAD {
1068	$AUTOLOAD =~ /:([^:]+)$/	805	$AUTOLOAD =~ /:([^:]+)$/
…		…
1081		818
1082	sub DESTROY {	819	sub DESTROY {
1083	# nop	820	# nop
1084	}	821	}
1085		822
1086	# urxvt::destroy_hook	823	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1087		824
1088	sub urxvt::destroy_hook::DESTROY {	825	sub urxvt::destroy_hook::DESTROY {
1089	${$_[0]}->();	826	${$_[0]}->();
1090	}	827	}
1091		828
1092	sub urxvt::destroy_hook(&) {	829	sub urxvt::destroy_hook(&) {
1093	bless \shift, urxvt::destroy_hook::	830	bless \shift, urxvt::destroy_hook::
1094	}	831	}
		832
		833	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		834
		835	Dynamically enable the given hooks (named without the C<on_> prefix) for
		836	this extension, replacing any hook previously installed via C<enable> in
		837	this extension.
		838
		839	This is useful when you want to overwrite time-critical hooks only
		840	temporarily.
		841
		842	To install additional callbacks for the same hook, you can use the C<on>
		843	method of the C<urxvt::term> class.
		844
		845	=item $self->disable ($hook_name[, $hook_name..])
		846
		847	Dynamically disable the given hooks.
		848
		849	=cut
		850
		851	sub enable {
		852	my ($self, %hook) = @_;
		853	my $pkg = $self->{_pkg};
		854
		855	while (my ($name, $cb) = each %hook) {
		856	my $htype = $HOOKTYPE{uc $name};
		857	defined $htype
		858	or Carp::croak "unsupported hook type '$name'";
		859
		860	$self->set_should_invoke ($htype, +1)
		861	unless exists $self->{term}{_hook}[$htype]{$pkg};
		862
		863	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		864	}
		865	}
		866
		867	sub disable {
		868	my ($self, @hook) = @_;
		869	my $pkg = $self->{_pkg};
		870
		871	for my $name (@hook) {
		872	my $htype = $HOOKTYPE{uc $name};
		873	defined $htype
		874	or Carp::croak "unsupported hook type '$name'";
		875
		876	$self->set_should_invoke ($htype, -1)
		877	if delete $self->{term}{_hook}[$htype]{$pkg};
		878	}
		879	}
		880
		881	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		882
		883	Similar to the C<enable> enable, but installs additional callbacks for
		884	the given hook(s) (that is, it doesn't replace existing callbacks), and
		885	returns a guard object. When the guard object is destroyed the callbacks
		886	are disabled again.
		887
		888	=cut
		889
		890	sub urxvt::extension::on_disable::DESTROY {
		891	my $disable = shift;
		892
		893	my $term = delete $disable->{""};
		894
		895	while (my ($htype, $id) = each %$disable) {
		896	delete $term->{_hook}[$htype]{$id};
		897	$term->set_should_invoke ($htype, -1);
		898	}
		899	}
		900
		901	sub on {
		902	my ($self, %hook) = @_;
		903
		904	my $term = $self->{term};
		905
		906	my %disable = ( "" => $term );
		907
		908	while (my ($name, $cb) = each %hook) {
		909	my $htype = $HOOKTYPE{uc $name};
		910	defined $htype
		911	or Carp::croak "unsupported hook type '$name'";
		912
		913	$term->set_should_invoke ($htype, +1);
		914	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		915	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		916	}
		917
		918	bless \%disable, "urxvt::extension::on_disable"
		919	}
		920
		921	=item $self->x_resource ($pattern)
		922
		923	=item $self->x_resource_boolean ($pattern)
		924
		925	These methods support an additional C<%> prefix when called on an
		926	extension object - see the description of these methods in the
		927	C<urxvt::term> class for details.
		928
		929	=cut
		930
		931	sub x_resource {
		932	my ($self, $name) = @_;
		933	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		934	$self->{term}->x_resource ($name)
		935	}
		936
		937	sub x_resource_boolean {
		938	my ($self, $name) = @_;
		939	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		940	$self->{term}->x_resource_boolean ($name)
		941	}
		942
		943	=back
		944
		945	=cut
1095		946
1096	package urxvt::anyevent;	947	package urxvt::anyevent;
1097		948
1098	=head2 The C<urxvt::anyevent> Class	949	=head2 The C<urxvt::anyevent> Class
1099		950
1100	The sole purpose of this class is to deliver an interface to the	951	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	952	C<AnyEvent> module - any module using it will work inside urxvt without
1102	further programming. The only exception is that you cannot wait on	953	further programming. The only exception is that you cannot wait on
1103	condition variables, but non-blocking condvar use is ok. What this means	954	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		955
1107	=cut	956	In practical terms this means is that you cannot use blocking APIs, but
		957	the non-blocking variant should work.
1108		958
		959	=cut
		960
1109	our $VERSION = 1;	961	our $VERSION = '5.23';
1110		962
1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	963	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	964	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113		965
1114	sub timer {	966	sub timer {
…		…
1116		968
1117	my $cb = $arg{cb};	969	my $cb = $arg{cb};
1118		970
1119	urxvt::timer	971	urxvt::timer
1120	->new	972	->new
1121	->start (urxvt::NOW + $arg{after})	973	->after ($arg{after}, $arg{interval})
1122	->cb (sub {	974	->cb ($arg{interval} ? $cb : sub {
1123	$_[0]->stop; # need to cancel manually	975	$_[0]->stop; # need to cancel manually
1124	$cb->();	976	$cb->();
1125	})	977	})
1126	}	978	}
1127		979
1128	sub io {	980	sub io {
1129	my ($class, %arg) = @_;	981	my ($class, %arg) = @_;
1130		982
1131	my $cb = $arg{cb};	983	my $cb = $arg{cb};
		984	my $fd = fileno $arg{fh};
		985	defined $fd or $fd = $arg{fh};
1132		986
1133	bless [$arg{fh}, urxvt::iow	987	bless [$arg{fh}, urxvt::iow
1134	->new	988	->new
1135	->fd (fileno $arg{fh})	989	->fd ($fd)
1136	->events (($arg{poll} =~ /r/ ? 1 : 0)	990	->events (($arg{poll} =~ /r/ ? 1 : 0)
1137	| ($arg{poll} =~ /w/ ? 2 : 0))	991	| ($arg{poll} =~ /w/ ? 2 : 0))
1138	->start	992	->start
1139	->cb (sub {	993	->cb ($cb)
1140	$cb->(($_[1] & 1 ? 'r' : '')
1141	. ($_[1] & 2 ? 'w' : ''));
1142	})],
1143	urxvt::anyevent::	994	], urxvt::anyevent::
		995	}
		996
		997	sub idle {
		998	my ($class, %arg) = @_;
		999
		1000	my $cb = $arg{cb};
		1001
		1002	urxvt::iw
		1003	->new
		1004	->start
		1005	->cb ($cb)
		1006	}
		1007
		1008	sub child {
		1009	my ($class, %arg) = @_;
		1010
		1011	my $cb = $arg{cb};
		1012
		1013	urxvt::pw
		1014	->new
		1015	->start ($arg{pid})
		1016	->cb (sub {
		1017	$_[0]->stop; # need to cancel manually
		1018	$cb->($_[0]->rpid, $_[0]->rstatus);
		1019	})
1144	}	1020	}
1145		1021
1146	sub DESTROY {	1022	sub DESTROY {
1147	$_[0][1]->stop;	1023	$_[0][1]->stop;
1148	}	1024	}
1149		1025
1150	sub condvar {	1026	# 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 {	1027	sub one_event {
1165	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1028	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1166	}	1029	}
1167		1030
1168	package urxvt::term;	1031	package urxvt::term;
…		…
1183	urxvt::verbose 6, "register package $pkg to $self";	1046	urxvt::verbose 6, "register package $pkg to $self";
1184		1047
1185	@{"$pkg\::ISA"} = urxvt::term::extension::;	1048	@{"$pkg\::ISA"} = urxvt::term::extension::;
1186		1049
1187	my $proxy = bless {	1050	my $proxy = bless {
1188	_pkg => $pkg,	1051	_pkg => $pkg,
		1052	_name => ${"$pkg\::_NAME"}, # hackish
1189	argv => $argv,	1053	argv => $argv,
1190	}, $pkg;	1054	}, $pkg;
1191	Scalar::Util::weaken ($proxy->{term} = $self);	1055	Scalar::Util::weaken ($proxy->{term} = $self);
1192		1056
1193	$self->{_pkg}{$pkg} = $proxy;	1057	$self->{_pkg}{$pkg} = $proxy;
1194		1058
…		…
1197	$proxy->enable ($name => $ref);	1061	$proxy->enable ($name => $ref);
1198	}	1062	}
1199	}	1063	}
1200	}	1064	}
1201		1065
		1066	sub perl_libdirs {
		1067	map { split /:/ }
		1068	$_[0]->resource ("perl_lib"),
		1069	$ENV{URXVT_PERL_LIB},
		1070	"$ENV{HOME}/.urxvt/ext",
		1071	"$LIBDIR/perl"
		1072	}
		1073
		1074	sub scan_meta {
		1075	my ($self) = @_;
		1076	my @libdirs = perl_libdirs $self;
		1077
		1078	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1079
		1080	my %meta;
		1081
		1082	$self->{meta_libdirs} = join "\x00", @libdirs;
		1083	$self->{meta} = \%meta;
		1084
		1085	for my $dir (reverse @libdirs) {
		1086	opendir my $fh, $dir
		1087	or next;
		1088	for my $ext (readdir $fh) {
		1089	$ext !~ /^\./
		1090	and open my $fh, "<", "$dir/$ext"
		1091	or next;
		1092
		1093	while (<$fh>) {
		1094	if (/^#:META:X_RESOURCE:(.*)/) {
		1095	my ($pattern, $type, $desc) = split /:/, $1;
		1096	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1097	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1098	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1099	} else {
		1100	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1101	}
		1102	} elsif (/^\s*(?:#|$)/) {
		1103	# skip other comments and empty lines
		1104	} else {
		1105	last; # stop parsing on first non-empty non-comment line
		1106	}
		1107	}
		1108	}
		1109	}
		1110	}
		1111
1202	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1112	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1203		1113
1204	Creates a new terminal, very similar as if you had started it with system	1114	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	1115	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1206	hash which defines the environment of the new terminal.	1116	hash which defines the environment of the new terminal.
…		…
1223	}	1133	}
1224		1134
1225	=item $term->destroy	1135	=item $term->destroy
1226		1136
1227	Destroy the terminal object (close the window, free resources	1137	Destroy the terminal object (close the window, free resources
1228	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1138	etc.). Please note that urxvt will not exit as long as any event
1229	watchers (timers, io watchers) are still active.	1139	watchers (timers, io watchers) are still active.
1230		1140
1231	=item $term->exec_async ($cmd[, @args])	1141	=item $term->exec_async ($cmd[, @args])
1232		1142
1233	Works like the combination of the C<fork>/C<exec> builtins, which executes	1143	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.	1170	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1261		1171
1262	Here is a likely non-exhaustive list of option names, please see the	1172	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:	1173	source file F</src/optinc.h> to see the actual list:
1264		1174
1265	borderLess console cursorBlink cursorUnderline hold iconic insecure	1175	borderLess buffered console cursorBlink cursorUnderline hold iconic
1266	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1176	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1267	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1177	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1268	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1178	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1269	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1179	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1270	transparent tripleclickwords utmpInhibit visualBell	1180	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1181	urgentOnBell utmpInhibit visualBell
1271		1182
1272	=item $value = $term->resource ($name[, $newval])	1183	=item $value = $term->resource ($name[, $newval])
1273		1184
1274	Returns the current resource value associated with a given name and	1185	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>	1186	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1288		1199
1289	Here is a likely non-exhaustive list of resource names, not all of which	1200	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>	1201	are supported in every build, please see the source file F</src/rsinc.h>
1291	to see the actual list:	1202	to see the actual list:
1292		1203
1293	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1204	answerbackstring backgroundPixmap backspace_key blurradius
1294	borderLess color cursorBlink cursorUnderline cutchars delete_key	1205	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1295	display_name embed ext_bwidth fade font geometry hold iconName	1206	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1296	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1207	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1208	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1297	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1209	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1298	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1210	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1299	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1211	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1212	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1213	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1214	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303	secondaryScreen secondaryScroll selectstyle shade term_name title	1215	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1304	transient_for transparent transparent_all tripleclickwords utmpInhibit	1216	term_name title transient_for transparent tripleclickwords urgentOnBell
1305	visualBell	1217	utmpInhibit visualBell
1306		1218
1307	=cut	1219	=cut
1308		1220
1309	sub resource($$;$) {	1221	sub resource($$;$) {
1310	my ($self, $name) = (shift, shift);	1222	my ($self, $name) = (shift, shift);
1311	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1223	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1312	&urxvt::term::_resource	1224	goto &urxvt::term::_resource
1313	}	1225	}
1314		1226
1315	=item $value = $term->x_resource ($pattern)	1227	=item $value = $term->x_resource ($pattern)
1316		1228
1317	Returns the X-Resource for the given pattern, excluding the program or	1229	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	1230	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	1231	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1320	resource with that pattern exists.	1232	resource with that pattern exists.
1321		1233
		1234	Extensions that define extra resource or command line arguments also need
		1235	to call this method to access their values.
		1236
		1237	If the method is called on an extension object (basically, from an
		1238	extension), then the special prefix C<%.> will be replaced by the name of
		1239	the extension and a dot, and the lone string C<%> will be replaced by the
		1240	extension name itself. This makes it possible to code extensions so you
		1241	can rename them and get a new set of commandline switches and resources
		1242	without having to change the actual code.
		1243
1322	This method should only be called during the C<on_start> hook, as there is	1244	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	1245	only one resource database per display, and later invocations might return
1324	the wrong resources.	1246	the wrong resources.
1325		1247
1326	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1248	=item $value = $term->x_resource_boolean ($pattern)
1327		1249
		1250	Like C<x_resource>, above, but interprets the string value as a boolean
		1251	and returns C<1> for true values, C<0> for false values and C<undef> if
		1252	the resource or option isn't specified.
		1253
		1254	You should always use this method to parse boolean resources.
		1255
		1256	=cut
		1257
		1258	sub x_resource_boolean {
		1259	my $res = &x_resource;
		1260
		1261	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1262	}
		1263
		1264	=item $success = $term->parse_keysym ($key, $octets)
		1265
1328	Adds a keymap translation exactly as specified via a resource. See the	1266	Adds a key binding exactly as specified via a resource. See the
1329	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1267	C<keysym> resource in the urxvt(1) manpage.
		1268
		1269	=item $term->register_command ($keysym, $modifiermask, $string)
		1270
		1271	Adds a key binding. This is a lower level api compared to
		1272	C<parse_keysym>, as it expects a parsed key description, and can be
		1273	used only inside either the C<on_init> hook, to add a binding, or the
		1274	C<on_register_command> hook, to modify a parsed binding.
1330		1275
1331	=item $rend = $term->rstyle ([$new_rstyle])	1276	=item $rend = $term->rstyle ([$new_rstyle])
1332		1277
1333	Return and optionally change the current rendition. Text that is output by	1278	Return and optionally change the current rendition. Text that is output by
1334	the terminal application will use this style.	1279	the terminal application will use this style.
…		…
1342		1287
1343	=item ($row, $col) = $term->selection_beg ([$row, $col])	1288	=item ($row, $col) = $term->selection_beg ([$row, $col])
1344		1289
1345	=item ($row, $col) = $term->selection_end ([$row, $col])	1290	=item ($row, $col) = $term->selection_end ([$row, $col])
1346		1291
1347	Return the current values of the selection mark, begin or end positions,	1292	Return the current values of the selection mark, begin or end positions.
1348	and optionally set them to new values.	1293
		1294	When arguments are given, then the selection coordinates are set to
		1295	C<$row> and C<$col>, and the selection screen is set to the current
		1296	screen.
		1297
		1298	=item $screen = $term->selection_screen ([$screen])
		1299
		1300	Returns the current selection screen, and then optionally sets it.
1349		1301
1350	=item $term->selection_make ($eventtime[, $rectangular])	1302	=item $term->selection_make ($eventtime[, $rectangular])
1351		1303
1352	Tries to make a selection as set by C<selection_beg> and	1304	Tries to make a selection as set by C<selection_beg> and
1353	C<selection_end>. If C<$rectangular> is true (default: false), a	1305	C<selection_end>. If C<$rectangular> is true (default: false), a
1354	rectangular selection will be made. This is the prefered function to make	1306	rectangular selection will be made. This is the preferred function to make
1355	a selection.	1307	a selection.
1356		1308
1357	=item $success = $term->selection_grab ($eventtime)	1309	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1358		1310
1359	Try to request the primary selection text from the server (for example, as	1311	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1312	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	1313	with the next method. No visual feedback will be given. This function
1361	is mostly useful from within C<on_sel_grab> hooks.	1314	is mostly useful from within C<on_sel_grab> hooks.
1362		1315
1363	=item $oldtext = $term->selection ([$newtext])	1316	=item $oldtext = $term->selection ([$newtext, $clipboard])
1364		1317
1365	Return the current selection text and optionally replace it by C<$newtext>.	1318	Return the current selection (clipboard if C<$clipboard> is true) text
		1319	and optionally replace it by C<$newtext>.
		1320
		1321	=item $term->selection_clear ([$clipboard])
		1322
		1323	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1366		1324
1367	=item $term->overlay_simple ($x, $y, $text)	1325	=item $term->overlay_simple ($x, $y, $text)
1368		1326
1369	Create a simple multi-line overlay box. See the next method for details.	1327	Create a simple multi-line overlay box. See the next method for details.
1370		1328
…		…
1400		1358
1401	The methods currently supported on C<urxvt::overlay> objects are:	1359	The methods currently supported on C<urxvt::overlay> objects are:
1402		1360
1403	=over 4	1361	=over 4
1404		1362
1405	=item $overlay->set ($x, $y, $text, $rend)	1363	=item $overlay->set ($x, $y, $text[, $rend])
1406		1364
1407	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1365	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	1366	text in rxvt-unicode's special encoding and an array of rendition values
1409	at a specific position inside the overlay.	1367	at a specific position inside the overlay.
		1368
		1369	If C<$rend> is missing, then the rendition will not be changed.
1410		1370
1411	=item $overlay->hide	1371	=item $overlay->hide
1412		1372
1413	If visible, hide the overlay, but do not destroy it.	1373	If visible, hide the overlay, but do not destroy it.
1414		1374
…		…
1496	locale-specific encoding of the terminal and can contain command sequences	1456	locale-specific encoding of the terminal and can contain command sequences
1497	(escape codes) that will be interpreted.	1457	(escape codes) that will be interpreted.
1498		1458
1499	=item $term->tt_write ($octets)	1459	=item $term->tt_write ($octets)
1500		1460
1501	Write the octets given in C<$data> to the tty (i.e. as program input). To	1461	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	1462	pass characters instead of octets, you should convert your strings first
1503	to the locale-specific encoding using C<< $term->locale_encode >>.	1463	to the locale-specific encoding using C<< $term->locale_encode >>.
		1464
		1465	=item $term->tt_paste ($octets)
		1466
		1467	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1468	CR and bracketing the data with control sequences if bracketed paste mode
		1469	is set.
1504		1470
1505	=item $old_events = $term->pty_ev_events ([$new_events])	1471	=item $old_events = $term->pty_ev_events ([$new_events])
1506		1472
1507	Replaces the event mask of the pty watcher by the given event mask. Can	1473	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	1474	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	1493	Adds the specified events to the vt event mask. Useful e.g. when you want
1528	to receive pointer events all the times:	1494	to receive pointer events all the times:
1529		1495
1530	$term->vt_emask_add (urxvt::PointerMotionMask);	1496	$term->vt_emask_add (urxvt::PointerMotionMask);
1531		1497
		1498	=item $term->set_urgency ($set)
		1499
		1500	Enable/disable the urgency hint on the toplevel window.
		1501
1532	=item $term->focus_in	1502	=item $term->focus_in
1533		1503
1534	=item $term->focus_out	1504	=item $term->focus_out
1535		1505
1536	=item $term->key_press ($state, $keycode[, $time])	1506	=item $term->key_press ($state, $keycode[, $time])
…		…
1624		1594
1625	Used after changing terminal contents to display them.	1595	Used after changing terminal contents to display them.
1626		1596
1627	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1597	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1628		1598
1629	Returns the text of the entire row with number C<$row_number>. Row C<0>	1599	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	1600	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	1601	terminal line. Nothing will be returned if a nonexistent line
1633	is requested.	1602	is requested.
1634		1603
1635	If C<$new_text> is specified, it will replace characters in the current	1604	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	1605	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	1606	to replace only parts of a line. The font index in the rendition will
1638	automatically be updated.	1607	automatically be updated.
1639		1608
1640	C<$text> is in a special encoding: tabs and wide characters that use more	1609	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)	1610	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642	characters. Characters with combining characters and other characters that	1611	characters. Characters with combining characters and other characters that
1643	do not fit into the normal tetx encoding will be replaced with characters	1612	do not fit into the normal text encoding will be replaced with characters
1644	in the private use area.	1613	in the private use area.
1645		1614
1646	You have to obey this encoding when changing text. The advantage is	1615	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	1616	that C<substr> and similar functions work on screen cells and not on
1648	characters.	1617	characters.
…		…
1733	}	1702	}
1734		1703
1735	sub urxvt::line::t {	1704	sub urxvt::line::t {
1736	my ($self) = @_;	1705	my ($self) = @_;
1737		1706
1738	if (@_ > 1)	1707	if (@_ > 1) {
1739	{
1740	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1708	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1741	for $self->{beg} .. $self->{end};	1709	for $self->{beg} .. $self->{end};
1742	}	1710	}
1743		1711
1744	defined wantarray &&	1712	defined wantarray &&
1745	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1713	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1746	0, $self->{len}	1714	0, $self->{len}
1747	}	1715	}
1748		1716
1749	sub urxvt::line::r {	1717	sub urxvt::line::r {
1750	my ($self) = @_;	1718	my ($self) = @_;
1751		1719
1752	if (@_ > 1)	1720	if (@_ > 1) {
1753	{
1754	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1721	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1755	for $self->{beg} .. $self->{end};	1722	for $self->{beg} .. $self->{end};
1756	}	1723	}
1757		1724
1758	if (defined wantarray) {	1725	if (defined wantarray) {
1759	my $rend = [	1726	my $rend = [
1760	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1727	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1761	];	1728	];
…		…
1823	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1790	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1824	recent grab.	1791	recent grab.
1825		1792
1826	=item $term->ungrab	1793	=item $term->ungrab
1827		1794
1828	Calls XUngrab for the most recent grab. Is called automatically on	1795	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	1796	evaluation errors, as it is better to lose the grab in the error case as
1830	the session.	1797	the session.
1831		1798
1832	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1799	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1833		1800
…		…
1835		1802
1836	=item @atoms = $term->XListProperties ($window)	1803	=item @atoms = $term->XListProperties ($window)
1837		1804
1838	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1805	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1839		1806
1840	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1807	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1841		1808
1842	=item $term->XDeleteProperty ($window, $property)	1809	=item $term->XDeleteProperty ($window, $property)
1843		1810
1844	=item $window = $term->DefaultRootWindow	1811	=item $window = $term->DefaultRootWindow
1845		1812
…		…
1852	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1819	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1853		1820
1854	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1821	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1855		1822
1856	=item $term->XChangeInput ($window, $add_events[, $del_events])	1823	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1824
		1825	=item $keysym = $term->XStringToKeysym ($string)
		1826
		1827	=item $string = $term->XKeysymToString ($keysym)
1857		1828
1858	Various X or X-related functions. The C<$term> object only serves as	1829	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	1830	the source of the display, otherwise those functions map more-or-less
1860	directory onto the X functions of the same name.	1831	directly onto the X functions of the same name.
1861		1832
1862	=back	1833	=back
1863		1834
1864	=cut	1835	=cut
1865		1836
…		…
1967	my $env = $self->{term}->env;	1938	my $env = $self->{term}->env;
1968	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1939	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969	delete $env->{LC_ALL};	1940	delete $env->{LC_ALL};
1970	$env->{LC_CTYPE} = $self->{term}->locale;	1941	$env->{LC_CTYPE} = $self->{term}->locale;
1971		1942
1972	urxvt::term->new ($env, "popup",	1943	my $term = urxvt::term->new (
		1944	$env, "popup",
1973	"--perl-lib" => "", "--perl-ext-common" => "",	1945	"--perl-lib" => "", "--perl-ext-common" => "",
1974	"-pty-fd" => -1, "-sl" => 0,	1946	"-pty-fd" => -1, "-sl" => 0,
1975	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1947	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976	"--transient-for" => $self->{term}->parent,	1948	"--transient-for" => $self->{term}->parent,
1977	"-display" => $self->{term}->display_id,	1949	"-display" => $self->{term}->display_id,
1978	"-pe" => "urxvt-popup")	1950	"-pe" => "urxvt-popup",
1979	or die "unable to create popup window\n";	1951	) or die "unable to create popup window\n";
		1952
		1953	unless (delete $term->{urxvt_popup_init_done}) {
		1954	$term->ungrab;
		1955	$term->destroy;
		1956	die "unable to initialise popup window\n";
		1957	}
1980	}	1958	}
1981		1959
1982	sub DESTROY {	1960	sub DESTROY {
1983	my ($self) = @_;	1961	my ($self) = @_;
1984		1962
…		…
2002	->new	1980	->new
2003	->interval (1)	1981	->interval (1)
2004	->cb (sub {	1982	->cb (sub {
2005	$term->{overlay}->set (0, 0,	1983	$term->{overlay}->set (0, 0,
2006	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1984	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2007	});	1985	});
2008		1986
2009	=over 4	1987	=over 4
2010		1988
2011	=item $timer = new urxvt::timer	1989	=item $timer = new urxvt::timer
2012		1990
…		…
2015		1993
2016	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1994	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017		1995
2018	Set the callback to be called when the timer triggers.	1996	Set the callback to be called when the timer triggers.
2019		1997
2020	=item $tstamp = $timer->at
2021
2022	Return the time this watcher will fire next.
2023
2024	=item $timer = $timer->set ($tstamp)	1998	=item $timer = $timer->set ($tstamp[, $interval])
2025		1999
2026	Set the time the event is generated to $tstamp.	2000	Set the time the event is generated to $tstamp (and optionally specifies a
		2001	new $interval).
2027		2002
2028	=item $timer = $timer->interval ($interval)	2003	=item $timer = $timer->interval ($interval)
2029		2004
2030	Normally (and when C<$interval> is C<0>), the timer will automatically	2005	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	2006	stop after it has fired once. If C<$interval> is non-zero, then the timer
2032	is automatically rescheduled at the given intervals.	2007	is automatically rescheduled at the given intervals.
2033		2008
2034	=item $timer = $timer->start	2009	=item $timer = $timer->start
2035		2010
2036	Start the timer.	2011	Start the timer.
2037		2012
2038	=item $timer = $timer->start ($tstamp)	2013	=item $timer = $timer->start ($tstamp[, $interval])
2039		2014
2040	Set the event trigger time to C<$tstamp> and start the timer.	2015	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2016	also replaces the interval.
2041		2017
2042	=item $timer = $timer->after ($delay)	2018	=item $timer = $timer->after ($delay[, $interval])
2043		2019
2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2020	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045		2021
2046	=item $timer = $timer->stop	2022	=item $timer = $timer->stop
2047		2023
…		…
2055		2031
2056	$term->{socket} = ...	2032	$term->{socket} = ...
2057	$term->{iow} = urxvt::iow	2033	$term->{iow} = urxvt::iow
2058	->new	2034	->new
2059	->fd (fileno $term->{socket})	2035	->fd (fileno $term->{socket})
2060	->events (urxvt::EVENT_READ)	2036	->events (urxvt::EV_READ)
2061	->start	2037	->start
2062	->cb (sub {	2038	->cb (sub {
2063	my ($iow, $revents) = @_;	2039	my ($iow, $revents) = @_;
2064	# $revents must be 1 here, no need to check	2040	# $revents must be 1 here, no need to check
2065	sysread $term->{socket}, my $buf, 8192	2041	sysread $term->{socket}, my $buf, 8192
…		…
2083	Set the file descriptor (not handle) to watch.	2059	Set the file descriptor (not handle) to watch.
2084		2060
2085	=item $iow = $iow->events ($eventmask)	2061	=item $iow = $iow->events ($eventmask)
2086		2062
2087	Set the event mask to watch. The only allowed values are	2063	Set the event mask to watch. The only allowed values are
2088	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2064	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2089	together, or C<urxvt::EVENT_NONE>.	2065	together, or C<urxvt::EV_NONE>.
2090		2066
2091	=item $iow = $iow->start	2067	=item $iow = $iow->start
2092		2068
2093	Start watching for requested events on the given handle.	2069	Start watching for requested events on the given handle.
2094		2070
…		…
2135	->new	2111	->new
2136	->start ($pid)	2112	->start ($pid)
2137	->cb (sub {	2113	->cb (sub {
2138	my ($pw, $exit_status) = @_;	2114	my ($pw, $exit_status) = @_;
2139	...	2115	...
2140	});	2116	});
2141		2117
2142	=over 4	2118	=over 4
2143		2119
2144	=item $pw = new urxvt::pw	2120	=item $pw = new urxvt::pw
2145		2121
…		…
2178		2154
2179	=back	2155	=back
2180		2156
2181	=head1 AUTHOR	2157	=head1 AUTHOR
2182		2158
2183	Marc Lehmann <pcg@goof.com>	2159	Marc Lehmann <schmorp@schmorp.de>
2184	http://software.schmorp.de/pkg/rxvt-unicode	2160	http://software.schmorp.de/pkg/rxvt-unicode
2185		2161
2186	=cut	2162	=cut
2187		2163
2188	1	2164	1

Diff Legend

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