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.145 by root, Thu Aug 10 22:53:20 2006 UTC vs.
Revision 1.243 by sf-exg, Sat Oct 11 22:02:50 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 resources on their own. Similarly to builtin
45		49	resources, these resources can also be specified on the command line
46	=item selection (enabled by default)	50	as long options (with '.' replaced by '-'), in which case the
47		51	corresponding extension is loaded automatically.
48	(More) intelligent selection. This extension tries to be more intelligent
49	when the user extends selections (double-click and further clicks). Right
50	now, it tries to select words, urls and complete shell-quoted
51	arguments, which is very convenient, too, if your F<ls> supports
52	C<--quoting-style=shell>.
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 mark-urls
246
247	Uses per-line display filtering (C<on_line_update>) to underline urls and
248	make them clickable. When middle-clicked, the program specified in the
249	resource C<urlLauncher> (default C<x-www-browser>) will be started with
250	the URL as first argument.
251
252	=item xim-onthespot
253
254	This (experimental) perl extension implements OnTheSpot editing. It does
255	not work perfectly, and some input methods don't seem to work well with
256	OnTheSpot editing in general, but it seems to work at leats for SCIM and
257	kinput2.
258
259	You enable it by specifying this extension and a preedit style of
260	C<OnTheSpot>, i.e.:
261
262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263
264	=item kuake<hotkey>
265
266	A very primitive quake-console-like extension. It was inspired by a
267	description of how the programs C<kuake> and C<yakuake> work: Whenever the
268	user presses a global accelerator key (by default C<F10>), the terminal
269	will show or hide itself. Another press of the accelerator key will hide
270	or show it again.
271
272	Initially, the window will not be shown when using this extension.
273
274	This is useful if you need a single terminal thats not using any desktop
275	space most of the time but is quickly available at the press of a key.
276
277	The accelerator key is grabbed regardless of any modifiers, so this
278	extension will actually grab a physical key just for this function.
279
280	If you want a quake-like animation, tell your window manager to do so
281	(fvwm can do it).
282
283	=item automove-background
284
285	This is basically a very small extension that dynamically changes the
286	background pixmap offset to the window position, in effect creating the
287	same effect as pseudo transparency with a custom pixmap. No scaling is
288	supported in this mode. Example:
289
290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291
292	=item block-graphics-to-ascii
293
294	A not very useful example of filtering all text output to the terminal
295	by replacing all line-drawing characters (U+2500 .. U+259F) by a
296	similar-looking ascii character.
297
298	=item digital-clock
299
300	Displays a digital clock using the built-in overlay.
301
302	=item remote-clipboard
303
304	Somewhat of a misnomer, this extension adds two menu entries to the
305	selection popup that allows one ti run external commands to store the
306	selection somewhere and fetch it again.
307
308	We use it to implement a "distributed selection mechanism", which just
309	means that one command uploads the file to a remote server, and another
310	reads it.
311
312	The commands can be set using the C<URxvt.remote-selection.store> and
313	C<URxvt.remote-selection.fetch> resources. The first should read the
314	selection to store from STDIN (always in UTF-8), the second should provide
315	the selection data on STDOUT (also in UTF-8).
316
317	The defaults (which are likely useless to you) use rsh and cat:
318
319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321
322	=item selection-pastebin
323
324	This is a little rarely useful extension that Uploads the selection as
325	textfile to a remote site (or does other things). (The implementation is
326	not currently secure for use in a multiuser environment as it writes to
327	F</tmp> directly.).
328
329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
330	i.e.
331
332	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
333
334	Pressing this combination runs a command with C<%> replaced by the name of
335	the textfile. This command can be set via a resource:
336
337	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
338
339	And the default is likely not useful to anybody but the few people around
340	here :)
341
342	The name of the textfile is the hex encoded md5 sum of the selection, so
343	the same content should lead to the same filename.
344
345	After a successful upload the selection will be replaced by the text given
346	in the C<selection-pastebin-url> resource (again, the % is the placeholder
347	for the filename):
348
349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350
351	=item example-refresh-hooks
352
353	Displays a very simple digital clock in the upper right corner of the
354	window. Illustrates overwriting the refresh callbacks to create your own
355	overlays or changes.
356
357	=back
358		52
359	=head1 API DOCUMENTATION	53	=head1 API DOCUMENTATION
360		54
361	=head2 General API Considerations	55	=head2 General API Considerations
362		56
…		…
376		70
377	=over 4	71	=over 4
378		72
379	=item $text	73	=item $text
380		74
381	Rxvt-unicodes special way of encoding text, where one "unicode" character	75	Rxvt-unicode's special way of encoding text, where one "unicode" character
382	always represents one screen cell. See L<ROW_t> for a discussion of this format.	76	always represents one screen cell. See L<ROW_t> for a discussion of this format.
383		77
384	=item $string	78	=item $string
385		79
386	A perl text string, with an emphasis on I<text>. It can store all unicode	80	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
390	=item $octets	84	=item $octets
391		85
392	Either binary data or - more common - a text string encoded in a	86	Either binary data or - more common - a text string encoded in a
393	locale-specific way.	87	locale-specific way.
394		88
		89	=item $keysym
		90
		91	an integer that is a valid X11 keysym code. You can convert a string
		92	into a keysym and viceversa by using C<XStringToKeysym> and
		93	C<XKeysymToString>.
		94
395	=back	95	=back
396		96
397	=head2 Extension Objects	97	=head2 Extension Objects
398		98
399	Every perl extension is a perl class. A separate perl object is created	99	Every perl extension is a perl class. A separate perl object is created
400	for each terminal, and each terminal has its own set of extenion objects,	100	for each terminal, and each terminal has its own set of extension objects,
401	which are passed as the first parameter to hooks. So extensions can use	101	which are passed as the first parameter to hooks. So extensions can use
402	their C<$self> object without having to think about clashes with other	102	their C<$self> object without having to think about clashes with other
403	extensions or other terminals, with the exception of methods and members	103	extensions or other terminals, with the exception of methods and members
404	that begin with an underscore character C<_>: these are reserved for	104	that begin with an underscore character C<_>: these are reserved for
405	internal use.	105	internal use.
406		106
407	Although it isn't a C<urxvt::term> object, you can call all methods of the	107	Although it isn't a C<urxvt::term> object, you can call all methods of the
408	C<urxvt::term> class on this object.	108	C<urxvt::term> class on this object.
409		109
410	It has the following methods and data members:	110	Additional methods only supported for extension objects are described in
411		111	the C<urxvt::extension> section below.
412	=over 4
413
414	=item $urxvt_term = $self->{term}
415
416	Returns the C<urxvt::term> object associated with this instance of the
417	extension. This member I<must not> be changed in any way.
418
419	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
420
421	Dynamically enable the given hooks (named without the C<on_> prefix) for
422	this extension, replacing any previous hook. This is useful when you want
423	to overwrite time-critical hooks only temporarily.
424
425	=item $self->disable ($hook_name[, $hook_name..])
426
427	Dynamically disable the given hooks.
428
429	=back
430		112
431	=head2 Hooks	113	=head2 Hooks
432		114
433	The following subroutines can be declared in extension files, and will be	115	The following subroutines can be declared in extension files, and will be
434	called whenever the relevant event happens.	116	called whenever the relevant event happens.
…		…
520		202
521	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	203	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
522	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	204	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
523	number of lines that will be in the scrollback buffer.	205	number of lines that will be in the scrollback buffer.
524		206
525	=item on_osc_seq $term, $op, $args	207	=item on_osc_seq $term, $op, $args, $resp
526		208
527	Called on every OSC sequence and can be used to suppress it or modify its	209	Called on every OSC sequence and can be used to suppress it or modify its
528	behaviour. The default should be to return an empty list. A true value	210	behaviour. The default should be to return an empty list. A true value
529	suppresses execution of the request completely. Make sure you don't get	211	suppresses execution of the request completely. Make sure you don't get
530	confused by recursive invocations when you output an osc sequence within	212	confused by recursive invocations when you output an OSC sequence within
531	this callback.	213	this callback.
532		214
533	C<on_osc_seq_perl> should be used for new behaviour.	215	C<on_osc_seq_perl> should be used for new behaviour.
534		216
535	=item on_osc_seq_perl $term, $string	217	=item on_osc_seq_perl $term, $args, $resp
536		218
537	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	219	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
538	operating system command) is processed. Cursor position and other state	220	operating system command) is processed. Cursor position and other state
539	information is up-to-date when this happens. For interoperability, the	221	information is up-to-date when this happens. For interoperability, the
540	string should start with the extension name and a colon, to distinguish	222	string should start with the extension name (sans -osc) and a semicolon,
541	it from commands for other extensions, and this might be enforced in the	223	to distinguish it from commands for other extensions, and this might be
542	future.	224	enforced in the future.
		225
		226	For example, C<overlay-osc> uses this:
		227
		228	sub on_osc_seq_perl {
		229	my ($self, $osc, $resp) = @_;
		230
		231	return unless $osc =~ s/^overlay;//;
		232
		233	... process remaining $osc string
		234	}
543		235
544	Be careful not ever to trust (in a security sense) the data you receive,	236	Be careful not ever to trust (in a security sense) the data you receive,
545	as its source can not easily be controlled (e-mail content, messages from	237	as its source can not easily be controlled (e-mail content, messages from
546	other users on the same system etc.).	238	other users on the same system etc.).
		239
		240	For responses, C<$resp> contains the end-of-args separator used by the
		241	sender.
547		242
548	=item on_add_lines $term, $string	243	=item on_add_lines $term, $string
549		244
550	Called whenever text is about to be output, with the text as argument. You	245	Called whenever text is about to be output, with the text as argument. You
551	can filter/change and output the text yourself by returning a true value	246	can filter/change and output the text yourself by returning a true value
…		…
556	=item on_tt_write $term, $octets	251	=item on_tt_write $term, $octets
557		252
558	Called whenever some data is written to the tty/pty and can be used to	253	Called whenever some data is written to the tty/pty and can be used to
559	suppress or filter tty input.	254	suppress or filter tty input.
560		255
		256	=item on_tt_paste $term, $octets
		257
		258	Called whenever text is about to be pasted, with the text as argument. You
		259	can filter/change and paste the text yourself by returning a true value
		260	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		261	locale-encoded.
		262
561	=item on_line_update $term, $row	263	=item on_line_update $term, $row
562		264
563	Called whenever a line was updated or changed. Can be used to filter	265	Called whenever a line was updated or changed. Can be used to filter
564	screen output (e.g. underline urls or other useless stuff). Only lines	266	screen output (e.g. underline urls or other useless stuff). Only lines
565	that are being shown will be filtered, and, due to performance reasons,	267	that are being shown will be filtered, and, due to performance reasons,
…		…
572	later with the already-modified line (e.g. if unrelated parts change), so	274	later with the already-modified line (e.g. if unrelated parts change), so
573	you cannot just toggle rendition bits, but only set them.	275	you cannot just toggle rendition bits, but only set them.
574		276
575	=item on_refresh_begin $term	277	=item on_refresh_begin $term
576		278
577	Called just before the screen gets redrawn. Can be used for overlay	279	Called just before the screen gets redrawn. Can be used for overlay or
578	or similar effects by modify terminal contents in refresh_begin, and	280	similar effects by modifying the terminal contents in refresh_begin, and
579	restoring them in refresh_end. The built-in overlay and selection display	281	restoring them in refresh_end. The built-in overlay and selection display
580	code is run after this hook, and takes precedence.	282	code is run after this hook, and takes precedence.
581		283
582	=item on_refresh_end $term	284	=item on_refresh_end $term
583		285
584	Called just after the screen gets redrawn. See C<on_refresh_begin>.	286	Called just after the screen gets redrawn. See C<on_refresh_begin>.
585		287
586	=item on_user_command $term, $string	288	=item on_user_command $term, $string *DEPRECATED*
587		289
588	Called whenever a user-configured event is being activated (e.g. via	290	Called whenever a user-configured event is being activated (e.g. via
589	a C<perl:string> action bound to a key, see description of the B<keysym>	291	a C<perl:string> action bound to a key, see description of the B<keysym>
590	resource in the @@RXVT_NAME@@(1) manpage).	292	resource in the urxvt(1) manpage).
591		293
592	The event is simply the action string. This interface is assumed to change	294	The event is simply the action string. This interface is going away in
593	slightly in the future.	295	preference to the C<on_action> hook.
594		296
595	=item on_resize_all_windows $tern, $new_width, $new_height	297	=item on_resize_all_windows $term, $new_width, $new_height
596		298
597	Called just after the new window size has been calculated, but before	299	Called just after the new window size has been calculated, but before
598	windows are actually being resized or hints are being set. If this hook	300	windows are actually being resized or hints are being set. If this hook
599	returns TRUE, setting of the window hints is being skipped.	301	returns a true value, setting of the window hints is being skipped.
600		302
601	=item on_x_event $term, $event	303	=item on_x_event $term, $event
602		304
603	Called on every X event received on the vt window (and possibly other	305	Called on every X event received on the vt window (and possibly other
604	windows). Should only be used as a last resort. Most event structure	306	windows). Should only be used as a last resort. Most event structure
…		…
634		336
635	=item on_map_notify $term, $event	337	=item on_map_notify $term, $event
636		338
637	=item on_unmap_notify $term, $event	339	=item on_unmap_notify $term, $event
638		340
639	Called whenever the corresponding X event is received for the terminal If	341	Called whenever the corresponding X event is received for the terminal. If
640	the hook returns true, then the even will be ignored by rxvt-unicode.	342	the hook returns true, then the event will be ignored by rxvt-unicode.
641		343
642	The event is a hash with most values as named by Xlib (see the XEvent	344	The event is a hash with most values as named by Xlib (see the XEvent
643	manpage), with the additional members C<row> and C<col>, which are the	345	manpage), with the additional members C<row> and C<col>, which are the
644	(real, not screen-based) row and column under the mouse cursor.	346	(real, not screen-based) row and column under the mouse cursor.
645		347
646	C<on_key_press> additionally receives the string rxvt-unicode would	348	C<on_key_press> additionally receives the string rxvt-unicode would
647	output, if any, in locale-specific encoding.	349	output, if any, in locale-specific encoding.
648		350
649	subwindow.
650
651	=item on_client_message $term, $event	351	=item on_client_message $term, $event
652		352
653	=item on_wm_protocols $term, $event	353	=item on_wm_protocols $term, $event
654		354
655	=item on_wm_delete_window $term, $event	355	=item on_wm_delete_window $term, $event
656		356
657	Called when various types of ClientMessage events are received (all with	357	Called when various types of ClientMessage events are received (all with
658	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	358	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
659		359
		360	=item on_bell $term
		361
		362	Called on receipt of a bell character.
		363
660	=back	364	=back
661		365
662	=cut	366	=cut
663		367
664	package urxvt;	368	package urxvt;
665		369
666	use utf8;	370	use utf8;
667	use strict;	371	use strict 'vars';
668	use Carp ();	372	use Carp ();
669	use Scalar::Util ();	373	use Scalar::Util ();
670	use List::Util ();	374	use List::Util ();
671		375
672	our $VERSION = 1;	376	our $VERSION = 1;
673	our $TERM;	377	our $TERM;
674	our @TERM_INIT;	378	our @TERM_INIT; # should go, prevents async I/O etc.
675	our @TERM_EXT;	379	our @TERM_EXT; # should go, prevents async I/O etc.
676	our @HOOKNAME;	380	our @HOOKNAME;
677	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	381	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
678	our %OPTION;	382	our %OPTION;
679		383
680	our $LIBDIR;	384	our $LIBDIR;
…		…
728		432
729	=over 4	433	=over 4
730		434
731	=item urxvt::fatal $errormessage	435	=item urxvt::fatal $errormessage
732		436
733	Fatally aborts execution with the given error message. Avoid at all	437	Fatally aborts execution with the given error message (which should
734	costs! The only time this is acceptable is when the terminal process	438	include a trailing newline). Avoid at all costs! The only time this
735	starts up.	439	is acceptable (and useful) is in the init hook, where it prevents the
		440	terminal from starting up.
736		441
737	=item urxvt::warn $string	442	=item urxvt::warn $string
738		443
739	Calls C<rxvt_warn> with the given string which should not include a	444	Calls C<rxvt_warn> with the given string which should include a trailing
740	newline. The module also overwrites the C<warn> builtin with a function	445	newline. The module also overwrites the C<warn> builtin with a function
741	that calls this function.	446	that calls this function.
742		447
743	Using this function has the advantage that its output ends up in the	448	Using this function has the advantage that its output ends up in the
744	correct place, e.g. on stderr of the connecting urxvtc client.	449	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
748	=item @terms = urxvt::termlist	453	=item @terms = urxvt::termlist
749		454
750	Returns all urxvt::term objects that exist in this process, regardless of	455	Returns all urxvt::term objects that exist in this process, regardless of
751	whether they are started, being destroyed etc., so be careful. Only term	456	whether they are started, being destroyed etc., so be careful. Only term
752	objects that have perl extensions attached will be returned (because there	457	objects that have perl extensions attached will be returned (because there
753	is no urxvt::term objet associated with others).	458	is no urxvt::term object associated with others).
754		459
755	=item $time = urxvt::NOW	460	=item $time = urxvt::NOW
756		461
757	Returns the "current time" (as per the event loop).	462	Returns the "current time" (as per the event loop).
758		463
…		…
801		506
802	=item $rend = urxvt::OVERLAY_RSTYLE	507	=item $rend = urxvt::OVERLAY_RSTYLE
803		508
804	Return the rendition mask used for overlays by default.	509	Return the rendition mask used for overlays by default.
805		510
806	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	511	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		512	urxvt::RS_RVid, urxvt::RS_Uline
807		513
808	Return the bit that enabled bold, italic, blink, reverse-video and	514	Return the bit that enabled bold, italic, blink, reverse-video and
809	underline, respectively. To enable such a style, just logically OR it into	515	underline, respectively. To enable such a style, just logically OR it into
810	the bitset.	516	the bitset.
811		517
…		…
848	};	554	};
849	}	555	}
850		556
851	no warnings 'utf8';	557	no warnings 'utf8';
852		558
		559	sub parse_resource {
		560	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		561
		562	$term->scan_extensions;
		563
		564	my $r = $term->{meta}{resource};
		565	keys %$r; # reset iterator
		566	while (my ($k, $v) = each %$r) {
		567	my $pattern = $k;
		568	$pattern =~ y/./-/ if $isarg;
		569	my $prefix = $name;
		570	my $suffix;
		571	if ($pattern =~ /\-$/) {
		572	$prefix = substr $name, 0, length $pattern;
		573	$suffix = substr $name, length $pattern;
		574	}
		575	if ($pattern eq $prefix) {
		576	$name = "$urxvt::RESCLASS.$k$suffix";
		577
		578	push @{ $term->{perl_ext_3} }, $v->[0];
		579
		580	if ($v->[1] eq "boolean") {
		581	$term->put_option_db ($name, $flag ? "true" : "false");
		582	return 1;
		583	} else {
		584	$term->put_option_db ($name, $value);
		585	return 1 + 2;
		586	}
		587	}
		588	}
		589
		590	0
		591	}
		592
		593	sub usage {
		594	my ($term, $usage_type) = @_;
		595
		596	$term->scan_extensions;
		597
		598	my $r = $term->{meta}{resource};
		599
		600	for my $pattern (sort keys %$r) {
		601	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		602
		603	$desc .= " (-pe $ext)";
		604
		605	if ($usage_type == 1) {
		606	$pattern =~ y/./-/;
		607	$pattern =~ s/-$/-.../g;
		608
		609	if ($type eq "boolean") {
		610	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		611	} else {
		612	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		613	}
		614	} else {
		615	$pattern =~ s/\.$/.*/g;
		616	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		617	}
		618	}
		619	}
		620
853	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	621	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
854		622
855	sub verbose {	623	sub verbose {
856	my ($level, $msg) = @_;	624	my ($level, $msg) = @_;
857	warn "$msg\n" if $level <= $verbosity;	625	warn "$msg\n" if $level <= $verbosity;
…		…
869	$pkg =~ s/[^[:word:]]/_/g;	637	$pkg =~ s/[^[:word:]]/_/g;
870	$pkg = "urxvt::ext::$pkg";	638	$pkg = "urxvt::ext::$pkg";
871		639
872	verbose 3, "loading extension '$path' into package '$pkg'";	640	verbose 3, "loading extension '$path' into package '$pkg'";
873		641
		642	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		643
874	open my $fh, "<:raw", $path	644	open my $fh, "<:raw", $path
875	or die "$path: $!";	645	or die "$path: $!";
876		646
877	my $source =	647	my $source =
878	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	648	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
879	. "#line 1 \"$path\"\n{\n"	649	. "#line 1 \"$path\"\n{\n"
880	. (do { local $/; <$fh> })	650	. (do { local $/; <$fh> })
881	. "\n};\n1";	651	. "\n};\n1";
882		652
883	eval $source	653	eval $source
…		…
892	# called by the rxvt core	662	# called by the rxvt core
893	sub invoke {	663	sub invoke {
894	local $TERM = shift;	664	local $TERM = shift;
895	my $htype = shift;	665	my $htype = shift;
896		666
897	if ($htype == 0) { # INIT	667	if ($htype == HOOK_INIT) {
898	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	668	my @dirs = $TERM->perl_libdirs;
899		669
		670	$TERM->scan_extensions;
		671
900	my %ext_arg;	672	my %ext_arg;
901		673
902	{	674	{
903	my @init = @TERM_INIT;	675	my @init = @TERM_INIT;
904	@TERM_INIT = ();	676	@TERM_INIT = ();
…		…
906	my @pkg = @TERM_EXT;	678	my @pkg = @TERM_EXT;
907	@TERM_EXT = ();	679	@TERM_EXT = ();
908	$TERM->register_package ($_) for @pkg;	680	$TERM->register_package ($_) for @pkg;
909	}	681	}
910		682
		683	for (
911	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	684	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		685	@{ delete $TERM->{perl_ext_3} }
		686	) {
912	if ($_ eq "default") {	687	if ($_ eq "default") {
913	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	688
		689	$ext_arg{$_} = []
		690	for
		691	qw(selection option-popup selection-popup readline),
		692	map $_->[0], values %{ $TERM->{meta}{binding} };
		693
		694	for ($TERM->_keysym_resources) {
		695	next if /^(?:string|command|builtin|builtin-string|perl)/;
		696	next unless /^([A-Za-z0-9_\-]+):/;
		697
		698	my $ext = $1;
		699
		700	$ext_arg{$ext} = [];
		701	}
		702
914	} elsif (/^-(.*)$/) {	703	} elsif (/^-(.*)$/) {
915	delete $ext_arg{$1};	704	delete $ext_arg{$1};
		705
916	} elsif (/^([^<]+)<(.*)>$/) {	706	} elsif (/^([^<]+)<(.*)>$/) {
917	push @{ $ext_arg{$1} }, $2;	707	push @{ $ext_arg{$1} }, $2;
		708
918	} else {	709	} else {
919	$ext_arg{$_} ||= [];	710	$ext_arg{$_} ||= [];
		711	}
		712	}
		713
		714	# now register default key bindings
		715	for my $ext (sort keys %ext_arg) {
		716	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		717	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
920	}	718	}
921	}	719	}
922		720
923	for my $ext (sort keys %ext_arg) {	721	for my $ext (sort keys %ext_arg) {
924	my @files = grep -f $_, map "$_/$ext", @dirs;	722	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
938		736
939	if (my $cb = $TERM->{_hook}[$htype]) {	737	if (my $cb = $TERM->{_hook}[$htype]) {
940	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	738	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
941	if $verbosity >= 10;	739	if $verbosity >= 10;
942		740
		741	if ($htype == HOOK_ACTION) {
		742	# this hook is only sent to the extension with the name
		743	# matching the first arg
		744	my $pkg = shift;
		745	$pkg =~ y/-/_/;
		746	$pkg = "urxvt::ext::$pkg";
		747
		748	$cb = $cb->{$pkg}
		749	or return undef; #TODO: maybe warn user?
		750
		751	$cb = { $pkg => $cb };
		752	}
		753
943	for my $pkg (keys %$cb) {	754	for my $pkg (keys %$cb) {
944	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	755	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
945	$retval ||= $retval_;	756	$retval ||= $retval_;
946		757
947	if ($@) {	758	if ($@) {
948	$TERM->ungrab; # better to lose the grab than the session	759	$TERM->ungrab; # better to lose the grab than the session
949	warn $@;	760	warn $@;
…		…
952		763
953	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	764	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
954	if $verbosity >= 11;	765	if $verbosity >= 11;
955	}	766	}
956		767
957	if ($htype == 1) { # DESTROY	768	if ($htype == HOOK_DESTROY) {
958	# clear package objects	769	# clear package objects
959	%$_ = () for values %{ $TERM->{_pkg} };	770	%$_ = () for values %{ $TERM->{_pkg} };
960		771
961	# clear package	772	# clear package
962	%$TERM = ();	773	%$TERM = ();
…		…
967		778
968	sub SET_COLOR($$$) {	779	sub SET_COLOR($$$) {
969	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	780	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
970	}	781	}
971		782
972	# urxvt::term::extension	783	sub rend2mask {
		784	no strict 'refs';
		785	my ($str, $mask) = (@_, 0);
		786	my %color = ( fg => undef, bg => undef );
		787	my @failed;
		788	for my $spec ( split /\s+/, $str ) {
		789	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		790	$color{lc($1)} = $2;
		791	} else {
		792	my $neg = $spec =~ s/^[-^]//;
		793	unless ( exists &{"RS_$spec"} ) {
		794	push @failed, $spec;
		795	next;
		796	}
		797	my $cur = &{"RS_$spec"};
		798	if ( $neg ) {
		799	$mask &= ~$cur;
		800	} else {
		801	$mask |= $cur;
		802	}
		803	}
		804	}
		805	($mask, @color{qw(fg bg)}, \@failed)
		806	}
973		807
974	package urxvt::term::extension;	808	package urxvt::term::extension;
975		809
976	sub enable {	810	=head2 The C<urxvt::term::extension> class
977	my ($self, %hook) = @_;
978	my $pkg = $self->{_pkg};
979		811
980	while (my ($name, $cb) = each %hook) {	812	Each extension attached to a terminal object is represented by
981	my $htype = $HOOKTYPE{uc $name};	813	a C<urxvt::term::extension> object.
982	defined $htype
983	or Carp::croak "unsupported hook type '$name'";
984		814
985	$self->set_should_invoke ($htype, +1)	815	You can use these objects, which are passed to all callbacks to store any
986	unless exists $self->{term}{_hook}[$htype]{$pkg};	816	state related to the terminal and extension instance.
987		817
988	$self->{term}{_hook}[$htype]{$pkg} = $cb;	818	The methods (And data members) documented below can be called on extension
989	}	819	objects, in addition to call methods documented for the <urxvt::term>
990	}	820	class.
991		821
992	sub disable {	822	=over 4
993	my ($self, @hook) = @_;
994	my $pkg = $self->{_pkg};
995		823
996	for my $name (@hook) {	824	=item $urxvt_term = $self->{term}
997	my $htype = $HOOKTYPE{uc $name};
998	defined $htype
999	or Carp::croak "unsupported hook type '$name'";
1000		825
1001	$self->set_should_invoke ($htype, -1)	826	Returns the C<urxvt::term> object associated with this instance of the
1002	if delete $self->{term}{_hook}[$htype]{$pkg};	827	extension. This member I<must not> be changed in any way.
1003	}	828
1004	}	829	=cut
1005		830
1006	our $AUTOLOAD;	831	our $AUTOLOAD;
1007		832
1008	sub AUTOLOAD {	833	sub AUTOLOAD {
1009	$AUTOLOAD =~ /:([^:]+)$/	834	$AUTOLOAD =~ /:([^:]+)$/
…		…
1022		847
1023	sub DESTROY {	848	sub DESTROY {
1024	# nop	849	# nop
1025	}	850	}
1026		851
1027	# urxvt::destroy_hook	852	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1028		853
1029	sub urxvt::destroy_hook::DESTROY {	854	sub urxvt::destroy_hook::DESTROY {
1030	${$_[0]}->();	855	${$_[0]}->();
1031	}	856	}
1032		857
1033	sub urxvt::destroy_hook(&) {	858	sub urxvt::destroy_hook(&) {
1034	bless \shift, urxvt::destroy_hook::	859	bless \shift, urxvt::destroy_hook::
1035	}	860	}
		861
		862	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		863
		864	Dynamically enable the given hooks (named without the C<on_> prefix) for
		865	this extension, replacing any hook previously installed via C<enable> in
		866	this extension.
		867
		868	This is useful when you want to overwrite time-critical hooks only
		869	temporarily.
		870
		871	To install additional callbacks for the same hook, you can use the C<on>
		872	method of the C<urxvt::term> class.
		873
		874	=item $self->disable ($hook_name[, $hook_name..])
		875
		876	Dynamically disable the given hooks.
		877
		878	=cut
		879
		880	sub enable {
		881	my ($self, %hook) = @_;
		882	my $pkg = $self->{_pkg};
		883
		884	while (my ($name, $cb) = each %hook) {
		885	my $htype = $HOOKTYPE{uc $name};
		886	defined $htype
		887	or Carp::croak "unsupported hook type '$name'";
		888
		889	$self->set_should_invoke ($htype, +1)
		890	unless exists $self->{term}{_hook}[$htype]{$pkg};
		891
		892	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		893	}
		894	}
		895
		896	sub disable {
		897	my ($self, @hook) = @_;
		898	my $pkg = $self->{_pkg};
		899
		900	for my $name (@hook) {
		901	my $htype = $HOOKTYPE{uc $name};
		902	defined $htype
		903	or Carp::croak "unsupported hook type '$name'";
		904
		905	$self->set_should_invoke ($htype, -1)
		906	if delete $self->{term}{_hook}[$htype]{$pkg};
		907	}
		908	}
		909
		910	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		911
		912	Similar to the C<enable> enable, but installs additional callbacks for
		913	the given hook(s) (that is, it doesn't replace existing callbacks), and
		914	returns a guard object. When the guard object is destroyed the callbacks
		915	are disabled again.
		916
		917	=cut
		918
		919	sub urxvt::extension::on_disable::DESTROY {
		920	my $disable = shift;
		921
		922	my $term = delete $disable->{""};
		923
		924	while (my ($htype, $id) = each %$disable) {
		925	delete $term->{_hook}[$htype]{$id};
		926	$term->set_should_invoke ($htype, -1);
		927	}
		928	}
		929
		930	sub on {
		931	my ($self, %hook) = @_;
		932
		933	my $term = $self->{term};
		934
		935	my %disable = ( "" => $term );
		936
		937	while (my ($name, $cb) = each %hook) {
		938	my $htype = $HOOKTYPE{uc $name};
		939	defined $htype
		940	or Carp::croak "unsupported hook type '$name'";
		941
		942	$term->set_should_invoke ($htype, +1);
		943	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		944	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		945	}
		946
		947	bless \%disable, "urxvt::extension::on_disable"
		948	}
		949
		950	=item $self->x_resource ($pattern)
		951
		952	=item $self->x_resource_boolean ($pattern)
		953
		954	These methods support an additional C<%> prefix when called on an
		955	extension object - see the description of these methods in the
		956	C<urxvt::term> class for details.
		957
		958	=cut
		959
		960	sub x_resource {
		961	my ($self, $name) = @_;
		962	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		963	$self->{term}->x_resource ($name)
		964	}
		965
		966	sub x_resource_boolean {
		967	my ($self, $name) = @_;
		968	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		969	$self->{term}->x_resource_boolean ($name)
		970	}
		971
		972	=back
		973
		974	=cut
1036		975
1037	package urxvt::anyevent;	976	package urxvt::anyevent;
1038		977
1039	=head2 The C<urxvt::anyevent> Class	978	=head2 The C<urxvt::anyevent> Class
1040		979
1041	The sole purpose of this class is to deliver an interface to the	980	The sole purpose of this class is to deliver an interface to the
1042	C<AnyEvent> module - any module using it will work inside urxvt without	981	C<AnyEvent> module - any module using it will work inside urxvt without
1043	further programming. The only exception is that you cannot wait on	982	further programming. The only exception is that you cannot wait on
1044	condition variables, but non-blocking condvar use is ok. What this means	983	condition variables, but non-blocking condvar use is ok.
1045	is that you cannot use blocking APIs, but the non-blocking variant should
1046	work.
1047		984
1048	=cut	985	In practical terms this means is that you cannot use blocking APIs, but
		986	the non-blocking variant should work.
1049		987
		988	=cut
		989
1050	our $VERSION = 1;	990	our $VERSION = '5.23';
1051		991
1052	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	992	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1053	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	993	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1054		994
1055	sub timer {	995	sub timer {
…		…
1057		997
1058	my $cb = $arg{cb};	998	my $cb = $arg{cb};
1059		999
1060	urxvt::timer	1000	urxvt::timer
1061	->new	1001	->new
1062	->start (urxvt::NOW + $arg{after})	1002	->after ($arg{after}, $arg{interval})
1063	->cb (sub {	1003	->cb ($arg{interval} ? $cb : sub {
1064	$_[0]->stop; # need to cancel manually	1004	$_[0]->stop; # need to cancel manually
1065	$cb->();	1005	$cb->();
1066	})	1006	})
1067	}	1007	}
1068		1008
1069	sub io {	1009	sub io {
1070	my ($class, %arg) = @_;	1010	my ($class, %arg) = @_;
1071		1011
1072	my $cb = $arg{cb};	1012	my $cb = $arg{cb};
		1013	my $fd = fileno $arg{fh};
		1014	defined $fd or $fd = $arg{fh};
1073		1015
1074	bless [$arg{fh}, urxvt::iow	1016	bless [$arg{fh}, urxvt::iow
1075	->new	1017	->new
1076	->fd (fileno $arg{fh})	1018	->fd ($fd)
1077	->events (($arg{poll} =~ /r/ ? 1 : 0)	1019	->events (($arg{poll} =~ /r/ ? 1 : 0)
1078	| ($arg{poll} =~ /w/ ? 2 : 0))	1020	| ($arg{poll} =~ /w/ ? 2 : 0))
1079	->start	1021	->start
1080	->cb (sub {	1022	->cb ($cb)
1081	$cb->(($_[1] & 1 ? 'r' : '')
1082	. ($_[1] & 2 ? 'w' : ''));
1083	})],
1084	urxvt::anyevent::	1023	], urxvt::anyevent::
		1024	}
		1025
		1026	sub idle {
		1027	my ($class, %arg) = @_;
		1028
		1029	my $cb = $arg{cb};
		1030
		1031	urxvt::iw
		1032	->new
		1033	->start
		1034	->cb ($cb)
		1035	}
		1036
		1037	sub child {
		1038	my ($class, %arg) = @_;
		1039
		1040	my $cb = $arg{cb};
		1041
		1042	urxvt::pw
		1043	->new
		1044	->start ($arg{pid})
		1045	->cb (sub {
		1046	$_[0]->stop; # need to cancel manually
		1047	$cb->($_[0]->rpid, $_[0]->rstatus);
		1048	})
1085	}	1049	}
1086		1050
1087	sub DESTROY {	1051	sub DESTROY {
1088	$_[0][1]->stop;	1052	$_[0][1]->stop;
1089	}	1053	}
1090		1054
1091	sub condvar {	1055	# only needed for AnyEvent < 6 compatibility
1092	bless \my $flag, urxvt::anyevent::condvar::	1056	sub one_event {
1093	}
1094
1095	sub urxvt::anyevent::condvar::broadcast {
1096	${$_[0]}++;
1097	}
1098
1099	sub urxvt::anyevent::condvar::wait {
1100	unless (${$_[0]}) {
1101	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1057	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1102	}
1103	}	1058	}
1104		1059
1105	package urxvt::term;	1060	package urxvt::term;
1106		1061
1107	=head2 The C<urxvt::term> Class	1062	=head2 The C<urxvt::term> Class
…		…
1120	urxvt::verbose 6, "register package $pkg to $self";	1075	urxvt::verbose 6, "register package $pkg to $self";
1121		1076
1122	@{"$pkg\::ISA"} = urxvt::term::extension::;	1077	@{"$pkg\::ISA"} = urxvt::term::extension::;
1123		1078
1124	my $proxy = bless {	1079	my $proxy = bless {
1125	_pkg => $pkg,	1080	_pkg => $pkg,
		1081	_name => ${"$pkg\::_NAME"}, # hackish
1126	argv => $argv,	1082	argv => $argv,
1127	}, $pkg;	1083	}, $pkg;
1128	Scalar::Util::weaken ($proxy->{term} = $self);	1084	Scalar::Util::weaken ($proxy->{term} = $self);
1129		1085
1130	$self->{_pkg}{$pkg} = $proxy;	1086	$self->{_pkg}{$pkg} = $proxy;
1131		1087
…		…
1134	$proxy->enable ($name => $ref);	1090	$proxy->enable ($name => $ref);
1135	}	1091	}
1136	}	1092	}
1137	}	1093	}
1138		1094
		1095	sub perl_libdirs {
		1096	map { split /:/ }
		1097	$_[0]->resource ("perl_lib"),
		1098	$ENV{URXVT_PERL_LIB},
		1099	"$ENV{HOME}/.urxvt/ext",
		1100	"$LIBDIR/perl"
		1101	}
		1102
		1103	# scan for available extensions and collect their metadata
		1104	sub scan_extensions {
		1105	my ($self) = @_;
		1106
		1107	return if exists $self->{meta};
		1108
		1109	my @libdirs = perl_libdirs $self;
		1110
		1111	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1112
		1113	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1114	$self->{meta} = \my %meta;
		1115
		1116	# first gather extensions
		1117	for my $dir (reverse @libdirs) {
		1118	opendir my $fh, $dir
		1119	or next;
		1120	for my $ext (readdir $fh) {
		1121	$ext !~ /^\./
		1122	and open my $fh, "<", "$dir/$ext"
		1123	or next;
		1124
		1125	my %ext = (dir => $dir);
		1126
		1127	while (<$fh>) {
		1128	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1129	my ($pattern, $type, $desc) = split /:/, $1;
		1130	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1131	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1132	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1133	} else {
		1134	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1135	}
		1136	} elsif (/^#:META:BINDING:(.*)/) {
		1137	my ($keysym, $action) = split /:/, $1;
		1138	$ext{binding}{$keysym} = [$ext, $action];
		1139	} elsif (/^\s*(?:#|$)/) {
		1140	# skip other comments and empty lines
		1141	} else {
		1142	last; # stop parsing on first non-empty non-comment line
		1143	}
		1144	}
		1145
		1146	$meta{ext}{$ext} = \%ext;
		1147	}
		1148	}
		1149
		1150	# and now merge resources and bindings
		1151	while (my ($k, $v) = each %{ $meta{ext} }) {
		1152	#TODO: should check for extensions overriding each other
		1153	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1154	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1155	}
		1156	}
		1157
1139	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1158	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1140		1159
1141	Creates a new terminal, very similar as if you had started it with system	1160	Creates a new terminal, very similar as if you had started it with system
1142	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1161	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1143	hash which defines the environment of the new terminal.	1162	hash which defines the environment of the new terminal.
…		…
1160	}	1179	}
1161		1180
1162	=item $term->destroy	1181	=item $term->destroy
1163		1182
1164	Destroy the terminal object (close the window, free resources	1183	Destroy the terminal object (close the window, free resources
1165	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1184	etc.). Please note that urxvt will not exit as long as any event
1166	watchers (timers, io watchers) are still active.	1185	watchers (timers, io watchers) are still active.
1167		1186
1168	=item $term->exec_async ($cmd[, @args])	1187	=item $term->exec_async ($cmd[, @args])
1169		1188
1170	Works like the combination of the C<fork>/C<exec> builtins, which executes	1189	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1197	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1216	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1198		1217
1199	Here is a likely non-exhaustive list of option names, please see the	1218	Here is a likely non-exhaustive list of option names, please see the
1200	source file F</src/optinc.h> to see the actual list:	1219	source file F</src/optinc.h> to see the actual list:
1201		1220
1202	borderLess console cursorBlink cursorUnderline hold iconic insecure	1221	borderLess buffered console cursorBlink cursorUnderline hold iconic
1203	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1222	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1204	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1223	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1205	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1224	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1206	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1225	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1207	transparent tripleclickwords utmpInhibit visualBell	1226	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1227	urgentOnBell utmpInhibit visualBell
1208		1228
1209	=item $value = $term->resource ($name[, $newval])	1229	=item $value = $term->resource ($name[, $newval])
1210		1230
1211	Returns the current resource value associated with a given name and	1231	Returns the current resource value associated with a given name and
1212	optionally sets a new value. Setting values is most useful in the C<init>	1232	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1225		1245
1226	Here is a likely non-exhaustive list of resource names, not all of which	1246	Here is a likely non-exhaustive list of resource names, not all of which
1227	are supported in every build, please see the source file F</src/rsinc.h>	1247	are supported in every build, please see the source file F</src/rsinc.h>
1228	to see the actual list:	1248	to see the actual list:
1229		1249
1230	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1250	answerbackstring backgroundPixmap backspace_key blurradius
1231	borderLess color cursorBlink cursorUnderline cutchars delete_key	1251	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1232	display_name embed ext_bwidth fade font geometry hold iconName	1252	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1233	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1253	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1254	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1234	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1255	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1235	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1256	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1236	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1257	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1237	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1258	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1238	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1259	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1239	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1260	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1240	secondaryScreen secondaryScroll selectstyle shade term_name title	1261	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1241	transient_for transparent transparent_all tripleclickwords utmpInhibit	1262	term_name title transient_for transparent tripleclickwords urgentOnBell
1242	visualBell	1263	utmpInhibit visualBell
1243		1264
1244	=cut	1265	=cut
1245		1266
1246	sub resource($$;$) {	1267	sub resource($$;$) {
1247	my ($self, $name) = (shift, shift);	1268	my ($self, $name) = (shift, shift);
1248	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1269	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1249	&urxvt::term::_resource	1270	goto &urxvt::term::_resource
1250	}	1271	}
1251		1272
1252	=item $value = $term->x_resource ($pattern)	1273	=item $value = $term->x_resource ($pattern)
1253		1274
1254	Returns the X-Resource for the given pattern, excluding the program or	1275	Returns the X-Resource for the given pattern, excluding the program or
1255	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1276	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1256	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1277	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1257	resource with that pattern exists.	1278	resource with that pattern exists.
1258		1279
		1280	Extensions that define extra resources also need to call this method
		1281	to access their values.
		1282
		1283	If the method is called on an extension object (basically, from an
		1284	extension), then the special prefix C<%.> will be replaced by the name of
		1285	the extension and a dot, and the lone string C<%> will be replaced by the
		1286	extension name itself. This makes it possible to code extensions so you
		1287	can rename them and get a new set of commandline switches and resources
		1288	without having to change the actual code.
		1289
1259	This method should only be called during the C<on_start> hook, as there is	1290	This method should only be called during the C<on_start> hook, as there is
1260	only one resource database per display, and later invocations might return	1291	only one resource database per display, and later invocations might return
1261	the wrong resources.	1292	the wrong resources.
1262		1293
1263	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1294	=item $value = $term->x_resource_boolean ($pattern)
1264		1295
		1296	Like C<x_resource>, above, but interprets the string value as a boolean
		1297	and returns C<1> for true values, C<0> for false values and C<undef> if
		1298	the resource or option isn't specified.
		1299
		1300	You should always use this method to parse boolean resources.
		1301
		1302	=cut
		1303
		1304	sub x_resource_boolean {
		1305	my $res = &x_resource;
		1306
		1307	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1308	}
		1309
		1310	=item $success = $term->bind_action ($key, $octets)
		1311
1265	Adds a keymap translation exactly as specified via a resource. See the	1312	Adds a key binding exactly as specified via a C<keysym> resource. See the
1266	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1313	C<keysym> resource in the urxvt(1) manpage.
1267		1314
1268	=item $rend = $term->rstyle ([$new_rstyle])	1315	=item $rend = $term->rstyle ([$new_rstyle])
1269		1316
1270	Return and optionally change the current rendition. Text that is output by	1317	Return and optionally change the current rendition. Text that is output by
1271	the terminal application will use this style.	1318	the terminal application will use this style.
…		…
1279		1326
1280	=item ($row, $col) = $term->selection_beg ([$row, $col])	1327	=item ($row, $col) = $term->selection_beg ([$row, $col])
1281		1328
1282	=item ($row, $col) = $term->selection_end ([$row, $col])	1329	=item ($row, $col) = $term->selection_end ([$row, $col])
1283		1330
1284	Return the current values of the selection mark, begin or end positions,	1331	Return the current values of the selection mark, begin or end positions.
1285	and optionally set them to new values.	1332
		1333	When arguments are given, then the selection coordinates are set to
		1334	C<$row> and C<$col>, and the selection screen is set to the current
		1335	screen.
		1336
		1337	=item $screen = $term->selection_screen ([$screen])
		1338
		1339	Returns the current selection screen, and then optionally sets it.
1286		1340
1287	=item $term->selection_make ($eventtime[, $rectangular])	1341	=item $term->selection_make ($eventtime[, $rectangular])
1288		1342
1289	Tries to make a selection as set by C<selection_beg> and	1343	Tries to make a selection as set by C<selection_beg> and
1290	C<selection_end>. If C<$rectangular> is true (default: false), a	1344	C<selection_end>. If C<$rectangular> is true (default: false), a
1291	rectangular selection will be made. This is the prefered function to make	1345	rectangular selection will be made. This is the preferred function to make
1292	a selection.	1346	a selection.
1293		1347
1294	=item $success = $term->selection_grab ($eventtime)	1348	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1295		1349
1296	Try to request the primary selection text from the server (for example, as	1350	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1351	true) selection from the server. The corresponding text can be set
1297	set by the next method). No visual feedback will be given. This function	1352	with the next method. No visual feedback will be given. This function
1298	is mostly useful from within C<on_sel_grab> hooks.	1353	is mostly useful from within C<on_sel_grab> hooks.
1299		1354
1300	=item $oldtext = $term->selection ([$newtext])	1355	=item $oldtext = $term->selection ([$newtext, $clipboard])
1301		1356
1302	Return the current selection text and optionally replace it by C<$newtext>.	1357	Return the current selection (clipboard if C<$clipboard> is true) text
		1358	and optionally replace it by C<$newtext>.
		1359
		1360	=item $term->selection_clear ([$clipboard])
		1361
		1362	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1303		1363
1304	=item $term->overlay_simple ($x, $y, $text)	1364	=item $term->overlay_simple ($x, $y, $text)
1305		1365
1306	Create a simple multi-line overlay box. See the next method for details.	1366	Create a simple multi-line overlay box. See the next method for details.
1307		1367
…		…
1337		1397
1338	The methods currently supported on C<urxvt::overlay> objects are:	1398	The methods currently supported on C<urxvt::overlay> objects are:
1339		1399
1340	=over 4	1400	=over 4
1341		1401
1342	=item $overlay->set ($x, $y, $text, $rend)	1402	=item $overlay->set ($x, $y, $text[, $rend])
1343		1403
1344	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1404	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1345	text in rxvt-unicode's special encoding and an array of rendition values	1405	text in rxvt-unicode's special encoding and an array of rendition values
1346	at a specific position inside the overlay.	1406	at a specific position inside the overlay.
		1407
		1408	If C<$rend> is missing, then the rendition will not be changed.
1347		1409
1348	=item $overlay->hide	1410	=item $overlay->hide
1349		1411
1350	If visible, hide the overlay, but do not destroy it.	1412	If visible, hide the overlay, but do not destroy it.
1351		1413
…		…
1433	locale-specific encoding of the terminal and can contain command sequences	1495	locale-specific encoding of the terminal and can contain command sequences
1434	(escape codes) that will be interpreted.	1496	(escape codes) that will be interpreted.
1435		1497
1436	=item $term->tt_write ($octets)	1498	=item $term->tt_write ($octets)
1437		1499
1438	Write the octets given in C<$data> to the tty (i.e. as program input). To	1500	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1439	pass characters instead of octets, you should convert your strings first	1501	pass characters instead of octets, you should convert your strings first
1440	to the locale-specific encoding using C<< $term->locale_encode >>.	1502	to the locale-specific encoding using C<< $term->locale_encode >>.
		1503
		1504	=item $term->tt_write_user_input ($octets)
		1505
		1506	Like C<tt_write>, but should be used when writing strings in response to
		1507	the user pressing a key, to invoke the additional actions requested by
		1508	the user for that case (C<tt_write> doesn't do that).
		1509
		1510	The typical use case would be inside C<on_action> hooks.
		1511
		1512	=item $term->tt_paste ($octets)
		1513
		1514	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1515	CR and bracketing the data with control sequences if bracketed paste mode
		1516	is set.
1441		1517
1442	=item $old_events = $term->pty_ev_events ([$new_events])	1518	=item $old_events = $term->pty_ev_events ([$new_events])
1443		1519
1444	Replaces the event mask of the pty watcher by the given event mask. Can	1520	Replaces the event mask of the pty watcher by the given event mask. Can
1445	be used to suppress input and output handling to the pty/tty. See the	1521	be used to suppress input and output handling to the pty/tty. See the
…		…
1464	Adds the specified events to the vt event mask. Useful e.g. when you want	1540	Adds the specified events to the vt event mask. Useful e.g. when you want
1465	to receive pointer events all the times:	1541	to receive pointer events all the times:
1466		1542
1467	$term->vt_emask_add (urxvt::PointerMotionMask);	1543	$term->vt_emask_add (urxvt::PointerMotionMask);
1468		1544
		1545	=item $term->set_urgency ($set)
		1546
		1547	Enable/disable the urgency hint on the toplevel window.
		1548
1469	=item $term->focus_in	1549	=item $term->focus_in
1470		1550
1471	=item $term->focus_out	1551	=item $term->focus_out
1472		1552
1473	=item $term->key_press ($state, $keycode[, $time])	1553	=item $term->key_press ($state, $keycode[, $time])
…		…
1561		1641
1562	Used after changing terminal contents to display them.	1642	Used after changing terminal contents to display them.
1563		1643
1564	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1644	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1565		1645
1566	Returns the text of the entire row with number C<$row_number>. Row C<0>	1646	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1567	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1647	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1568	terminal line. The scrollback buffer starts at line C<-1> and extends to
1569	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1648	terminal line. Nothing will be returned if a nonexistent line
1570	is requested.	1649	is requested.
1571		1650
1572	If C<$new_text> is specified, it will replace characters in the current	1651	If C<$new_text> is specified, it will replace characters in the current
1573	line, starting at column C<$start_col> (default C<0>), which is useful	1652	line, starting at column C<$start_col> (default C<0>), which is useful
1574	to replace only parts of a line. The font index in the rendition will	1653	to replace only parts of a line. The font index in the rendition will
1575	automatically be updated.	1654	automatically be updated.
1576		1655
1577	C<$text> is in a special encoding: tabs and wide characters that use more	1656	C<$text> is in a special encoding: tabs and wide characters that use more
1578	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1657	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1579	characters. Characters with combining characters and other characters that	1658	characters. Characters with combining characters and other characters that
1580	do not fit into the normal tetx encoding will be replaced with characters	1659	do not fit into the normal text encoding will be replaced with characters
1581	in the private use area.	1660	in the private use area.
1582		1661
1583	You have to obey this encoding when changing text. The advantage is	1662	You have to obey this encoding when changing text. The advantage is
1584	that C<substr> and similar functions work on screen cells and not on	1663	that C<substr> and similar functions work on screen cells and not on
1585	characters.	1664	characters.
…		…
1670	}	1749	}
1671		1750
1672	sub urxvt::line::t {	1751	sub urxvt::line::t {
1673	my ($self) = @_;	1752	my ($self) = @_;
1674		1753
1675	if (@_ > 1)	1754	if (@_ > 1) {
1676	{
1677	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1755	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1678	for $self->{beg} .. $self->{end};	1756	for $self->{beg} .. $self->{end};
1679	}	1757	}
1680		1758
1681	defined wantarray &&	1759	defined wantarray &&
1682	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1760	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1683	0, $self->{len}	1761	0, $self->{len}
1684	}	1762	}
1685		1763
1686	sub urxvt::line::r {	1764	sub urxvt::line::r {
1687	my ($self) = @_;	1765	my ($self) = @_;
1688		1766
1689	if (@_ > 1)	1767	if (@_ > 1) {
1690	{
1691	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1768	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1692	for $self->{beg} .. $self->{end};	1769	for $self->{beg} .. $self->{end};
1693	}	1770	}
1694		1771
1695	if (defined wantarray) {	1772	if (defined wantarray) {
1696	my $rend = [	1773	my $rend = [
1697	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1774	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1698	];	1775	];
…		…
1760	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1837	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1761	recent grab.	1838	recent grab.
1762		1839
1763	=item $term->ungrab	1840	=item $term->ungrab
1764		1841
1765	Calls XUngrab for the most recent grab. Is called automatically on	1842	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1766	evaluation errors, as it is better to lose the grab in the error case as	1843	evaluation errors, as it is better to lose the grab in the error case as
1767	the session.	1844	the session.
1768		1845
1769	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1846	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1770		1847
…		…
1772		1849
1773	=item @atoms = $term->XListProperties ($window)	1850	=item @atoms = $term->XListProperties ($window)
1774		1851
1775	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1852	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1776		1853
1777	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1854	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1778		1855
1779	=item $term->XDeleteProperty ($window, $property)	1856	=item $term->XDeleteProperty ($window, $property)
1780		1857
1781	=item $window = $term->DefaultRootWindow	1858	=item $window = $term->DefaultRootWindow
1782		1859
…		…
1789	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1866	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1790		1867
1791	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1868	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1792		1869
1793	=item $term->XChangeInput ($window, $add_events[, $del_events])	1870	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1871
		1872	=item $keysym = $term->XStringToKeysym ($string)
		1873
		1874	=item $string = $term->XKeysymToString ($keysym)
1794		1875
1795	Various X or X-related functions. The C<$term> object only serves as	1876	Various X or X-related functions. The C<$term> object only serves as
1796	the source of the display, otherwise those functions map more-or-less	1877	the source of the display, otherwise those functions map more-or-less
1797	directory onto the X functions of the same name.	1878	directly onto the X functions of the same name.
1798		1879
1799	=back	1880	=back
1800		1881
1801	=cut	1882	=cut
1802		1883
…		…
1904	my $env = $self->{term}->env;	1985	my $env = $self->{term}->env;
1905	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1986	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1906	delete $env->{LC_ALL};	1987	delete $env->{LC_ALL};
1907	$env->{LC_CTYPE} = $self->{term}->locale;	1988	$env->{LC_CTYPE} = $self->{term}->locale;
1908		1989
1909	urxvt::term->new ($env, "popup",	1990	my $term = urxvt::term->new (
		1991	$env, "popup",
1910	"--perl-lib" => "", "--perl-ext-common" => "",	1992	"--perl-lib" => "", "--perl-ext-common" => "",
1911	"-pty-fd" => -1, "-sl" => 0,	1993	"-pty-fd" => -1, "-sl" => 0,
1912	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1994	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1913	"--transient-for" => $self->{term}->parent,	1995	"--transient-for" => $self->{term}->parent,
1914	"-display" => $self->{term}->display_id,	1996	"-display" => $self->{term}->display_id,
1915	"-pe" => "urxvt-popup")	1997	"-pe" => "urxvt-popup",
1916	or die "unable to create popup window\n";	1998	) or die "unable to create popup window\n";
		1999
		2000	unless (delete $term->{urxvt_popup_init_done}) {
		2001	$term->ungrab;
		2002	$term->destroy;
		2003	die "unable to initialise popup window\n";
		2004	}
1917	}	2005	}
1918		2006
1919	sub DESTROY {	2007	sub DESTROY {
1920	my ($self) = @_;	2008	my ($self) = @_;
1921		2009
…		…
1926	=back	2014	=back
1927		2015
1928	=cut	2016	=cut
1929		2017
1930	package urxvt::watcher;	2018	package urxvt::watcher;
1931
1932	@urxvt::timer::ISA = __PACKAGE__;
1933	@urxvt::iow::ISA = __PACKAGE__;
1934	@urxvt::pw::ISA = __PACKAGE__;
1935	@urxvt::iw::ISA = __PACKAGE__;
1936		2019
1937	=head2 The C<urxvt::timer> Class	2020	=head2 The C<urxvt::timer> Class
1938		2021
1939	This class implements timer watchers/events. Time is represented as a	2022	This class implements timer watchers/events. Time is represented as a
1940	fractional number of seconds since the epoch. Example:	2023	fractional number of seconds since the epoch. Example:
…		…
1944	->new	2027	->new
1945	->interval (1)	2028	->interval (1)
1946	->cb (sub {	2029	->cb (sub {
1947	$term->{overlay}->set (0, 0,	2030	$term->{overlay}->set (0, 0,
1948	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2031	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1949	});	2032	});
1950		2033
1951	=over 4	2034	=over 4
1952		2035
1953	=item $timer = new urxvt::timer	2036	=item $timer = new urxvt::timer
1954		2037
…		…
1957		2040
1958	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2041	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1959		2042
1960	Set the callback to be called when the timer triggers.	2043	Set the callback to be called when the timer triggers.
1961		2044
1962	=item $tstamp = $timer->at
1963
1964	Return the time this watcher will fire next.
1965
1966	=item $timer = $timer->set ($tstamp)	2045	=item $timer = $timer->set ($tstamp[, $interval])
1967		2046
1968	Set the time the event is generated to $tstamp.	2047	Set the time the event is generated to $tstamp (and optionally specifies a
		2048	new $interval).
1969		2049
1970	=item $timer = $timer->interval ($interval)	2050	=item $timer = $timer->interval ($interval)
1971		2051
1972	Normally (and when C<$interval> is C<0>), the timer will automatically	2052	By default (and when C<$interval> is C<0>), the timer will automatically
1973	stop after it has fired once. If C<$interval> is non-zero, then the timer	2053	stop after it has fired once. If C<$interval> is non-zero, then the timer
1974	is automatically rescheduled at the given intervals.	2054	is automatically rescheduled at the given intervals.
1975		2055
1976	=item $timer = $timer->start	2056	=item $timer = $timer->start
1977		2057
1978	Start the timer.	2058	Start the timer.
1979		2059
1980	=item $timer = $timer->start ($tstamp)	2060	=item $timer = $timer->start ($tstamp[, $interval])
1981		2061
1982	Set the event trigger time to C<$tstamp> and start the timer.	2062	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2063	also replaces the interval.
1983		2064
1984	=item $timer = $timer->after ($delay)	2065	=item $timer = $timer->after ($delay[, $interval])
1985		2066
1986	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2067	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1987		2068
1988	=item $timer = $timer->stop	2069	=item $timer = $timer->stop
1989		2070
…		…
1997		2078
1998	$term->{socket} = ...	2079	$term->{socket} = ...
1999	$term->{iow} = urxvt::iow	2080	$term->{iow} = urxvt::iow
2000	->new	2081	->new
2001	->fd (fileno $term->{socket})	2082	->fd (fileno $term->{socket})
2002	->events (urxvt::EVENT_READ)	2083	->events (urxvt::EV_READ)
2003	->start	2084	->start
2004	->cb (sub {	2085	->cb (sub {
2005	my ($iow, $revents) = @_;	2086	my ($iow, $revents) = @_;
2006	# $revents must be 1 here, no need to check	2087	# $revents must be 1 here, no need to check
2007	sysread $term->{socket}, my $buf, 8192	2088	sysread $term->{socket}, my $buf, 8192
…		…
2025	Set the file descriptor (not handle) to watch.	2106	Set the file descriptor (not handle) to watch.
2026		2107
2027	=item $iow = $iow->events ($eventmask)	2108	=item $iow = $iow->events ($eventmask)
2028		2109
2029	Set the event mask to watch. The only allowed values are	2110	Set the event mask to watch. The only allowed values are
2030	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2111	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2031	together, or C<urxvt::EVENT_NONE>.	2112	together, or C<urxvt::EV_NONE>.
2032		2113
2033	=item $iow = $iow->start	2114	=item $iow = $iow->start
2034		2115
2035	Start watching for requested events on the given handle.	2116	Start watching for requested events on the given handle.
2036		2117
…		…
2077	->new	2158	->new
2078	->start ($pid)	2159	->start ($pid)
2079	->cb (sub {	2160	->cb (sub {
2080	my ($pw, $exit_status) = @_;	2161	my ($pw, $exit_status) = @_;
2081	...	2162	...
2082	});	2163	});
2083		2164
2084	=over 4	2165	=over 4
2085		2166
2086	=item $pw = new urxvt::pw	2167	=item $pw = new urxvt::pw
2087		2168
…		…
2120		2201
2121	=back	2202	=back
2122		2203
2123	=head1 AUTHOR	2204	=head1 AUTHOR
2124		2205
2125	Marc Lehmann <pcg@goof.com>	2206	Marc Lehmann <schmorp@schmorp.de>
2126	http://software.schmorp.de/pkg/rxvt-unicode	2207	http://software.schmorp.de/pkg/rxvt-unicode
2127		2208
2128	=cut	2209	=cut
2129		2210
2130	1	2211	1
		2212
		2213	# vim: sw=3:

Diff Legend

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