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.153 by root, Sat Jun 2 05:23:11 2007 UTC vs.
Revision 1.245 by root, Mon Dec 22 09:10:12 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"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	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
34	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> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	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:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions may add additional resources and C<actions>, i.e., methods
45		49	which can be bound to a key and invoked by the user. An extension can
46	=item selection (enabled by default)	50	define the resources it support and also default bindings for one or
47		51	more actions it provides using so called META comments, described
48	(More) intelligent selection. This extension tries to be more intelligent	52	below. Similarly to builtin resources, extension resources can also be
49	when the user extends selections (double-click and further clicks). Right	53	specified on the command line as long options (with C<.> replaced by
50	now, it tries to select words, urls and complete shell-quoted	54	C<->), in which case the corresponding extension is loaded
51	arguments, which is very convenient, too, if your F<ls> supports	55	automatically. For this to work the extension B<must> define META
52	C<--quoting-style=shell>.	56	comments for its resources.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72	Another example: Programs I use often output "absolute path: " at the
73	beginning of a line when they process multiple files. The following
74	pattern matches the filename (note, there is a single space at the very
75	end):
76
77	URxvt.selection.pattern-0: ^(/[^:]+):\
78
79	You can look at the source of the selection extension to see more
80	interesting uses, such as parsing a line from beginning to end.
81
82	This extension also offers following bindable keyboard commands:
83
84	=over 4
85
86	=item rot13
87
88	Rot-13 the selection when activated. Used via keyboard trigger:
89
90	URxvt.keysym.C-M-r: perl:selection:rot13
91
92	=back
93
94	=item option-popup (enabled by default)
95
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.
98
99	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.
102
103	It's sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as
107	first argument.
108
109	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:
111
112	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};
115
116	=item selection-popup (enabled by default)
117
118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119	text into various other formats/action (such as uri unescaping, perl
120	evaluation, web-browser starting etc.), depending on content.
121
122	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.
125
126	It's sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide whether to add something or not.
128	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.
131
132	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:
135
136	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }
138	: ()
139	};
140
141	=item searchable-scrollback<hotkey> (enabled by default)
142
143	Adds regex search functionality to the scrollback buffer, triggered
144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
145	input/output is suspended and a regex is displayed at the bottom of the
146	screen.
147
148	Inputting characters appends them to the regex and continues incremental
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary
154	selection.
155
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.
159
160	See L<perlre> for more info about perl regular expression syntax.
161
162	=item readline (enabled by default)
163
164	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to
166	move the text cursor to this position. It does so by generating as many
167	cursor-left or cursor-right keypresses as required (the this only works
168	for programs that correctly support wide characters).
169
170	To avoid too many false positives, this is only done when:
171
172	=over 4
173
174	=item - the tty is in ICANON state.
175
176	=item - the text cursor is visible.
177
178	=item - the primary screen is currently being displayed.
179
180	=item - the mouse is on the same (multi-row-) line as the text cursor.
181
182	=back
183
184	The normal selection mechanism isn't disabled, so quick successive clicks
185	might interfere with selection creation in harmless ways.
186
187	=item selection-autotransform
188
189	This selection allows you to do automatic transforms on a selection
190	whenever a selection is made.
191
192	It works by specifying perl snippets (most useful is a single C<s///>
193	operator) that modify C<$_> as resources:
194
195	URxvt.selection-autotransform.0: transform
196	URxvt.selection-autotransform.1: transform
197	...
198
199	For example, the following will transform selections of the form
200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
201	$word>:
202
203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
204
205	And this example matches the same,but replaces it with vi-commands you can
206	paste directly into your (vi :) editor:
207
208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
209
210	Of course, this can be modified to suit your needs and your editor :)
211
212	To expand the example above to typical perl error messages ("XXX at
213	FILENAME line YYY."), you need a slightly more elaborate solution:
214
215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
217
218	The first line tells the selection code to treat the unchanging part of
219	every error message as a selection pattern, and the second line transforms
220	the message into vi commands to load the file.
221
222	=item tabbed
223
224	This transforms the terminal into a tabbar with additional terminals, that
225	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227	button per tab.
228
229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
230	B<Shift-Right> will switch to the tab left or right of the current one,
231	while B<Shift-Down> creates a new tab.
232
233	The tabbar itself can be configured similarly to a normal terminal, but
234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
235	following four resources (shown with defaults):
236
237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239	URxvt.tabbed.tab-fg: <colour-index, default 0>
240	URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243	indices.
244
245	=item matcher
246
247	Uses per-line display filtering (C<on_line_update>) to underline text
248	matching a certain pattern and make it clickable. When clicked with the
249	mouse button specified in the C<matcher.button> resource (default 2, or
250	middle), the program specified in the C<matcher.launcher> resource
251	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
252	with the matched text as first argument. The default configuration is
253	suitable for matching URLs and launching a web browser, like the
254	former "mark-urls" extension.
255
256	The default pattern to match URLs can be overridden with the
257	C<matcher.pattern.0> resource, and additional patterns can be specified
258	with numbered patterns, in a manner similar to the "selection" extension.
259	The launcher can also be overridden on a per-pattern basis.
260
261	Example configuration:
262
263	URxvt.perl-ext: default,matcher
264	URxvt.urlLauncher: sensible-browser
265	URxvt.keysym.C-Delete: perl:matcher
266	URxvt.matcher.button: 1
267	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
268	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
269	URxvt.matcher.launcher.2: gvim +$2 $1
270
271	=item xim-onthespot
272
273	This (experimental) perl extension implements OnTheSpot editing. It does
274	not work perfectly, and some input methods don't seem to work well with
275	OnTheSpot editing in general, but it seems to work at leats for SCIM and
276	kinput2.
277
278	You enable it by specifying this extension and a preedit style of
279	C<OnTheSpot>, i.e.:
280
281	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
282
283	=item kuake<hotkey>
284
285	A very primitive quake-console-like extension. It was inspired by a
286	description of how the programs C<kuake> and C<yakuake> work: Whenever the
287	user presses a global accelerator key (by default C<F10>), the terminal
288	will show or hide itself. Another press of the accelerator key will hide
289	or show it again.
290
291	Initially, the window will not be shown when using this extension.
292
293	This is useful if you need a single terminal thats not using any desktop
294	space most of the time but is quickly available at the press of a key.
295
296	The accelerator key is grabbed regardless of any modifiers, so this
297	extension will actually grab a physical key just for this function.
298
299	If you want a quake-like animation, tell your window manager to do so
300	(fvwm can do it).
301
302	=item automove-background
303
304	This is basically a very small extension that dynamically changes the
305	background pixmap offset to the window position, in effect creating the
306	same effect as pseudo transparency with a custom pixmap. No scaling is
307	supported in this mode. Example:
308
309	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
310
311	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
312	shows how this extension can be used to implement an automatically blurred
313	transparent background.
314
315	=item block-graphics-to-ascii
316
317	A not very useful example of filtering all text output to the terminal
318	by replacing all line-drawing characters (U+2500 .. U+259F) by a
319	similar-looking ascii character.
320
321	=item digital-clock
322
323	Displays a digital clock using the built-in overlay.
324
325	=item remote-clipboard
326
327	Somewhat of a misnomer, this extension adds two menu entries to the
328	selection popup that allows one ti run external commands to store the
329	selection somewhere and fetch it again.
330
331	We use it to implement a "distributed selection mechanism", which just
332	means that one command uploads the file to a remote server, and another
333	reads it.
334
335	The commands can be set using the C<URxvt.remote-selection.store> and
336	C<URxvt.remote-selection.fetch> resources. The first should read the
337	selection to store from STDIN (always in UTF-8), the second should provide
338	the selection data on STDOUT (also in UTF-8).
339
340	The defaults (which are likely useless to you) use rsh and cat:
341
342	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
343	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
344
345	=item selection-pastebin
346
347	This is a little rarely useful extension that Uploads the selection as
348	textfile to a remote site (or does other things). (The implementation is
349	not currently secure for use in a multiuser environment as it writes to
350	F</tmp> directly.).
351
352	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
353	i.e.
354
355	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
356
357	Pressing this combination runs a command with C<%> replaced by the name of
358	the textfile. This command can be set via a resource:
359
360	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
361
362	And the default is likely not useful to anybody but the few people around
363	here :)
364
365	The name of the textfile is the hex encoded md5 sum of the selection, so
366	the same content should lead to the same filename.
367
368	After a successful upload the selection will be replaced by the text given
369	in the C<selection-pastebin-url> resource (again, the % is the placeholder
370	for the filename):
371
372	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
373
374	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
375	the double C</> characters as comment start. Use C<\057\057> instead,
376	which works regardless of wether xrdb is used to parse the resource file
377	or not.
378
379	=item example-refresh-hooks
380
381	Displays a very simple digital clock in the upper right corner of the
382	window. Illustrates overwriting the refresh callbacks to create your own
383	overlays or changes.
384
385	=back
386		57
387	=head1 API DOCUMENTATION	58	=head1 API DOCUMENTATION
388		59
389	=head2 General API Considerations	60	=head2 General API Considerations
390		61
…		…
404		75
405	=over 4	76	=over 4
406		77
407	=item $text	78	=item $text
408		79
409	Rxvt-unicodes special way of encoding text, where one "unicode" character	80	Rxvt-unicode's special way of encoding text, where one "unicode" character
410	always represents one screen cell. See L<ROW_t> for a discussion of this format.	81	always represents one screen cell. See L<ROW_t> for a discussion of this format.
411		82
412	=item $string	83	=item $string
413		84
414	A perl text string, with an emphasis on I<text>. It can store all unicode	85	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
418	=item $octets	89	=item $octets
419		90
420	Either binary data or - more common - a text string encoded in a	91	Either binary data or - more common - a text string encoded in a
421	locale-specific way.	92	locale-specific way.
422		93
		94	=item $keysym
		95
		96	an integer that is a valid X11 keysym code. You can convert a string
		97	into a keysym and viceversa by using C<XStringToKeysym> and
		98	C<XKeysymToString>.
		99
423	=back	100	=back
424		101
425	=head2 Extension Objects	102	=head2 Extension Objects
426		103
427	Every perl extension is a perl class. A separate perl object is created	104	Every perl extension is a perl class. A separate perl object is created
428	for each terminal, and each terminal has its own set of extenion objects,	105	for each terminal, and each terminal has its own set of extension objects,
429	which are passed as the first parameter to hooks. So extensions can use	106	which are passed as the first parameter to hooks. So extensions can use
430	their C<$self> object without having to think about clashes with other	107	their C<$self> object without having to think about clashes with other
431	extensions or other terminals, with the exception of methods and members	108	extensions or other terminals, with the exception of methods and members
432	that begin with an underscore character C<_>: these are reserved for	109	that begin with an underscore character C<_>: these are reserved for
433	internal use.	110	internal use.
434		111
435	Although it isn't a C<urxvt::term> object, you can call all methods of the	112	Although it isn't a C<urxvt::term> object, you can call all methods of the
436	C<urxvt::term> class on this object.	113	C<urxvt::term> class on this object.
437		114
438	It has the following methods and data members:	115	Additional methods only supported for extension objects are described in
		116	the C<urxvt::extension> section below.
		117
		118	=head2 META comments
		119
		120	rxvt-unicode recognizes special comments in extensions that define
		121	different types of metadata:
439		122
440	=over 4	123	=over 4
441		124
442	=item $urxvt_term = $self->{term}	125	=item #:META:RESOURCE:name:type:desc
443		126
444	Returns the C<urxvt::term> object associated with this instance of the	127	The RESOURCE comment defines a resource used by the extension, where
445	extension. This member I<must not> be changed in any way.	128	C<name> is the resource name, C<type> is the resource type, C<boolean>
		129	or C<string>, and C<desc> is the resource description.
446		130
447	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	131	=item #:META:BINDING:sym:action
448		132
449	Dynamically enable the given hooks (named without the C<on_> prefix) for	133	The BINDING comment defines a default binding for an action provided
450	this extension, replacing any previous hook. This is useful when you want	134	by the extension, where C<sym> is the key combination that triggers
451	to overwrite time-critical hooks only temporarily.	135	the action, whose format is defined in the description of the
452		136	B<keysym> resource in the urxvt(1) manpage, and C<action> is the name
453	=item $self->disable ($hook_name[, $hook_name..])	137	of the action method.
454
455	Dynamically disable the given hooks.
456		138
457	=back	139	=back
458		140
459	=head2 Hooks	141	=head2 Hooks
460		142
…		…
548		230
549	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	231	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
550	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	232	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
551	number of lines that will be in the scrollback buffer.	233	number of lines that will be in the scrollback buffer.
552		234
553	=item on_osc_seq $term, $op, $args	235	=item on_osc_seq $term, $op, $args, $resp
554		236
555	Called on every OSC sequence and can be used to suppress it or modify its	237	Called on every OSC sequence and can be used to suppress it or modify its
556	behaviour. The default should be to return an empty list. A true value	238	behaviour. The default should be to return an empty list. A true value
557	suppresses execution of the request completely. Make sure you don't get	239	suppresses execution of the request completely. Make sure you don't get
558	confused by recursive invocations when you output an osc sequence within	240	confused by recursive invocations when you output an OSC sequence within
559	this callback.	241	this callback.
560		242
561	C<on_osc_seq_perl> should be used for new behaviour.	243	C<on_osc_seq_perl> should be used for new behaviour.
562		244
563	=item on_osc_seq_perl $term, $string	245	=item on_osc_seq_perl $term, $args, $resp
564		246
565	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	247	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
566	operating system command) is processed. Cursor position and other state	248	operating system command) is processed. Cursor position and other state
567	information is up-to-date when this happens. For interoperability, the	249	information is up-to-date when this happens. For interoperability, the
568	string should start with the extension name and a colon, to distinguish	250	string should start with the extension name (sans -osc) and a semicolon,
569	it from commands for other extensions, and this might be enforced in the	251	to distinguish it from commands for other extensions, and this might be
570	future.	252	enforced in the future.
		253
		254	For example, C<overlay-osc> uses this:
		255
		256	sub on_osc_seq_perl {
		257	my ($self, $osc, $resp) = @_;
		258
		259	return unless $osc =~ s/^overlay;//;
		260
		261	... process remaining $osc string
		262	}
571		263
572	Be careful not ever to trust (in a security sense) the data you receive,	264	Be careful not ever to trust (in a security sense) the data you receive,
573	as its source can not easily be controlled (e-mail content, messages from	265	as its source can not easily be controlled (e-mail content, messages from
574	other users on the same system etc.).	266	other users on the same system etc.).
		267
		268	For responses, C<$resp> contains the end-of-args separator used by the
		269	sender.
575		270
576	=item on_add_lines $term, $string	271	=item on_add_lines $term, $string
577		272
578	Called whenever text is about to be output, with the text as argument. You	273	Called whenever text is about to be output, with the text as argument. You
579	can filter/change and output the text yourself by returning a true value	274	can filter/change and output the text yourself by returning a true value
…		…
584	=item on_tt_write $term, $octets	279	=item on_tt_write $term, $octets
585		280
586	Called whenever some data is written to the tty/pty and can be used to	281	Called whenever some data is written to the tty/pty and can be used to
587	suppress or filter tty input.	282	suppress or filter tty input.
588		283
		284	=item on_tt_paste $term, $octets
		285
		286	Called whenever text is about to be pasted, with the text as argument. You
		287	can filter/change and paste the text yourself by returning a true value
		288	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		289	locale-encoded.
		290
589	=item on_line_update $term, $row	291	=item on_line_update $term, $row
590		292
591	Called whenever a line was updated or changed. Can be used to filter	293	Called whenever a line was updated or changed. Can be used to filter
592	screen output (e.g. underline urls or other useless stuff). Only lines	294	screen output (e.g. underline urls or other useless stuff). Only lines
593	that are being shown will be filtered, and, due to performance reasons,	295	that are being shown will be filtered, and, due to performance reasons,
…		…
600	later with the already-modified line (e.g. if unrelated parts change), so	302	later with the already-modified line (e.g. if unrelated parts change), so
601	you cannot just toggle rendition bits, but only set them.	303	you cannot just toggle rendition bits, but only set them.
602		304
603	=item on_refresh_begin $term	305	=item on_refresh_begin $term
604		306
605	Called just before the screen gets redrawn. Can be used for overlay	307	Called just before the screen gets redrawn. Can be used for overlay or
606	or similar effects by modify terminal contents in refresh_begin, and	308	similar effects by modifying the terminal contents in refresh_begin, and
607	restoring them in refresh_end. The built-in overlay and selection display	309	restoring them in refresh_end. The built-in overlay and selection display
608	code is run after this hook, and takes precedence.	310	code is run after this hook, and takes precedence.
609		311
610	=item on_refresh_end $term	312	=item on_refresh_end $term
611		313
612	Called just after the screen gets redrawn. See C<on_refresh_begin>.	314	Called just after the screen gets redrawn. See C<on_refresh_begin>.
613		315
		316	=item on_action $term, $string
		317
		318	Called whenever an action is invoked for the corresponding extension
		319	(e.g. via a C<extension:string> builtin action bound to a key, see
		320	description of the B<keysym> resource in the urxvt(1) manpage). The
		321	event is simply the action string. Note that an action event is always
		322	associated to a single extension.
		323
614	=item on_user_command $term, $string	324	=item on_user_command $term, $string *DEPRECATED*
615		325
616	Called whenever a user-configured event is being activated (e.g. via	326	Called whenever a user-configured event is being activated (e.g. via
617	a C<perl:string> action bound to a key, see description of the B<keysym>	327	a C<perl:string> action bound to a key, see description of the B<keysym>
618	resource in the @@RXVT_NAME@@(1) manpage).	328	resource in the urxvt(1) manpage).
619		329
620	The event is simply the action string. This interface is assumed to change	330	The event is simply the action string. This interface is going away in
621	slightly in the future.	331	preference to the C<on_action> hook.
622		332
623	=item on_resize_all_windows $tern, $new_width, $new_height	333	=item on_resize_all_windows $term, $new_width, $new_height
624		334
625	Called just after the new window size has been calculated, but before	335	Called just after the new window size has been calculated, but before
626	windows are actually being resized or hints are being set. If this hook	336	windows are actually being resized or hints are being set. If this hook
627	returns TRUE, setting of the window hints is being skipped.	337	returns a true value, setting of the window hints is being skipped.
628		338
629	=item on_x_event $term, $event	339	=item on_x_event $term, $event
630		340
631	Called on every X event received on the vt window (and possibly other	341	Called on every X event received on the vt window (and possibly other
632	windows). Should only be used as a last resort. Most event structure	342	windows). Should only be used as a last resort. Most event structure
…		…
662		372
663	=item on_map_notify $term, $event	373	=item on_map_notify $term, $event
664		374
665	=item on_unmap_notify $term, $event	375	=item on_unmap_notify $term, $event
666		376
667	Called whenever the corresponding X event is received for the terminal If	377	Called whenever the corresponding X event is received for the terminal. If
668	the hook returns true, then the even will be ignored by rxvt-unicode.	378	the hook returns true, then the event will be ignored by rxvt-unicode.
669		379
670	The event is a hash with most values as named by Xlib (see the XEvent	380	The event is a hash with most values as named by Xlib (see the XEvent
671	manpage), with the additional members C<row> and C<col>, which are the	381	manpage), with the additional members C<row> and C<col>, which are the
672	(real, not screen-based) row and column under the mouse cursor.	382	(real, not screen-based) row and column under the mouse cursor.
673		383
674	C<on_key_press> additionally receives the string rxvt-unicode would	384	C<on_key_press> additionally receives the string rxvt-unicode would
675	output, if any, in locale-specific encoding.	385	output, if any, in locale-specific encoding.
676		386
677	subwindow.
678
679	=item on_client_message $term, $event	387	=item on_client_message $term, $event
680		388
681	=item on_wm_protocols $term, $event	389	=item on_wm_protocols $term, $event
682		390
683	=item on_wm_delete_window $term, $event	391	=item on_wm_delete_window $term, $event
684		392
685	Called when various types of ClientMessage events are received (all with	393	Called when various types of ClientMessage events are received (all with
686	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	394	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
687		395
		396	=item on_bell $term
		397
		398	Called on receipt of a bell character.
		399
688	=back	400	=back
689		401
690	=cut	402	=cut
691		403
692	package urxvt;	404	package urxvt;
693		405
694	use utf8;	406	use utf8;
695	use strict;	407	use strict 'vars';
696	use Carp ();	408	use Carp ();
697	use Scalar::Util ();	409	use Scalar::Util ();
698	use List::Util ();	410	use List::Util ();
699		411
700	our $VERSION = 1;	412	our $VERSION = 1;
701	our $TERM;	413	our $TERM;
702	our @TERM_INIT;	414	our @TERM_INIT; # should go, prevents async I/O etc.
703	our @TERM_EXT;	415	our @TERM_EXT; # should go, prevents async I/O etc.
704	our @HOOKNAME;	416	our @HOOKNAME;
705	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
706	our %OPTION;	418	our %OPTION;
707		419
708	our $LIBDIR;	420	our $LIBDIR;
…		…
756		468
757	=over 4	469	=over 4
758		470
759	=item urxvt::fatal $errormessage	471	=item urxvt::fatal $errormessage
760		472
761	Fatally aborts execution with the given error message. Avoid at all	473	Fatally aborts execution with the given error message (which should
762	costs! The only time this is acceptable is when the terminal process	474	include a trailing newline). Avoid at all costs! The only time this
763	starts up.	475	is acceptable (and useful) is in the init hook, where it prevents the
		476	terminal from starting up.
764		477
765	=item urxvt::warn $string	478	=item urxvt::warn $string
766		479
767	Calls C<rxvt_warn> with the given string which should not include a	480	Calls C<rxvt_warn> with the given string which should include a trailing
768	newline. The module also overwrites the C<warn> builtin with a function	481	newline. The module also overwrites the C<warn> builtin with a function
769	that calls this function.	482	that calls this function.
770		483
771	Using this function has the advantage that its output ends up in the	484	Using this function has the advantage that its output ends up in the
772	correct place, e.g. on stderr of the connecting urxvtc client.	485	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
776	=item @terms = urxvt::termlist	489	=item @terms = urxvt::termlist
777		490
778	Returns all urxvt::term objects that exist in this process, regardless of	491	Returns all urxvt::term objects that exist in this process, regardless of
779	whether they are started, being destroyed etc., so be careful. Only term	492	whether they are started, being destroyed etc., so be careful. Only term
780	objects that have perl extensions attached will be returned (because there	493	objects that have perl extensions attached will be returned (because there
781	is no urxvt::term objet associated with others).	494	is no urxvt::term object associated with others).
782		495
783	=item $time = urxvt::NOW	496	=item $time = urxvt::NOW
784		497
785	Returns the "current time" (as per the event loop).	498	Returns the "current time" (as per the event loop).
786		499
…		…
829		542
830	=item $rend = urxvt::OVERLAY_RSTYLE	543	=item $rend = urxvt::OVERLAY_RSTYLE
831		544
832	Return the rendition mask used for overlays by default.	545	Return the rendition mask used for overlays by default.
833		546
834	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	547	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		548	urxvt::RS_RVid, urxvt::RS_Uline
835		549
836	Return the bit that enabled bold, italic, blink, reverse-video and	550	Return the bit that enabled bold, italic, blink, reverse-video and
837	underline, respectively. To enable such a style, just logically OR it into	551	underline, respectively. To enable such a style, just logically OR it into
838	the bitset.	552	the bitset.
839		553
…		…
876	};	590	};
877	}	591	}
878		592
879	no warnings 'utf8';	593	no warnings 'utf8';
880		594
		595	sub parse_resource {
		596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		597
		598	$term->scan_extensions;
		599
		600	my $r = $term->{meta}{resource};
		601	keys %$r; # reset iterator
		602	while (my ($k, $v) = each %$r) {
		603	my $pattern = $k;
		604	$pattern =~ y/./-/ if $isarg;
		605	my $prefix = $name;
		606	my $suffix;
		607	if ($pattern =~ /\-$/) {
		608	$prefix = substr $name, 0, length $pattern;
		609	$suffix = substr $name, length $pattern;
		610	}
		611	if ($pattern eq $prefix) {
		612	$name = "$urxvt::RESCLASS.$k$suffix";
		613
		614	push @{ $term->{perl_ext_3} }, $v->[0];
		615
		616	if ($v->[1] eq "boolean") {
		617	$term->put_option_db ($name, $flag ? "true" : "false");
		618	return 1;
		619	} else {
		620	$term->put_option_db ($name, $value);
		621	return 1 + 2;
		622	}
		623	}
		624	}
		625
		626	0
		627	}
		628
		629	sub usage {
		630	my ($term, $usage_type) = @_;
		631
		632	$term->scan_extensions;
		633
		634	my $r = $term->{meta}{resource};
		635
		636	for my $pattern (sort keys %$r) {
		637	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		638
		639	$desc .= " (-pe $ext)";
		640
		641	if ($usage_type == 1) {
		642	$pattern =~ y/./-/;
		643	$pattern =~ s/-$/-.../g;
		644
		645	if ($type eq "boolean") {
		646	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		647	} else {
		648	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		649	}
		650	} else {
		651	$pattern =~ s/\.$/.*/g;
		652	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		653	}
		654	}
		655	}
		656
881	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	657	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
882		658
883	sub verbose {	659	sub verbose {
884	my ($level, $msg) = @_;	660	my ($level, $msg) = @_;
885	warn "$msg\n" if $level <= $verbosity;	661	warn "$msg\n" if $level <= $verbosity;
…		…
897	$pkg =~ s/[^[:word:]]/_/g;	673	$pkg =~ s/[^[:word:]]/_/g;
898	$pkg = "urxvt::ext::$pkg";	674	$pkg = "urxvt::ext::$pkg";
899		675
900	verbose 3, "loading extension '$path' into package '$pkg'";	676	verbose 3, "loading extension '$path' into package '$pkg'";
901		677
		678	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		679
902	open my $fh, "<:raw", $path	680	open my $fh, "<:raw", $path
903	or die "$path: $!";	681	or die "$path: $!";
904		682
905	my $source =	683	my $source =
906	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	684	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
907	. "#line 1 \"$path\"\n{\n"	685	. "#line 1 \"$path\"\n{\n"
908	. (do { local $/; <$fh> })	686	. (do { local $/; <$fh> })
909	. "\n};\n1";	687	. "\n};\n1";
910		688
911	eval $source	689	eval $source
…		…
920	# called by the rxvt core	698	# called by the rxvt core
921	sub invoke {	699	sub invoke {
922	local $TERM = shift;	700	local $TERM = shift;
923	my $htype = shift;	701	my $htype = shift;
924		702
925	if ($htype == 0) { # INIT	703	if ($htype == HOOK_INIT) {
926	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	704	my @dirs = $TERM->perl_libdirs;
927		705
		706	$TERM->scan_extensions;
		707
928	my %ext_arg;	708	my %ext_arg;
929		709
930	{	710	{
931	my @init = @TERM_INIT;	711	my @init = @TERM_INIT;
932	@TERM_INIT = ();	712	@TERM_INIT = ();
…		…
934	my @pkg = @TERM_EXT;	714	my @pkg = @TERM_EXT;
935	@TERM_EXT = ();	715	@TERM_EXT = ();
936	$TERM->register_package ($_) for @pkg;	716	$TERM->register_package ($_) for @pkg;
937	}	717	}
938		718
		719	for (
939	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	720	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		721	@{ delete $TERM->{perl_ext_3} }
		722	) {
940	if ($_ eq "default") {	723	if ($_ eq "default") {
941	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	724
		725	$ext_arg{$_} = []
		726	for
		727	qw(selection option-popup selection-popup readline),
		728	map $_->[0], values %{ $TERM->{meta}{binding} };
		729
		730	for ($TERM->_keysym_resources) {
		731	next if /^(?:string|command|builtin|builtin-string|perl)/;
		732	next unless /^([A-Za-z0-9_\-]+):/;
		733
		734	my $ext = $1;
		735
		736	$ext_arg{$ext} = [];
		737	}
		738
942	} elsif (/^-(.*)$/) {	739	} elsif (/^-(.*)$/) {
943	delete $ext_arg{$1};	740	delete $ext_arg{$1};
		741
944	} elsif (/^([^<]+)<(.*)>$/) {	742	} elsif (/^([^<]+)<(.*)>$/) {
945	push @{ $ext_arg{$1} }, $2;	743	push @{ $ext_arg{$1} }, $2;
		744
946	} else {	745	} else {
947	$ext_arg{$_} ||= [];	746	$ext_arg{$_} ||= [];
		747	}
		748	}
		749
		750	# now register default key bindings
		751	for my $ext (sort keys %ext_arg) {
		752	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		753	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
948	}	754	}
949	}	755	}
950		756
951	for my $ext (sort keys %ext_arg) {	757	for my $ext (sort keys %ext_arg) {
952	my @files = grep -f $_, map "$_/$ext", @dirs;	758	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
966		772
967	if (my $cb = $TERM->{_hook}[$htype]) {	773	if (my $cb = $TERM->{_hook}[$htype]) {
968	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	774	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
969	if $verbosity >= 10;	775	if $verbosity >= 10;
970		776
		777	if ($htype == HOOK_ACTION) {
		778	# this hook is only sent to the extension with the name
		779	# matching the first arg
		780	my $pkg = shift;
		781	$pkg =~ y/-/_/;
		782	$pkg = "urxvt::ext::$pkg";
		783
		784	$cb = $cb->{$pkg}
		785	or return undef; #TODO: maybe warn user?
		786
		787	$cb = { $pkg => $cb };
		788	}
		789
971	for my $pkg (keys %$cb) {	790	for my $pkg (keys %$cb) {
972	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	791	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
973	$retval ||= $retval_;	792	$retval ||= $retval_;
974		793
975	if ($@) {	794	if ($@) {
976	$TERM->ungrab; # better to lose the grab than the session	795	$TERM->ungrab; # better to lose the grab than the session
977	warn $@;	796	warn $@;
…		…
980		799
981	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	800	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
982	if $verbosity >= 11;	801	if $verbosity >= 11;
983	}	802	}
984		803
985	if ($htype == 1) { # DESTROY	804	if ($htype == HOOK_DESTROY) {
986	# clear package objects	805	# clear package objects
987	%$_ = () for values %{ $TERM->{_pkg} };	806	%$_ = () for values %{ $TERM->{_pkg} };
988		807
989	# clear package	808	# clear package
990	%$TERM = ();	809	%$TERM = ();
…		…
1020	}	839	}
1021	}	840	}
1022	($mask, @color{qw(fg bg)}, \@failed)	841	($mask, @color{qw(fg bg)}, \@failed)
1023	}	842	}
1024		843
1025	# urxvt::term::extension
1026
1027	package urxvt::term::extension;	844	package urxvt::term::extension;
1028		845
1029	sub enable {	846	=head2 The C<urxvt::term::extension> class
1030	my ($self, %hook) = @_;
1031	my $pkg = $self->{_pkg};
1032		847
1033	while (my ($name, $cb) = each %hook) {	848	Each extension attached to a terminal object is represented by
1034	my $htype = $HOOKTYPE{uc $name};	849	a C<urxvt::term::extension> object.
1035	defined $htype
1036	or Carp::croak "unsupported hook type '$name'";
1037		850
1038	$self->set_should_invoke ($htype, +1)	851	You can use these objects, which are passed to all callbacks to store any
1039	unless exists $self->{term}{_hook}[$htype]{$pkg};	852	state related to the terminal and extension instance.
1040		853
1041	$self->{term}{_hook}[$htype]{$pkg} = $cb;	854	The methods (And data members) documented below can be called on extension
1042	}	855	objects, in addition to call methods documented for the <urxvt::term>
1043	}	856	class.
1044		857
1045	sub disable {	858	=over 4
1046	my ($self, @hook) = @_;
1047	my $pkg = $self->{_pkg};
1048		859
1049	for my $name (@hook) {	860	=item $urxvt_term = $self->{term}
1050	my $htype = $HOOKTYPE{uc $name};
1051	defined $htype
1052	or Carp::croak "unsupported hook type '$name'";
1053		861
1054	$self->set_should_invoke ($htype, -1)	862	Returns the C<urxvt::term> object associated with this instance of the
1055	if delete $self->{term}{_hook}[$htype]{$pkg};	863	extension. This member I<must not> be changed in any way.
1056	}	864
1057	}	865	=cut
1058		866
1059	our $AUTOLOAD;	867	our $AUTOLOAD;
1060		868
1061	sub AUTOLOAD {	869	sub AUTOLOAD {
1062	$AUTOLOAD =~ /:([^:]+)$/	870	$AUTOLOAD =~ /:([^:]+)$/
…		…
1075		883
1076	sub DESTROY {	884	sub DESTROY {
1077	# nop	885	# nop
1078	}	886	}
1079		887
1080	# urxvt::destroy_hook	888	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1081		889
1082	sub urxvt::destroy_hook::DESTROY {	890	sub urxvt::destroy_hook::DESTROY {
1083	${$_[0]}->();	891	${$_[0]}->();
1084	}	892	}
1085		893
1086	sub urxvt::destroy_hook(&) {	894	sub urxvt::destroy_hook(&) {
1087	bless \shift, urxvt::destroy_hook::	895	bless \shift, urxvt::destroy_hook::
1088	}	896	}
		897
		898	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		899
		900	Dynamically enable the given hooks (named without the C<on_> prefix) for
		901	this extension, replacing any hook previously installed via C<enable> in
		902	this extension.
		903
		904	This is useful when you want to overwrite time-critical hooks only
		905	temporarily.
		906
		907	To install additional callbacks for the same hook, you can use the C<on>
		908	method of the C<urxvt::term> class.
		909
		910	=item $self->disable ($hook_name[, $hook_name..])
		911
		912	Dynamically disable the given hooks.
		913
		914	=cut
		915
		916	sub enable {
		917	my ($self, %hook) = @_;
		918	my $pkg = $self->{_pkg};
		919
		920	while (my ($name, $cb) = each %hook) {
		921	my $htype = $HOOKTYPE{uc $name};
		922	defined $htype
		923	or Carp::croak "unsupported hook type '$name'";
		924
		925	$self->set_should_invoke ($htype, +1)
		926	unless exists $self->{term}{_hook}[$htype]{$pkg};
		927
		928	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		929	}
		930	}
		931
		932	sub disable {
		933	my ($self, @hook) = @_;
		934	my $pkg = $self->{_pkg};
		935
		936	for my $name (@hook) {
		937	my $htype = $HOOKTYPE{uc $name};
		938	defined $htype
		939	or Carp::croak "unsupported hook type '$name'";
		940
		941	$self->set_should_invoke ($htype, -1)
		942	if delete $self->{term}{_hook}[$htype]{$pkg};
		943	}
		944	}
		945
		946	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		947
		948	Similar to the C<enable> enable, but installs additional callbacks for
		949	the given hook(s) (that is, it doesn't replace existing callbacks), and
		950	returns a guard object. When the guard object is destroyed the callbacks
		951	are disabled again.
		952
		953	=cut
		954
		955	sub urxvt::extension::on_disable::DESTROY {
		956	my $disable = shift;
		957
		958	my $term = delete $disable->{""};
		959
		960	while (my ($htype, $id) = each %$disable) {
		961	delete $term->{_hook}[$htype]{$id};
		962	$term->set_should_invoke ($htype, -1);
		963	}
		964	}
		965
		966	sub on {
		967	my ($self, %hook) = @_;
		968
		969	my $term = $self->{term};
		970
		971	my %disable = ( "" => $term );
		972
		973	while (my ($name, $cb) = each %hook) {
		974	my $htype = $HOOKTYPE{uc $name};
		975	defined $htype
		976	or Carp::croak "unsupported hook type '$name'";
		977
		978	$term->set_should_invoke ($htype, +1);
		979	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		980	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		981	}
		982
		983	bless \%disable, "urxvt::extension::on_disable"
		984	}
		985
		986	=item $self->x_resource ($pattern)
		987
		988	=item $self->x_resource_boolean ($pattern)
		989
		990	These methods support an additional C<%> prefix when called on an
		991	extension object - see the description of these methods in the
		992	C<urxvt::term> class for details.
		993
		994	=cut
		995
		996	sub x_resource {
		997	my ($self, $name) = @_;
		998	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		999	$self->{term}->x_resource ($name)
		1000	}
		1001
		1002	sub x_resource_boolean {
		1003	my ($self, $name) = @_;
		1004	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1005	$self->{term}->x_resource_boolean ($name)
		1006	}
		1007
		1008	=back
		1009
		1010	=cut
1089		1011
1090	package urxvt::anyevent;	1012	package urxvt::anyevent;
1091		1013
1092	=head2 The C<urxvt::anyevent> Class	1014	=head2 The C<urxvt::anyevent> Class
1093		1015
1094	The sole purpose of this class is to deliver an interface to the	1016	The sole purpose of this class is to deliver an interface to the
1095	C<AnyEvent> module - any module using it will work inside urxvt without	1017	C<AnyEvent> module - any module using it will work inside urxvt without
1096	further programming. The only exception is that you cannot wait on	1018	further programming. The only exception is that you cannot wait on
1097	condition variables, but non-blocking condvar use is ok. What this means	1019	condition variables, but non-blocking condvar use is ok.
1098	is that you cannot use blocking APIs, but the non-blocking variant should
1099	work.
1100		1020
1101	=cut	1021	In practical terms this means is that you cannot use blocking APIs, but
		1022	the non-blocking variant should work.
1102		1023
		1024	=cut
		1025
1103	our $VERSION = 1;	1026	our $VERSION = '5.23';
1104		1027
1105	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1028	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1106	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1029	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1107		1030
1108	sub timer {	1031	sub timer {
…		…
1110		1033
1111	my $cb = $arg{cb};	1034	my $cb = $arg{cb};
1112		1035
1113	urxvt::timer	1036	urxvt::timer
1114	->new	1037	->new
1115	->start (urxvt::NOW + $arg{after})	1038	->after ($arg{after}, $arg{interval})
1116	->cb (sub {	1039	->cb ($arg{interval} ? $cb : sub {
1117	$_[0]->stop; # need to cancel manually	1040	$_[0]->stop; # need to cancel manually
1118	$cb->();	1041	$cb->();
1119	})	1042	})
1120	}	1043	}
1121		1044
1122	sub io {	1045	sub io {
1123	my ($class, %arg) = @_;	1046	my ($class, %arg) = @_;
1124		1047
1125	my $cb = $arg{cb};	1048	my $cb = $arg{cb};
		1049	my $fd = fileno $arg{fh};
		1050	defined $fd or $fd = $arg{fh};
1126		1051
1127	bless [$arg{fh}, urxvt::iow	1052	bless [$arg{fh}, urxvt::iow
1128	->new	1053	->new
1129	->fd (fileno $arg{fh})	1054	->fd ($fd)
1130	->events (($arg{poll} =~ /r/ ? 1 : 0)	1055	->events (($arg{poll} =~ /r/ ? 1 : 0)
1131	| ($arg{poll} =~ /w/ ? 2 : 0))	1056	| ($arg{poll} =~ /w/ ? 2 : 0))
1132	->start	1057	->start
1133	->cb (sub {	1058	->cb ($cb)
1134	$cb->(($_[1] & 1 ? 'r' : '')
1135	. ($_[1] & 2 ? 'w' : ''));
1136	})],
1137	urxvt::anyevent::	1059	], urxvt::anyevent::
		1060	}
		1061
		1062	sub idle {
		1063	my ($class, %arg) = @_;
		1064
		1065	my $cb = $arg{cb};
		1066
		1067	urxvt::iw
		1068	->new
		1069	->start
		1070	->cb ($cb)
		1071	}
		1072
		1073	sub child {
		1074	my ($class, %arg) = @_;
		1075
		1076	my $cb = $arg{cb};
		1077
		1078	urxvt::pw
		1079	->new
		1080	->start ($arg{pid})
		1081	->cb (sub {
		1082	$_[0]->stop; # need to cancel manually
		1083	$cb->($_[0]->rpid, $_[0]->rstatus);
		1084	})
1138	}	1085	}
1139		1086
1140	sub DESTROY {	1087	sub DESTROY {
1141	$_[0][1]->stop;	1088	$_[0][1]->stop;
1142	}	1089	}
1143		1090
1144	sub condvar {	1091	# only needed for AnyEvent < 6 compatibility
1145	bless \my $flag, urxvt::anyevent::
1146	}
1147
1148	sub broadcast {
1149	${$_[0]}++;
1150	}
1151
1152	sub wait {
1153	unless (${$_[0]}) {
1154	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1155	}
1156	}
1157
1158	sub one_event {	1092	sub one_event {
1159	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1093	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1160	}	1094	}
1161		1095
1162	package urxvt::term;	1096	package urxvt::term;
…		…
1177	urxvt::verbose 6, "register package $pkg to $self";	1111	urxvt::verbose 6, "register package $pkg to $self";
1178		1112
1179	@{"$pkg\::ISA"} = urxvt::term::extension::;	1113	@{"$pkg\::ISA"} = urxvt::term::extension::;
1180		1114
1181	my $proxy = bless {	1115	my $proxy = bless {
1182	_pkg => $pkg,	1116	_pkg => $pkg,
		1117	_name => ${"$pkg\::_NAME"}, # hackish
1183	argv => $argv,	1118	argv => $argv,
1184	}, $pkg;	1119	}, $pkg;
1185	Scalar::Util::weaken ($proxy->{term} = $self);	1120	Scalar::Util::weaken ($proxy->{term} = $self);
1186		1121
1187	$self->{_pkg}{$pkg} = $proxy;	1122	$self->{_pkg}{$pkg} = $proxy;
1188		1123
…		…
1191	$proxy->enable ($name => $ref);	1126	$proxy->enable ($name => $ref);
1192	}	1127	}
1193	}	1128	}
1194	}	1129	}
1195		1130
		1131	sub perl_libdirs {
		1132	map { split /:/ }
		1133	$_[0]->resource ("perl_lib"),
		1134	$ENV{URXVT_PERL_LIB},
		1135	"$ENV{HOME}/.urxvt/ext",
		1136	"$LIBDIR/perl"
		1137	}
		1138
		1139	# scan for available extensions and collect their metadata
		1140	sub scan_extensions {
		1141	my ($self) = @_;
		1142
		1143	return if exists $self->{meta};
		1144
		1145	my @libdirs = perl_libdirs $self;
		1146
		1147	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1148
		1149	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1150	$self->{meta} = \my %meta;
		1151
		1152	# first gather extensions
		1153	for my $dir (reverse @libdirs) {
		1154	opendir my $fh, $dir
		1155	or next;
		1156	for my $ext (readdir $fh) {
		1157	$ext !~ /^\./
		1158	and open my $fh, "<", "$dir/$ext"
		1159	or next;
		1160
		1161	my %ext = (dir => $dir);
		1162
		1163	while (<$fh>) {
		1164	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1165	my ($pattern, $type, $desc) = split /:/, $1;
		1166	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1167	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1168	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1169	} else {
		1170	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1171	}
		1172	} elsif (/^#:META:BINDING:(.*)/) {
		1173	my ($keysym, $action) = split /:/, $1;
		1174	$ext{binding}{$keysym} = [$ext, $action];
		1175	} elsif (/^\s*(?:#|$)/) {
		1176	# skip other comments and empty lines
		1177	} else {
		1178	last; # stop parsing on first non-empty non-comment line
		1179	}
		1180	}
		1181
		1182	$meta{ext}{$ext} = \%ext;
		1183	}
		1184	}
		1185
		1186	# and now merge resources and bindings
		1187	while (my ($k, $v) = each %{ $meta{ext} }) {
		1188	#TODO: should check for extensions overriding each other
		1189	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1190	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1191	}
		1192	}
		1193
1196	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1194	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1197		1195
1198	Creates a new terminal, very similar as if you had started it with system	1196	Creates a new terminal, very similar as if you had started it with system
1199	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1197	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1200	hash which defines the environment of the new terminal.	1198	hash which defines the environment of the new terminal.
…		…
1217	}	1215	}
1218		1216
1219	=item $term->destroy	1217	=item $term->destroy
1220		1218
1221	Destroy the terminal object (close the window, free resources	1219	Destroy the terminal object (close the window, free resources
1222	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1220	etc.). Please note that urxvt will not exit as long as any event
1223	watchers (timers, io watchers) are still active.	1221	watchers (timers, io watchers) are still active.
1224		1222
1225	=item $term->exec_async ($cmd[, @args])	1223	=item $term->exec_async ($cmd[, @args])
1226		1224
1227	Works like the combination of the C<fork>/C<exec> builtins, which executes	1225	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1254	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1252	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1255		1253
1256	Here is a likely non-exhaustive list of option names, please see the	1254	Here is a likely non-exhaustive list of option names, please see the
1257	source file F</src/optinc.h> to see the actual list:	1255	source file F</src/optinc.h> to see the actual list:
1258		1256
1259	borderLess console cursorBlink cursorUnderline hold iconic insecure	1257	borderLess buffered console cursorBlink cursorUnderline hold iconic
1260	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1258	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1261	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1259	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1262	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1260	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1263	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1261	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1264	transparent tripleclickwords utmpInhibit visualBell	1262	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1263	urgentOnBell utmpInhibit visualBell
1265		1264
1266	=item $value = $term->resource ($name[, $newval])	1265	=item $value = $term->resource ($name[, $newval])
1267		1266
1268	Returns the current resource value associated with a given name and	1267	Returns the current resource value associated with a given name and
1269	optionally sets a new value. Setting values is most useful in the C<init>	1268	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1282		1281
1283	Here is a likely non-exhaustive list of resource names, not all of which	1282	Here is a likely non-exhaustive list of resource names, not all of which
1284	are supported in every build, please see the source file F</src/rsinc.h>	1283	are supported in every build, please see the source file F</src/rsinc.h>
1285	to see the actual list:	1284	to see the actual list:
1286		1285
1287	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1286	answerbackstring backgroundPixmap backspace_key blurradius
1288	borderLess color cursorBlink cursorUnderline cutchars delete_key	1287	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1289	display_name embed ext_bwidth fade font geometry hold iconName	1288	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1290	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1289	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1290	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1291	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1291	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1292	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1292	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1293	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1293	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1294	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1294	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1295	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1295	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1296	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1296	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1297	secondaryScreen secondaryScroll selectstyle shade term_name title	1297	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1298	transient_for transparent transparent_all tripleclickwords utmpInhibit	1298	term_name title transient_for transparent tripleclickwords urgentOnBell
1299	visualBell	1299	utmpInhibit visualBell
1300		1300
1301	=cut	1301	=cut
1302		1302
1303	sub resource($$;$) {	1303	sub resource($$;$) {
1304	my ($self, $name) = (shift, shift);	1304	my ($self, $name) = (shift, shift);
1305	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1305	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1306	&urxvt::term::_resource	1306	goto &urxvt::term::_resource
1307	}	1307	}
1308		1308
1309	=item $value = $term->x_resource ($pattern)	1309	=item $value = $term->x_resource ($pattern)
1310		1310
1311	Returns the X-Resource for the given pattern, excluding the program or	1311	Returns the X-Resource for the given pattern, excluding the program or
1312	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1312	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1313	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1313	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1314	resource with that pattern exists.	1314	resource with that pattern exists.
1315		1315
		1316	Extensions that define extra resources also need to call this method
		1317	to access their values.
		1318
		1319	If the method is called on an extension object (basically, from an
		1320	extension), then the special prefix C<%.> will be replaced by the name of
		1321	the extension and a dot, and the lone string C<%> will be replaced by the
		1322	extension name itself. This makes it possible to code extensions so you
		1323	can rename them and get a new set of resources without having to change
		1324	the actual code.
		1325
1316	This method should only be called during the C<on_start> hook, as there is	1326	This method should only be called during the C<on_start> hook, as there is
1317	only one resource database per display, and later invocations might return	1327	only one resource database per display, and later invocations might return
1318	the wrong resources.	1328	the wrong resources.
1319		1329
1320	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1330	=item $value = $term->x_resource_boolean ($pattern)
1321		1331
		1332	Like C<x_resource>, above, but interprets the string value as a boolean
		1333	and returns C<1> for true values, C<0> for false values and C<undef> if
		1334	the resource or option isn't specified.
		1335
		1336	You should always use this method to parse boolean resources.
		1337
		1338	=cut
		1339
		1340	sub x_resource_boolean {
		1341	my $res = &x_resource;
		1342
		1343	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1344	}
		1345
		1346	=item $success = $term->bind_action ($key, $octets)
		1347
1322	Adds a keymap translation exactly as specified via a resource. See the	1348	Adds a key binding exactly as specified via a C<keysym> resource. See the
1323	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1349	C<keysym> resource in the urxvt(1) manpage.
1324		1350
1325	=item $rend = $term->rstyle ([$new_rstyle])	1351	=item $rend = $term->rstyle ([$new_rstyle])
1326		1352
1327	Return and optionally change the current rendition. Text that is output by	1353	Return and optionally change the current rendition. Text that is output by
1328	the terminal application will use this style.	1354	the terminal application will use this style.
…		…
1336		1362
1337	=item ($row, $col) = $term->selection_beg ([$row, $col])	1363	=item ($row, $col) = $term->selection_beg ([$row, $col])
1338		1364
1339	=item ($row, $col) = $term->selection_end ([$row, $col])	1365	=item ($row, $col) = $term->selection_end ([$row, $col])
1340		1366
1341	Return the current values of the selection mark, begin or end positions,	1367	Return the current values of the selection mark, begin or end positions.
1342	and optionally set them to new values.	1368
		1369	When arguments are given, then the selection coordinates are set to
		1370	C<$row> and C<$col>, and the selection screen is set to the current
		1371	screen.
		1372
		1373	=item $screen = $term->selection_screen ([$screen])
		1374
		1375	Returns the current selection screen, and then optionally sets it.
1343		1376
1344	=item $term->selection_make ($eventtime[, $rectangular])	1377	=item $term->selection_make ($eventtime[, $rectangular])
1345		1378
1346	Tries to make a selection as set by C<selection_beg> and	1379	Tries to make a selection as set by C<selection_beg> and
1347	C<selection_end>. If C<$rectangular> is true (default: false), a	1380	C<selection_end>. If C<$rectangular> is true (default: false), a
1348	rectangular selection will be made. This is the prefered function to make	1381	rectangular selection will be made. This is the preferred function to make
1349	a selection.	1382	a selection.
1350		1383
1351	=item $success = $term->selection_grab ($eventtime)	1384	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1352		1385
1353	Try to request the primary selection text from the server (for example, as	1386	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1387	true) selection from the server. The corresponding text can be set
1354	set by the next method). No visual feedback will be given. This function	1388	with the next method. No visual feedback will be given. This function
1355	is mostly useful from within C<on_sel_grab> hooks.	1389	is mostly useful from within C<on_sel_grab> hooks.
1356		1390
1357	=item $oldtext = $term->selection ([$newtext])	1391	=item $oldtext = $term->selection ([$newtext, $clipboard])
1358		1392
1359	Return the current selection text and optionally replace it by C<$newtext>.	1393	Return the current selection (clipboard if C<$clipboard> is true) text
		1394	and optionally replace it by C<$newtext>.
		1395
		1396	=item $term->selection_clear ([$clipboard])
		1397
		1398	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1360		1399
1361	=item $term->overlay_simple ($x, $y, $text)	1400	=item $term->overlay_simple ($x, $y, $text)
1362		1401
1363	Create a simple multi-line overlay box. See the next method for details.	1402	Create a simple multi-line overlay box. See the next method for details.
1364		1403
…		…
1394		1433
1395	The methods currently supported on C<urxvt::overlay> objects are:	1434	The methods currently supported on C<urxvt::overlay> objects are:
1396		1435
1397	=over 4	1436	=over 4
1398		1437
1399	=item $overlay->set ($x, $y, $text, $rend)	1438	=item $overlay->set ($x, $y, $text[, $rend])
1400		1439
1401	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1440	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1402	text in rxvt-unicode's special encoding and an array of rendition values	1441	text in rxvt-unicode's special encoding and an array of rendition values
1403	at a specific position inside the overlay.	1442	at a specific position inside the overlay.
		1443
		1444	If C<$rend> is missing, then the rendition will not be changed.
1404		1445
1405	=item $overlay->hide	1446	=item $overlay->hide
1406		1447
1407	If visible, hide the overlay, but do not destroy it.	1448	If visible, hide the overlay, but do not destroy it.
1408		1449
…		…
1471		1512
1472	=item $term->scr_add_lines ($string)	1513	=item $term->scr_add_lines ($string)
1473		1514
1474	Write the given text string to the screen, as if output by the application	1515	Write the given text string to the screen, as if output by the application
1475	running inside the terminal. It may not contain command sequences (escape	1516	running inside the terminal. It may not contain command sequences (escape
1476	codes), but is free to use line feeds, carriage returns and tabs. The	1517	codes - see C<cmd_parse> for that), but is free to use line feeds,
1477	string is a normal text string, not in locale-dependent encoding.	1518	carriage returns and tabs. The string is a normal text string, not in
		1519	locale-dependent encoding.
1478		1520
1479	Normally its not a good idea to use this function, as programs might be	1521	Normally its not a good idea to use this function, as programs might be
1480	confused by changes in cursor position or scrolling. Its useful inside a	1522	confused by changes in cursor position or scrolling. Its useful inside a
1481	C<on_add_lines> hook, though.	1523	C<on_add_lines> hook, though.
1482		1524
…		…
1490	locale-specific encoding of the terminal and can contain command sequences	1532	locale-specific encoding of the terminal and can contain command sequences
1491	(escape codes) that will be interpreted.	1533	(escape codes) that will be interpreted.
1492		1534
1493	=item $term->tt_write ($octets)	1535	=item $term->tt_write ($octets)
1494		1536
1495	Write the octets given in C<$data> to the tty (i.e. as program input). To	1537	Write the octets given in C<$octets> to the tty (i.e. as user input
		1538	to the program, see C<cmd_parse> for the opposite direction). To pass
1496	pass characters instead of octets, you should convert your strings first	1539	characters instead of octets, you should convert your strings first to the
1497	to the locale-specific encoding using C<< $term->locale_encode >>.	1540	locale-specific encoding using C<< $term->locale_encode >>.
		1541
		1542	=item $term->tt_write_user_input ($octets)
		1543
		1544	Like C<tt_write>, but should be used when writing strings in response to
		1545	the user pressing a key, to invoke the additional actions requested by
		1546	the user for that case (C<tt_write> doesn't do that).
		1547
		1548	The typical use case would be inside C<on_action> hooks.
		1549
		1550	=item $term->tt_paste ($octets)
		1551
		1552	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1553	CR and bracketing the data with control sequences if bracketed paste mode
		1554	is set.
1498		1555
1499	=item $old_events = $term->pty_ev_events ([$new_events])	1556	=item $old_events = $term->pty_ev_events ([$new_events])
1500		1557
1501	Replaces the event mask of the pty watcher by the given event mask. Can	1558	Replaces the event mask of the pty watcher by the given event mask. Can
1502	be used to suppress input and output handling to the pty/tty. See the	1559	be used to suppress input and output handling to the pty/tty. See the
…		…
1521	Adds the specified events to the vt event mask. Useful e.g. when you want	1578	Adds the specified events to the vt event mask. Useful e.g. when you want
1522	to receive pointer events all the times:	1579	to receive pointer events all the times:
1523		1580
1524	$term->vt_emask_add (urxvt::PointerMotionMask);	1581	$term->vt_emask_add (urxvt::PointerMotionMask);
1525		1582
		1583	=item $term->set_urgency ($set)
		1584
		1585	Enable/disable the urgency hint on the toplevel window.
		1586
1526	=item $term->focus_in	1587	=item $term->focus_in
1527		1588
1528	=item $term->focus_out	1589	=item $term->focus_out
1529		1590
1530	=item $term->key_press ($state, $keycode[, $time])	1591	=item $term->key_press ($state, $keycode[, $time])
…		…
1618		1679
1619	Used after changing terminal contents to display them.	1680	Used after changing terminal contents to display them.
1620		1681
1621	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1682	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1622		1683
1623	Returns the text of the entire row with number C<$row_number>. Row C<0>	1684	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1624	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1685	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1625	terminal line. The scrollback buffer starts at line C<-1> and extends to
1626	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1686	terminal line. Nothing will be returned if a nonexistent line
1627	is requested.	1687	is requested.
1628		1688
1629	If C<$new_text> is specified, it will replace characters in the current	1689	If C<$new_text> is specified, it will replace characters in the current
1630	line, starting at column C<$start_col> (default C<0>), which is useful	1690	line, starting at column C<$start_col> (default C<0>), which is useful
1631	to replace only parts of a line. The font index in the rendition will	1691	to replace only parts of a line. The font index in the rendition will
1632	automatically be updated.	1692	automatically be updated.
1633		1693
1634	C<$text> is in a special encoding: tabs and wide characters that use more	1694	C<$text> is in a special encoding: tabs and wide characters that use more
1635	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1695	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1636	characters. Characters with combining characters and other characters that	1696	characters. Characters with combining characters and other characters that
1637	do not fit into the normal tetx encoding will be replaced with characters	1697	do not fit into the normal text encoding will be replaced with characters
1638	in the private use area.	1698	in the private use area.
1639		1699
1640	You have to obey this encoding when changing text. The advantage is	1700	You have to obey this encoding when changing text. The advantage is
1641	that C<substr> and similar functions work on screen cells and not on	1701	that C<substr> and similar functions work on screen cells and not on
1642	characters.	1702	characters.
…		…
1727	}	1787	}
1728		1788
1729	sub urxvt::line::t {	1789	sub urxvt::line::t {
1730	my ($self) = @_;	1790	my ($self) = @_;
1731		1791
1732	if (@_ > 1)	1792	if (@_ > 1) {
1733	{
1734	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1793	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1735	for $self->{beg} .. $self->{end};	1794	for $self->{beg} .. $self->{end};
1736	}	1795	}
1737		1796
1738	defined wantarray &&	1797	defined wantarray &&
1739	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1798	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1740	0, $self->{len}	1799	0, $self->{len}
1741	}	1800	}
1742		1801
1743	sub urxvt::line::r {	1802	sub urxvt::line::r {
1744	my ($self) = @_;	1803	my ($self) = @_;
1745		1804
1746	if (@_ > 1)	1805	if (@_ > 1) {
1747	{
1748	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1806	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1749	for $self->{beg} .. $self->{end};	1807	for $self->{beg} .. $self->{end};
1750	}	1808	}
1751		1809
1752	if (defined wantarray) {	1810	if (defined wantarray) {
1753	my $rend = [	1811	my $rend = [
1754	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1812	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1755	];	1813	];
…		…
1817	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1875	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1818	recent grab.	1876	recent grab.
1819		1877
1820	=item $term->ungrab	1878	=item $term->ungrab
1821		1879
1822	Calls XUngrab for the most recent grab. Is called automatically on	1880	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1823	evaluation errors, as it is better to lose the grab in the error case as	1881	evaluation errors, as it is better to lose the grab in the error case as
1824	the session.	1882	the session.
1825		1883
1826	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1884	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1827		1885
…		…
1829		1887
1830	=item @atoms = $term->XListProperties ($window)	1888	=item @atoms = $term->XListProperties ($window)
1831		1889
1832	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1890	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1833		1891
1834	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1892	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1835		1893
1836	=item $term->XDeleteProperty ($window, $property)	1894	=item $term->XDeleteProperty ($window, $property)
1837		1895
1838	=item $window = $term->DefaultRootWindow	1896	=item $window = $term->DefaultRootWindow
1839		1897
…		…
1846	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1904	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1847		1905
1848	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1906	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1849		1907
1850	=item $term->XChangeInput ($window, $add_events[, $del_events])	1908	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1909
		1910	=item $keysym = $term->XStringToKeysym ($string)
		1911
		1912	=item $string = $term->XKeysymToString ($keysym)
1851		1913
1852	Various X or X-related functions. The C<$term> object only serves as	1914	Various X or X-related functions. The C<$term> object only serves as
1853	the source of the display, otherwise those functions map more-or-less	1915	the source of the display, otherwise those functions map more-or-less
1854	directory onto the X functions of the same name.	1916	directly onto the X functions of the same name.
1855		1917
1856	=back	1918	=back
1857		1919
1858	=cut	1920	=cut
1859		1921
…		…
1961	my $env = $self->{term}->env;	2023	my $env = $self->{term}->env;
1962	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2024	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1963	delete $env->{LC_ALL};	2025	delete $env->{LC_ALL};
1964	$env->{LC_CTYPE} = $self->{term}->locale;	2026	$env->{LC_CTYPE} = $self->{term}->locale;
1965		2027
1966	urxvt::term->new ($env, "popup",	2028	my $term = urxvt::term->new (
		2029	$env, "popup",
1967	"--perl-lib" => "", "--perl-ext-common" => "",	2030	"--perl-lib" => "", "--perl-ext-common" => "",
1968	"-pty-fd" => -1, "-sl" => 0,	2031	"-pty-fd" => -1, "-sl" => 0,
1969	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2032	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1970	"--transient-for" => $self->{term}->parent,	2033	"--transient-for" => $self->{term}->parent,
1971	"-display" => $self->{term}->display_id,	2034	"-display" => $self->{term}->display_id,
1972	"-pe" => "urxvt-popup")	2035	"-pe" => "urxvt-popup",
1973	or die "unable to create popup window\n";	2036	) or die "unable to create popup window\n";
		2037
		2038	unless (delete $term->{urxvt_popup_init_done}) {
		2039	$term->ungrab;
		2040	$term->destroy;
		2041	die "unable to initialise popup window\n";
		2042	}
1974	}	2043	}
1975		2044
1976	sub DESTROY {	2045	sub DESTROY {
1977	my ($self) = @_;	2046	my ($self) = @_;
1978		2047
…		…
1996	->new	2065	->new
1997	->interval (1)	2066	->interval (1)
1998	->cb (sub {	2067	->cb (sub {
1999	$term->{overlay}->set (0, 0,	2068	$term->{overlay}->set (0, 0,
2000	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2069	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2001	});	2070	});
2002		2071
2003	=over 4	2072	=over 4
2004		2073
2005	=item $timer = new urxvt::timer	2074	=item $timer = new urxvt::timer
2006		2075
…		…
2009		2078
2010	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2079	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2011		2080
2012	Set the callback to be called when the timer triggers.	2081	Set the callback to be called when the timer triggers.
2013		2082
2014	=item $tstamp = $timer->at
2015
2016	Return the time this watcher will fire next.
2017
2018	=item $timer = $timer->set ($tstamp)	2083	=item $timer = $timer->set ($tstamp[, $interval])
2019		2084
2020	Set the time the event is generated to $tstamp.	2085	Set the time the event is generated to $tstamp (and optionally specifies a
		2086	new $interval).
2021		2087
2022	=item $timer = $timer->interval ($interval)	2088	=item $timer = $timer->interval ($interval)
2023		2089
2024	Normally (and when C<$interval> is C<0>), the timer will automatically	2090	By default (and when C<$interval> is C<0>), the timer will automatically
2025	stop after it has fired once. If C<$interval> is non-zero, then the timer	2091	stop after it has fired once. If C<$interval> is non-zero, then the timer
2026	is automatically rescheduled at the given intervals.	2092	is automatically rescheduled at the given intervals.
2027		2093
2028	=item $timer = $timer->start	2094	=item $timer = $timer->start
2029		2095
2030	Start the timer.	2096	Start the timer.
2031		2097
2032	=item $timer = $timer->start ($tstamp)	2098	=item $timer = $timer->start ($tstamp[, $interval])
2033		2099
2034	Set the event trigger time to C<$tstamp> and start the timer.	2100	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2101	also replaces the interval.
2035		2102
2036	=item $timer = $timer->after ($delay)	2103	=item $timer = $timer->after ($delay[, $interval])
2037		2104
2038	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2105	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2039		2106
2040	=item $timer = $timer->stop	2107	=item $timer = $timer->stop
2041		2108
…		…
2049		2116
2050	$term->{socket} = ...	2117	$term->{socket} = ...
2051	$term->{iow} = urxvt::iow	2118	$term->{iow} = urxvt::iow
2052	->new	2119	->new
2053	->fd (fileno $term->{socket})	2120	->fd (fileno $term->{socket})
2054	->events (urxvt::EVENT_READ)	2121	->events (urxvt::EV_READ)
2055	->start	2122	->start
2056	->cb (sub {	2123	->cb (sub {
2057	my ($iow, $revents) = @_;	2124	my ($iow, $revents) = @_;
2058	# $revents must be 1 here, no need to check	2125	# $revents must be 1 here, no need to check
2059	sysread $term->{socket}, my $buf, 8192	2126	sysread $term->{socket}, my $buf, 8192
…		…
2077	Set the file descriptor (not handle) to watch.	2144	Set the file descriptor (not handle) to watch.
2078		2145
2079	=item $iow = $iow->events ($eventmask)	2146	=item $iow = $iow->events ($eventmask)
2080		2147
2081	Set the event mask to watch. The only allowed values are	2148	Set the event mask to watch. The only allowed values are
2082	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2149	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2083	together, or C<urxvt::EVENT_NONE>.	2150	together, or C<urxvt::EV_NONE>.
2084		2151
2085	=item $iow = $iow->start	2152	=item $iow = $iow->start
2086		2153
2087	Start watching for requested events on the given handle.	2154	Start watching for requested events on the given handle.
2088		2155
…		…
2129	->new	2196	->new
2130	->start ($pid)	2197	->start ($pid)
2131	->cb (sub {	2198	->cb (sub {
2132	my ($pw, $exit_status) = @_;	2199	my ($pw, $exit_status) = @_;
2133	...	2200	...
2134	});	2201	});
2135		2202
2136	=over 4	2203	=over 4
2137		2204
2138	=item $pw = new urxvt::pw	2205	=item $pw = new urxvt::pw
2139		2206
…		…
2172		2239
2173	=back	2240	=back
2174		2241
2175	=head1 AUTHOR	2242	=head1 AUTHOR
2176		2243
2177	Marc Lehmann <pcg@goof.com>	2244	Marc Lehmann <schmorp@schmorp.de>
2178	http://software.schmorp.de/pkg/rxvt-unicode	2245	http://software.schmorp.de/pkg/rxvt-unicode
2179		2246
2180	=cut	2247	=cut
2181		2248
2182	1	2249	1

Diff Legend

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