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.146 by root, Thu Aug 17 21:56:11 2006 UTC vs.
Revision 1.249 by root, Fri Dec 26 21:26:37 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 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	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
352	the double C</> characters as comment start. Use C<\057\057> instead,
353	which works regardless of wether xrdb is used to parse the resource file
354	or not.
355
356	=item example-refresh-hooks
357
358	Displays a very simple digital clock in the upper right corner of the
359	window. Illustrates overwriting the refresh callbacks to create your own
360	overlays or changes.
361
362	=back
363		57
364	=head1 API DOCUMENTATION	58	=head1 API DOCUMENTATION
365		59
366	=head2 General API Considerations	60	=head2 General API Considerations
367		61
…		…
381		75
382	=over 4	76	=over 4
383		77
384	=item $text	78	=item $text
385		79
386	Rxvt-unicodes special way of encoding text, where one "unicode" character	80	Rxvt-unicode's special way of encoding text, where one "unicode" character
387	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.
388		82
389	=item $string	83	=item $string
390		84
391	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
…		…
395	=item $octets	89	=item $octets
396		90
397	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
398	locale-specific way.	92	locale-specific way.
399		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
400	=back	100	=back
401		101
402	=head2 Extension Objects	102	=head2 Extension Objects
403		103
404	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
405	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,
406	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
407	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
408	extensions or other terminals, with the exception of methods and members	108	extensions or other terminals, with the exception of methods and members
409	that begin with an underscore character C<_>: these are reserved for	109	that begin with an underscore character C<_>: these are reserved for
410	internal use.	110	internal use.
411		111
412	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
413	C<urxvt::term> class on this object.	113	C<urxvt::term> class on this object.
414		114
415	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 meta comments in extensions that define
		121	different types of metadata.
		122
		123	Currently, it recxognises only one such comment:
416		124
417	=over 4	125	=over 4
418		126
419	=item $urxvt_term = $self->{term}	127	=item #:META:RESOURCE:name:type:desc
420		128
421	Returns the C<urxvt::term> object associated with this instance of the	129	The RESOURCE comment defines a resource used by the extension, where
422	extension. This member I<must not> be changed in any way.	130	C<name> is the resource name, C<type> is the resource type, C<boolean>
423		131	or C<string>, and C<desc> is the resource description.
424	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
425
426	Dynamically enable the given hooks (named without the C<on_> prefix) for
427	this extension, replacing any previous hook. This is useful when you want
428	to overwrite time-critical hooks only temporarily.
429
430	=item $self->disable ($hook_name[, $hook_name..])
431
432	Dynamically disable the given hooks.
433		132
434	=back	133	=back
435		134
436	=head2 Hooks	135	=head2 Hooks
437		136
…		…
525		224
526	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	225	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
527	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	226	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
528	number of lines that will be in the scrollback buffer.	227	number of lines that will be in the scrollback buffer.
529		228
530	=item on_osc_seq $term, $op, $args	229	=item on_osc_seq $term, $op, $args, $resp
531		230
532	Called on every OSC sequence and can be used to suppress it or modify its	231	Called on every OSC sequence and can be used to suppress it or modify its
533	behaviour. The default should be to return an empty list. A true value	232	behaviour. The default should be to return an empty list. A true value
534	suppresses execution of the request completely. Make sure you don't get	233	suppresses execution of the request completely. Make sure you don't get
535	confused by recursive invocations when you output an osc sequence within	234	confused by recursive invocations when you output an OSC sequence within
536	this callback.	235	this callback.
537		236
538	C<on_osc_seq_perl> should be used for new behaviour.	237	C<on_osc_seq_perl> should be used for new behaviour.
539		238
540	=item on_osc_seq_perl $term, $string	239	=item on_osc_seq_perl $term, $args, $resp
541		240
542	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	241	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
543	operating system command) is processed. Cursor position and other state	242	operating system command) is processed. Cursor position and other state
544	information is up-to-date when this happens. For interoperability, the	243	information is up-to-date when this happens. For interoperability, the
545	string should start with the extension name and a colon, to distinguish	244	string should start with the extension name (sans -osc) and a semicolon,
546	it from commands for other extensions, and this might be enforced in the	245	to distinguish it from commands for other extensions, and this might be
547	future.	246	enforced in the future.
		247
		248	For example, C<overlay-osc> uses this:
		249
		250	sub on_osc_seq_perl {
		251	my ($self, $osc, $resp) = @_;
		252
		253	return unless $osc =~ s/^overlay;//;
		254
		255	... process remaining $osc string
		256	}
548		257
549	Be careful not ever to trust (in a security sense) the data you receive,	258	Be careful not ever to trust (in a security sense) the data you receive,
550	as its source can not easily be controlled (e-mail content, messages from	259	as its source can not easily be controlled (e-mail content, messages from
551	other users on the same system etc.).	260	other users on the same system etc.).
		261
		262	For responses, C<$resp> contains the end-of-args separator used by the
		263	sender.
552		264
553	=item on_add_lines $term, $string	265	=item on_add_lines $term, $string
554		266
555	Called whenever text is about to be output, with the text as argument. You	267	Called whenever text is about to be output, with the text as argument. You
556	can filter/change and output the text yourself by returning a true value	268	can filter/change and output the text yourself by returning a true value
…		…
561	=item on_tt_write $term, $octets	273	=item on_tt_write $term, $octets
562		274
563	Called whenever some data is written to the tty/pty and can be used to	275	Called whenever some data is written to the tty/pty and can be used to
564	suppress or filter tty input.	276	suppress or filter tty input.
565		277
		278	=item on_tt_paste $term, $octets
		279
		280	Called whenever text is about to be pasted, with the text as argument. You
		281	can filter/change and paste the text yourself by returning a true value
		282	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		283	locale-encoded.
		284
566	=item on_line_update $term, $row	285	=item on_line_update $term, $row
567		286
568	Called whenever a line was updated or changed. Can be used to filter	287	Called whenever a line was updated or changed. Can be used to filter
569	screen output (e.g. underline urls or other useless stuff). Only lines	288	screen output (e.g. underline urls or other useless stuff). Only lines
570	that are being shown will be filtered, and, due to performance reasons,	289	that are being shown will be filtered, and, due to performance reasons,
…		…
577	later with the already-modified line (e.g. if unrelated parts change), so	296	later with the already-modified line (e.g. if unrelated parts change), so
578	you cannot just toggle rendition bits, but only set them.	297	you cannot just toggle rendition bits, but only set them.
579		298
580	=item on_refresh_begin $term	299	=item on_refresh_begin $term
581		300
582	Called just before the screen gets redrawn. Can be used for overlay	301	Called just before the screen gets redrawn. Can be used for overlay or
583	or similar effects by modify terminal contents in refresh_begin, and	302	similar effects by modifying the terminal contents in refresh_begin, and
584	restoring them in refresh_end. The built-in overlay and selection display	303	restoring them in refresh_end. The built-in overlay and selection display
585	code is run after this hook, and takes precedence.	304	code is run after this hook, and takes precedence.
586		305
587	=item on_refresh_end $term	306	=item on_refresh_end $term
588		307
589	Called just after the screen gets redrawn. See C<on_refresh_begin>.	308	Called just after the screen gets redrawn. See C<on_refresh_begin>.
590		309
		310	=item on_action $term, $string
		311
		312	Called whenever an action is invoked for the corresponding extension
		313	(e.g. via a C<extension:string> builtin action bound to a key, see
		314	description of the B<keysym> resource in the urxvt(1) manpage). The
		315	event is simply the action string. Note that an action event is always
		316	associated to a single extension.
		317
591	=item on_user_command $term, $string	318	=item on_user_command $term, $string *DEPRECATED*
592		319
593	Called whenever a user-configured event is being activated (e.g. via	320	Called whenever a user-configured event is being activated (e.g. via
594	a C<perl:string> action bound to a key, see description of the B<keysym>	321	a C<perl:string> action bound to a key, see description of the B<keysym>
595	resource in the @@RXVT_NAME@@(1) manpage).	322	resource in the urxvt(1) manpage).
596		323
597	The event is simply the action string. This interface is assumed to change	324	The event is simply the action string. This interface is going away in
598	slightly in the future.	325	preference to the C<on_action> hook.
599		326
600	=item on_resize_all_windows $tern, $new_width, $new_height	327	=item on_resize_all_windows $term, $new_width, $new_height
601		328
602	Called just after the new window size has been calculated, but before	329	Called just after the new window size has been calculated, but before
603	windows are actually being resized or hints are being set. If this hook	330	windows are actually being resized or hints are being set. If this hook
604	returns TRUE, setting of the window hints is being skipped.	331	returns a true value, setting of the window hints is being skipped.
605		332
606	=item on_x_event $term, $event	333	=item on_x_event $term, $event
607		334
608	Called on every X event received on the vt window (and possibly other	335	Called on every X event received on the vt window (and possibly other
609	windows). Should only be used as a last resort. Most event structure	336	windows). Should only be used as a last resort. Most event structure
…		…
639		366
640	=item on_map_notify $term, $event	367	=item on_map_notify $term, $event
641		368
642	=item on_unmap_notify $term, $event	369	=item on_unmap_notify $term, $event
643		370
644	Called whenever the corresponding X event is received for the terminal If	371	Called whenever the corresponding X event is received for the terminal. If
645	the hook returns true, then the even will be ignored by rxvt-unicode.	372	the hook returns true, then the event will be ignored by rxvt-unicode.
646		373
647	The event is a hash with most values as named by Xlib (see the XEvent	374	The event is a hash with most values as named by Xlib (see the XEvent
648	manpage), with the additional members C<row> and C<col>, which are the	375	manpage), with the additional members C<row> and C<col>, which are the
649	(real, not screen-based) row and column under the mouse cursor.	376	(real, not screen-based) row and column under the mouse cursor.
650		377
651	C<on_key_press> additionally receives the string rxvt-unicode would	378	C<on_key_press> additionally receives the string rxvt-unicode would
652	output, if any, in locale-specific encoding.	379	output, if any, in locale-specific encoding.
653		380
654	subwindow.
655
656	=item on_client_message $term, $event	381	=item on_client_message $term, $event
657		382
658	=item on_wm_protocols $term, $event	383	=item on_wm_protocols $term, $event
659		384
660	=item on_wm_delete_window $term, $event	385	=item on_wm_delete_window $term, $event
661		386
662	Called when various types of ClientMessage events are received (all with	387	Called when various types of ClientMessage events are received (all with
663	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	388	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
664		389
		390	=item on_bell $term
		391
		392	Called on receipt of a bell character.
		393
665	=back	394	=back
666		395
667	=cut	396	=cut
668		397
669	package urxvt;	398	package urxvt;
670		399
671	use utf8;	400	use utf8;
672	use strict;	401	use strict 'vars';
673	use Carp ();	402	use Carp ();
674	use Scalar::Util ();	403	use Scalar::Util ();
675	use List::Util ();	404	use List::Util ();
676		405
677	our $VERSION = 1;	406	our $VERSION = 1;
678	our $TERM;	407	our $TERM;
679	our @TERM_INIT;	408	our @TERM_INIT; # should go, prevents async I/O etc.
680	our @TERM_EXT;	409	our @TERM_EXT; # should go, prevents async I/O etc.
681	our @HOOKNAME;	410	our @HOOKNAME;
682	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	411	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
683	our %OPTION;	412	our %OPTION;
684		413
685	our $LIBDIR;	414	our $LIBDIR;
…		…
733		462
734	=over 4	463	=over 4
735		464
736	=item urxvt::fatal $errormessage	465	=item urxvt::fatal $errormessage
737		466
738	Fatally aborts execution with the given error message. Avoid at all	467	Fatally aborts execution with the given error message (which should
739	costs! The only time this is acceptable is when the terminal process	468	include a trailing newline). Avoid at all costs! The only time this
740	starts up.	469	is acceptable (and useful) is in the init hook, where it prevents the
		470	terminal from starting up.
741		471
742	=item urxvt::warn $string	472	=item urxvt::warn $string
743		473
744	Calls C<rxvt_warn> with the given string which should not include a	474	Calls C<rxvt_warn> with the given string which should include a trailing
745	newline. The module also overwrites the C<warn> builtin with a function	475	newline. The module also overwrites the C<warn> builtin with a function
746	that calls this function.	476	that calls this function.
747		477
748	Using this function has the advantage that its output ends up in the	478	Using this function has the advantage that its output ends up in the
749	correct place, e.g. on stderr of the connecting urxvtc client.	479	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
753	=item @terms = urxvt::termlist	483	=item @terms = urxvt::termlist
754		484
755	Returns all urxvt::term objects that exist in this process, regardless of	485	Returns all urxvt::term objects that exist in this process, regardless of
756	whether they are started, being destroyed etc., so be careful. Only term	486	whether they are started, being destroyed etc., so be careful. Only term
757	objects that have perl extensions attached will be returned (because there	487	objects that have perl extensions attached will be returned (because there
758	is no urxvt::term objet associated with others).	488	is no urxvt::term object associated with others).
759		489
760	=item $time = urxvt::NOW	490	=item $time = urxvt::NOW
761		491
762	Returns the "current time" (as per the event loop).	492	Returns the "current time" (as per the event loop).
763		493
…		…
806		536
807	=item $rend = urxvt::OVERLAY_RSTYLE	537	=item $rend = urxvt::OVERLAY_RSTYLE
808		538
809	Return the rendition mask used for overlays by default.	539	Return the rendition mask used for overlays by default.
810		540
811	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	541	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		542	urxvt::RS_RVid, urxvt::RS_Uline
812		543
813	Return the bit that enabled bold, italic, blink, reverse-video and	544	Return the bit that enabled bold, italic, blink, reverse-video and
814	underline, respectively. To enable such a style, just logically OR it into	545	underline, respectively. To enable such a style, just logically OR it into
815	the bitset.	546	the bitset.
816		547
…		…
853	};	584	};
854	}	585	}
855		586
856	no warnings 'utf8';	587	no warnings 'utf8';
857		588
		589	sub parse_resource {
		590	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		591
		592	$term->scan_extensions;
		593
		594	my $r = $term->{meta}{resource};
		595	keys %$r; # reset iterator
		596	while (my ($k, $v) = each %$r) {
		597	my $pattern = $k;
		598	$pattern =~ y/./-/ if $isarg;
		599	my $prefix = $name;
		600	my $suffix;
		601	if ($pattern =~ /\-$/) {
		602	$prefix = substr $name, 0, length $pattern;
		603	$suffix = substr $name, length $pattern;
		604	}
		605	if ($pattern eq $prefix) {
		606	$name = "$urxvt::RESCLASS.$k$suffix";
		607
		608	push @{ $term->{perl_ext_3} }, $v->[0];
		609
		610	if ($v->[1] eq "boolean") {
		611	$term->put_option_db ($name, $flag ? "true" : "false");
		612	return 1;
		613	} else {
		614	$term->put_option_db ($name, $value);
		615	return 1 + 2;
		616	}
		617	}
		618	}
		619
		620	0
		621	}
		622
		623	sub usage {
		624	my ($term, $usage_type) = @_;
		625
		626	$term->scan_extensions;
		627
		628	my $r = $term->{meta}{resource};
		629
		630	for my $pattern (sort keys %$r) {
		631	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		632
		633	$desc .= " (-pe $ext)";
		634
		635	if ($usage_type == 1) {
		636	$pattern =~ y/./-/;
		637	$pattern =~ s/-$/-.../g;
		638
		639	if ($type eq "boolean") {
		640	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		641	} else {
		642	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		643	}
		644	} else {
		645	$pattern =~ s/\.$/.*/g;
		646	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		647	}
		648	}
		649	}
		650
858	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	651	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
859		652
860	sub verbose {	653	sub verbose {
861	my ($level, $msg) = @_;	654	my ($level, $msg) = @_;
862	warn "$msg\n" if $level <= $verbosity;	655	warn "$msg\n" if $level <= $verbosity;
…		…
874	$pkg =~ s/[^[:word:]]/_/g;	667	$pkg =~ s/[^[:word:]]/_/g;
875	$pkg = "urxvt::ext::$pkg";	668	$pkg = "urxvt::ext::$pkg";
876		669
877	verbose 3, "loading extension '$path' into package '$pkg'";	670	verbose 3, "loading extension '$path' into package '$pkg'";
878		671
		672	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		673
879	open my $fh, "<:raw", $path	674	open my $fh, "<:raw", $path
880	or die "$path: $!";	675	or die "$path: $!";
881		676
882	my $source =	677	my $source =
883	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	678	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
884	. "#line 1 \"$path\"\n{\n"	679	. "#line 1 \"$path\"\n{\n"
885	. (do { local $/; <$fh> })	680	. (do { local $/; <$fh> })
886	. "\n};\n1";	681	. "\n};\n1";
887		682
888	eval $source	683	eval $source
…		…
897	# called by the rxvt core	692	# called by the rxvt core
898	sub invoke {	693	sub invoke {
899	local $TERM = shift;	694	local $TERM = shift;
900	my $htype = shift;	695	my $htype = shift;
901		696
902	if ($htype == 0) { # INIT	697	if ($htype == HOOK_INIT) {
903	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	698	my @dirs = $TERM->perl_libdirs;
904		699
		700	$TERM->scan_extensions;
		701
905	my %ext_arg;	702	my %ext_arg;
906		703
907	{	704	{
908	my @init = @TERM_INIT;	705	my @init = @TERM_INIT;
909	@TERM_INIT = ();	706	@TERM_INIT = ();
…		…
911	my @pkg = @TERM_EXT;	708	my @pkg = @TERM_EXT;
912	@TERM_EXT = ();	709	@TERM_EXT = ();
913	$TERM->register_package ($_) for @pkg;	710	$TERM->register_package ($_) for @pkg;
914	}	711	}
915		712
		713	for (
916	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	714	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		715	@{ delete $TERM->{perl_ext_3} }
		716	) {
917	if ($_ eq "default") {	717	if ($_ eq "default") {
		718
		719	$ext_arg{$_} = []
918	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	720	for qw(selection option-popup selection-popup readline searchable-scrollback);
		721
		722	for ($TERM->_keysym_resources) {
		723	next if /^(?:string|command|builtin|builtin-string|perl)/;
		724	next unless /^([A-Za-z0-9_\-]+):/;
		725
		726	my $ext = $1;
		727
		728	$ext_arg{$ext} = [];
		729	}
		730
919	} elsif (/^-(.*)$/) {	731	} elsif (/^-(.*)$/) {
920	delete $ext_arg{$1};	732	delete $ext_arg{$1};
		733
921	} elsif (/^([^<]+)<(.*)>$/) {	734	} elsif (/^([^<]+)<(.*)>$/) {
922	push @{ $ext_arg{$1} }, $2;	735	push @{ $ext_arg{$1} }, $2;
		736
923	} else {	737	} else {
924	$ext_arg{$_} ||= [];	738	$ext_arg{$_} ||= [];
925	}	739	}
926	}	740	}
927		741
…		…
943		757
944	if (my $cb = $TERM->{_hook}[$htype]) {	758	if (my $cb = $TERM->{_hook}[$htype]) {
945	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	759	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
946	if $verbosity >= 10;	760	if $verbosity >= 10;
947		761
		762	if ($htype == HOOK_ACTION) {
		763	# this hook is only sent to the extension with the name
		764	# matching the first arg
		765	my $pkg = shift;
		766	$pkg =~ y/-/_/;
		767	$pkg = "urxvt::ext::$pkg";
		768
		769	$cb = $cb->{$pkg}
		770	or return undef; #TODO: maybe warn user?
		771
		772	$cb = { $pkg => $cb };
		773	}
		774
948	for my $pkg (keys %$cb) {	775	for my $pkg (keys %$cb) {
949	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	776	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
950	$retval ||= $retval_;	777	$retval ||= $retval_;
951		778
952	if ($@) {	779	if ($@) {
953	$TERM->ungrab; # better to lose the grab than the session	780	$TERM->ungrab; # better to lose the grab than the session
954	warn $@;	781	warn $@;
…		…
957		784
958	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	785	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
959	if $verbosity >= 11;	786	if $verbosity >= 11;
960	}	787	}
961		788
962	if ($htype == 1) { # DESTROY	789	if ($htype == HOOK_DESTROY) {
963	# clear package objects	790	# clear package objects
964	%$_ = () for values %{ $TERM->{_pkg} };	791	%$_ = () for values %{ $TERM->{_pkg} };
965		792
966	# clear package	793	# clear package
967	%$TERM = ();	794	%$TERM = ();
…		…
972		799
973	sub SET_COLOR($$$) {	800	sub SET_COLOR($$$) {
974	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	801	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
975	}	802	}
976		803
977	# urxvt::term::extension	804	sub rend2mask {
		805	no strict 'refs';
		806	my ($str, $mask) = (@_, 0);
		807	my %color = ( fg => undef, bg => undef );
		808	my @failed;
		809	for my $spec ( split /\s+/, $str ) {
		810	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		811	$color{lc($1)} = $2;
		812	} else {
		813	my $neg = $spec =~ s/^[-^]//;
		814	unless ( exists &{"RS_$spec"} ) {
		815	push @failed, $spec;
		816	next;
		817	}
		818	my $cur = &{"RS_$spec"};
		819	if ( $neg ) {
		820	$mask &= ~$cur;
		821	} else {
		822	$mask |= $cur;
		823	}
		824	}
		825	}
		826	($mask, @color{qw(fg bg)}, \@failed)
		827	}
978		828
979	package urxvt::term::extension;	829	package urxvt::term::extension;
980		830
981	sub enable {	831	=head2 The C<urxvt::term::extension> class
982	my ($self, %hook) = @_;
983	my $pkg = $self->{_pkg};
984		832
985	while (my ($name, $cb) = each %hook) {	833	Each extension attached to a terminal object is represented by
986	my $htype = $HOOKTYPE{uc $name};	834	a C<urxvt::term::extension> object.
987	defined $htype
988	or Carp::croak "unsupported hook type '$name'";
989		835
990	$self->set_should_invoke ($htype, +1)	836	You can use these objects, which are passed to all callbacks to store any
991	unless exists $self->{term}{_hook}[$htype]{$pkg};	837	state related to the terminal and extension instance.
992		838
993	$self->{term}{_hook}[$htype]{$pkg} = $cb;	839	The methods (And data members) documented below can be called on extension
994	}	840	objects, in addition to call methods documented for the <urxvt::term>
995	}	841	class.
996		842
997	sub disable {	843	=over 4
998	my ($self, @hook) = @_;
999	my $pkg = $self->{_pkg};
1000		844
1001	for my $name (@hook) {	845	=item $urxvt_term = $self->{term}
1002	my $htype = $HOOKTYPE{uc $name};
1003	defined $htype
1004	or Carp::croak "unsupported hook type '$name'";
1005		846
1006	$self->set_should_invoke ($htype, -1)	847	Returns the C<urxvt::term> object associated with this instance of the
1007	if delete $self->{term}{_hook}[$htype]{$pkg};	848	extension. This member I<must not> be changed in any way.
1008	}	849
1009	}	850	=cut
1010		851
1011	our $AUTOLOAD;	852	our $AUTOLOAD;
1012		853
1013	sub AUTOLOAD {	854	sub AUTOLOAD {
1014	$AUTOLOAD =~ /:([^:]+)$/	855	$AUTOLOAD =~ /:([^:]+)$/
…		…
1027		868
1028	sub DESTROY {	869	sub DESTROY {
1029	# nop	870	# nop
1030	}	871	}
1031		872
1032	# urxvt::destroy_hook	873	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1033		874
1034	sub urxvt::destroy_hook::DESTROY {	875	sub urxvt::destroy_hook::DESTROY {
1035	${$_[0]}->();	876	${$_[0]}->();
1036	}	877	}
1037		878
1038	sub urxvt::destroy_hook(&) {	879	sub urxvt::destroy_hook(&) {
1039	bless \shift, urxvt::destroy_hook::	880	bless \shift, urxvt::destroy_hook::
1040	}	881	}
		882
		883	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		884
		885	Dynamically enable the given hooks (named without the C<on_> prefix) for
		886	this extension, replacing any hook previously installed via C<enable> in
		887	this extension.
		888
		889	This is useful when you want to overwrite time-critical hooks only
		890	temporarily.
		891
		892	To install additional callbacks for the same hook, you can use the C<on>
		893	method of the C<urxvt::term> class.
		894
		895	=item $self->disable ($hook_name[, $hook_name..])
		896
		897	Dynamically disable the given hooks.
		898
		899	=cut
		900
		901	sub enable {
		902	my ($self, %hook) = @_;
		903	my $pkg = $self->{_pkg};
		904
		905	while (my ($name, $cb) = each %hook) {
		906	my $htype = $HOOKTYPE{uc $name};
		907	defined $htype
		908	or Carp::croak "unsupported hook type '$name'";
		909
		910	$self->set_should_invoke ($htype, +1)
		911	unless exists $self->{term}{_hook}[$htype]{$pkg};
		912
		913	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		914	}
		915	}
		916
		917	sub disable {
		918	my ($self, @hook) = @_;
		919	my $pkg = $self->{_pkg};
		920
		921	for my $name (@hook) {
		922	my $htype = $HOOKTYPE{uc $name};
		923	defined $htype
		924	or Carp::croak "unsupported hook type '$name'";
		925
		926	$self->set_should_invoke ($htype, -1)
		927	if delete $self->{term}{_hook}[$htype]{$pkg};
		928	}
		929	}
		930
		931	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		932
		933	Similar to the C<enable> enable, but installs additional callbacks for
		934	the given hook(s) (that is, it doesn't replace existing callbacks), and
		935	returns a guard object. When the guard object is destroyed the callbacks
		936	are disabled again.
		937
		938	=cut
		939
		940	sub urxvt::extension::on_disable::DESTROY {
		941	my $disable = shift;
		942
		943	my $term = delete $disable->{""};
		944
		945	while (my ($htype, $id) = each %$disable) {
		946	delete $term->{_hook}[$htype]{$id};
		947	$term->set_should_invoke ($htype, -1);
		948	}
		949	}
		950
		951	sub on {
		952	my ($self, %hook) = @_;
		953
		954	my $term = $self->{term};
		955
		956	my %disable = ( "" => $term );
		957
		958	while (my ($name, $cb) = each %hook) {
		959	my $htype = $HOOKTYPE{uc $name};
		960	defined $htype
		961	or Carp::croak "unsupported hook type '$name'";
		962
		963	$term->set_should_invoke ($htype, +1);
		964	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		965	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		966	}
		967
		968	bless \%disable, "urxvt::extension::on_disable"
		969	}
		970
		971	=item $self->bind_action ($hotkey, $action)
		972
		973	=item $self->x_resource ($pattern)
		974
		975	=item $self->x_resource_boolean ($pattern)
		976
		977	These methods support an additional C<%> prefix for C<$action> or
		978	C<$pattern> when called on an extension object, compared to the
		979	C<urxvt::term> methods of the same name - see the description of these
		980	methods in the C<urxvt::term> class for details.
		981
		982	=cut
		983
		984	sub bind_action {
		985	my ($self, $hotkey, $action) = @_;
		986	$action =~ s/^%:/$_[0]{_name}:/;
		987	$self->{term}->bind_action ($hotkey, $action)
		988	}
		989
		990	sub x_resource {
		991	my ($self, $name) = @_;
		992	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		993	$self->{term}->x_resource ($name)
		994	}
		995
		996	sub x_resource_boolean {
		997	my ($self, $name) = @_;
		998	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		999	$self->{term}->x_resource_boolean ($name)
		1000	}
		1001
		1002	=back
		1003
		1004	=cut
1041		1005
1042	package urxvt::anyevent;	1006	package urxvt::anyevent;
1043		1007
1044	=head2 The C<urxvt::anyevent> Class	1008	=head2 The C<urxvt::anyevent> Class
1045		1009
1046	The sole purpose of this class is to deliver an interface to the	1010	The sole purpose of this class is to deliver an interface to the
1047	C<AnyEvent> module - any module using it will work inside urxvt without	1011	C<AnyEvent> module - any module using it will work inside urxvt without
1048	further programming. The only exception is that you cannot wait on	1012	further programming. The only exception is that you cannot wait on
1049	condition variables, but non-blocking condvar use is ok. What this means	1013	condition variables, but non-blocking condvar use is ok.
1050	is that you cannot use blocking APIs, but the non-blocking variant should
1051	work.
1052		1014
1053	=cut	1015	In practical terms this means is that you cannot use blocking APIs, but
		1016	the non-blocking variant should work.
1054		1017
		1018	=cut
		1019
1055	our $VERSION = 1;	1020	our $VERSION = '5.23';
1056		1021
1057	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1022	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1058	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1023	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1059		1024
1060	sub timer {	1025	sub timer {
…		…
1062		1027
1063	my $cb = $arg{cb};	1028	my $cb = $arg{cb};
1064		1029
1065	urxvt::timer	1030	urxvt::timer
1066	->new	1031	->new
1067	->start (urxvt::NOW + $arg{after})	1032	->after ($arg{after}, $arg{interval})
1068	->cb (sub {	1033	->cb ($arg{interval} ? $cb : sub {
1069	$_[0]->stop; # need to cancel manually	1034	$_[0]->stop; # need to cancel manually
1070	$cb->();	1035	$cb->();
1071	})	1036	})
1072	}	1037	}
1073		1038
1074	sub io {	1039	sub io {
1075	my ($class, %arg) = @_;	1040	my ($class, %arg) = @_;
1076		1041
1077	my $cb = $arg{cb};	1042	my $cb = $arg{cb};
		1043	my $fd = fileno $arg{fh};
		1044	defined $fd or $fd = $arg{fh};
1078		1045
1079	bless [$arg{fh}, urxvt::iow	1046	bless [$arg{fh}, urxvt::iow
1080	->new	1047	->new
1081	->fd (fileno $arg{fh})	1048	->fd ($fd)
1082	->events (($arg{poll} =~ /r/ ? 1 : 0)	1049	->events (($arg{poll} =~ /r/ ? 1 : 0)
1083	| ($arg{poll} =~ /w/ ? 2 : 0))	1050	| ($arg{poll} =~ /w/ ? 2 : 0))
1084	->start	1051	->start
1085	->cb (sub {	1052	->cb ($cb)
1086	$cb->(($_[1] & 1 ? 'r' : '')
1087	. ($_[1] & 2 ? 'w' : ''));
1088	})],
1089	urxvt::anyevent::	1053	], urxvt::anyevent::
		1054	}
		1055
		1056	sub idle {
		1057	my ($class, %arg) = @_;
		1058
		1059	my $cb = $arg{cb};
		1060
		1061	urxvt::iw
		1062	->new
		1063	->start
		1064	->cb ($cb)
		1065	}
		1066
		1067	sub child {
		1068	my ($class, %arg) = @_;
		1069
		1070	my $cb = $arg{cb};
		1071
		1072	urxvt::pw
		1073	->new
		1074	->start ($arg{pid})
		1075	->cb (sub {
		1076	$_[0]->stop; # need to cancel manually
		1077	$cb->($_[0]->rpid, $_[0]->rstatus);
		1078	})
1090	}	1079	}
1091		1080
1092	sub DESTROY {	1081	sub DESTROY {
1093	$_[0][1]->stop;	1082	$_[0][1]->stop;
1094	}	1083	}
1095		1084
1096	sub condvar {	1085	# only needed for AnyEvent < 6 compatibility
1097	bless \my $flag, urxvt::anyevent::condvar::	1086	sub one_event {
1098	}
1099
1100	sub urxvt::anyevent::condvar::broadcast {
1101	${$_[0]}++;
1102	}
1103
1104	sub urxvt::anyevent::condvar::wait {
1105	unless (${$_[0]}) {
1106	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1087	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1107	}
1108	}	1088	}
1109		1089
1110	package urxvt::term;	1090	package urxvt::term;
1111		1091
1112	=head2 The C<urxvt::term> Class	1092	=head2 The C<urxvt::term> Class
…		…
1125	urxvt::verbose 6, "register package $pkg to $self";	1105	urxvt::verbose 6, "register package $pkg to $self";
1126		1106
1127	@{"$pkg\::ISA"} = urxvt::term::extension::;	1107	@{"$pkg\::ISA"} = urxvt::term::extension::;
1128		1108
1129	my $proxy = bless {	1109	my $proxy = bless {
1130	_pkg => $pkg,	1110	_pkg => $pkg,
		1111	_name => ${"$pkg\::_NAME"}, # hackish
1131	argv => $argv,	1112	argv => $argv,
1132	}, $pkg;	1113	}, $pkg;
1133	Scalar::Util::weaken ($proxy->{term} = $self);	1114	Scalar::Util::weaken ($proxy->{term} = $self);
1134		1115
1135	$self->{_pkg}{$pkg} = $proxy;	1116	$self->{_pkg}{$pkg} = $proxy;
1136		1117
…		…
1139	$proxy->enable ($name => $ref);	1120	$proxy->enable ($name => $ref);
1140	}	1121	}
1141	}	1122	}
1142	}	1123	}
1143		1124
		1125	sub perl_libdirs {
		1126	map { split /:/ }
		1127	$_[0]->resource ("perl_lib"),
		1128	$ENV{URXVT_PERL_LIB},
		1129	"$ENV{HOME}/.urxvt/ext",
		1130	"$LIBDIR/perl"
		1131	}
		1132
		1133	# scan for available extensions and collect their metadata
		1134	sub scan_extensions {
		1135	my ($self) = @_;
		1136
		1137	return if exists $self->{meta};
		1138
		1139	my @urxvtdirs = perl_libdirs $self;
		1140	my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1141
		1142	$self->{meta} = \my %meta;
		1143
		1144	# first gather extensions
		1145
		1146	my $gather = sub {
		1147	my ($dir, $core) = @_;
		1148
		1149	opendir my $fh, $dir
		1150	or return;
		1151
		1152	for my $ext (readdir $fh) {
		1153	$ext !~ /^\./
		1154	or next;
		1155
		1156	open my $fh, "<", "$dir/$ext"
		1157	or next;
		1158
		1159	-f $fh
		1160	or next;
		1161
		1162	$ext =~ s/\.uext$// or $core
		1163	or next;
		1164
		1165	my %ext = (dir => $dir);
		1166
		1167	while (<$fh>) {
		1168	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1169	my ($pattern, $type, $desc) = split /:/, $1;
		1170	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1171	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1172	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1173	} else {
		1174	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1175	}
		1176	} elsif (/^\s*(?:#|$)/) {
		1177	# skip other comments and empty lines
		1178	} else {
		1179	last; # stop parsing on first non-empty non-comment line
		1180	}
		1181	}
		1182
		1183	$meta{ext}{$ext} = \%ext;
		1184	}
		1185	};
		1186
		1187	$gather->($_, 0) for @cpandirs;
		1188	$gather->($_, 1) for @urxvtdirs;
		1189
		1190	# and now merge resources
		1191	while (my ($k, $v) = each %{ $meta{ext} }) {
		1192	#TODO: should check for extensions overriding each other
		1193	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1194	}
		1195	}
		1196
1144	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1197	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1145		1198
1146	Creates a new terminal, very similar as if you had started it with system	1199	Creates a new terminal, very similar as if you had started it with system
1147	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1200	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1148	hash which defines the environment of the new terminal.	1201	hash which defines the environment of the new terminal.
…		…
1165	}	1218	}
1166		1219
1167	=item $term->destroy	1220	=item $term->destroy
1168		1221
1169	Destroy the terminal object (close the window, free resources	1222	Destroy the terminal object (close the window, free resources
1170	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1223	etc.). Please note that urxvt will not exit as long as any event
1171	watchers (timers, io watchers) are still active.	1224	watchers (timers, io watchers) are still active.
1172		1225
1173	=item $term->exec_async ($cmd[, @args])	1226	=item $term->exec_async ($cmd[, @args])
1174		1227
1175	Works like the combination of the C<fork>/C<exec> builtins, which executes	1228	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1202	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1255	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1203		1256
1204	Here is a likely non-exhaustive list of option names, please see the	1257	Here is a likely non-exhaustive list of option names, please see the
1205	source file F</src/optinc.h> to see the actual list:	1258	source file F</src/optinc.h> to see the actual list:
1206		1259
1207	borderLess console cursorBlink cursorUnderline hold iconic insecure	1260	borderLess buffered console cursorBlink cursorUnderline hold iconic
1208	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1261	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1209	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1262	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1210	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1263	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1211	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1264	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1212	transparent tripleclickwords utmpInhibit visualBell	1265	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1266	urgentOnBell utmpInhibit visualBell
1213		1267
1214	=item $value = $term->resource ($name[, $newval])	1268	=item $value = $term->resource ($name[, $newval])
1215		1269
1216	Returns the current resource value associated with a given name and	1270	Returns the current resource value associated with a given name and
1217	optionally sets a new value. Setting values is most useful in the C<init>	1271	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1230		1284
1231	Here is a likely non-exhaustive list of resource names, not all of which	1285	Here is a likely non-exhaustive list of resource names, not all of which
1232	are supported in every build, please see the source file F</src/rsinc.h>	1286	are supported in every build, please see the source file F</src/rsinc.h>
1233	to see the actual list:	1287	to see the actual list:
1234		1288
1235	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1289	answerbackstring backgroundPixmap backspace_key blurradius
1236	borderLess color cursorBlink cursorUnderline cutchars delete_key	1290	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1237	display_name embed ext_bwidth fade font geometry hold iconName	1291	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1238	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1292	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1293	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1239	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1294	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1240	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1295	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1241	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1296	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1242	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1297	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1243	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1298	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1244	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1299	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1245	secondaryScreen secondaryScroll selectstyle shade term_name title	1300	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1246	transient_for transparent transparent_all tripleclickwords utmpInhibit	1301	term_name title transient_for transparent tripleclickwords urgentOnBell
1247	visualBell	1302	utmpInhibit visualBell
1248		1303
1249	=cut	1304	=cut
1250		1305
1251	sub resource($$;$) {	1306	sub resource($$;$) {
1252	my ($self, $name) = (shift, shift);	1307	my ($self, $name) = (shift, shift);
1253	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1308	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1254	&urxvt::term::_resource	1309	goto &urxvt::term::_resource
1255	}	1310	}
1256		1311
1257	=item $value = $term->x_resource ($pattern)	1312	=item $value = $term->x_resource ($pattern)
1258		1313
1259	Returns the X-Resource for the given pattern, excluding the program or	1314	Returns the X-Resource for the given pattern, excluding the program or
1260	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1315	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1261	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1316	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1262	resource with that pattern exists.	1317	resource with that pattern exists.
1263		1318
		1319	Extensions that define extra resources also need to call this method
		1320	to access their values.
		1321
		1322	If the method is called on an extension object (basically, from an
		1323	extension), then the special prefix C<%.> will be replaced by the name of
		1324	the extension and a dot, and the lone string C<%> will be replaced by the
		1325	extension name itself. This makes it possible to code extensions so you
		1326	can rename them and get a new set of resources without having to change
		1327	the actual code.
		1328
1264	This method should only be called during the C<on_start> hook, as there is	1329	This method should only be called during the C<on_start> hook, as there is
1265	only one resource database per display, and later invocations might return	1330	only one resource database per display, and later invocations might return
1266	the wrong resources.	1331	the wrong resources.
1267		1332
1268	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1333	=item $value = $term->x_resource_boolean ($pattern)
1269		1334
		1335	Like C<x_resource>, above, but interprets the string value as a boolean
		1336	and returns C<1> for true values, C<0> for false values and C<undef> if
		1337	the resource or option isn't specified.
		1338
		1339	You should always use this method to parse boolean resources.
		1340
		1341	=cut
		1342
		1343	sub x_resource_boolean {
		1344	my $res = &x_resource;
		1345
		1346	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1347	}
		1348
		1349	=item $success = $term->bind_action ($key, $action)
		1350
1270	Adds a keymap translation exactly as specified via a resource. See the	1351	Adds a key binding exactly as specified via a C<keysym> resource. See the
1271	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1352	C<keysym> resource in the urxvt(1) manpage.
		1353
		1354	To add default bindings for an extension, the extension should call C<<
		1355	->bind_action >> on it's C<init> hook for every such binding. Doing it
		1356	in the C<init> hook allows users the override or remove the the binding
		1357	again.
		1358
		1359	Example: the C<searchable-scrollback> by default binds itself
		1360	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1361	$term->bind_action >>.
		1362
		1363	sub init {
		1364	my ($self) = @_;
		1365
		1366	$self->bind_action ("M-s" => "%:start");
		1367	}
1272		1368
1273	=item $rend = $term->rstyle ([$new_rstyle])	1369	=item $rend = $term->rstyle ([$new_rstyle])
1274		1370
1275	Return and optionally change the current rendition. Text that is output by	1371	Return and optionally change the current rendition. Text that is output by
1276	the terminal application will use this style.	1372	the terminal application will use this style.
…		…
1284		1380
1285	=item ($row, $col) = $term->selection_beg ([$row, $col])	1381	=item ($row, $col) = $term->selection_beg ([$row, $col])
1286		1382
1287	=item ($row, $col) = $term->selection_end ([$row, $col])	1383	=item ($row, $col) = $term->selection_end ([$row, $col])
1288		1384
1289	Return the current values of the selection mark, begin or end positions,	1385	Return the current values of the selection mark, begin or end positions.
1290	and optionally set them to new values.	1386
		1387	When arguments are given, then the selection coordinates are set to
		1388	C<$row> and C<$col>, and the selection screen is set to the current
		1389	screen.
		1390
		1391	=item $screen = $term->selection_screen ([$screen])
		1392
		1393	Returns the current selection screen, and then optionally sets it.
1291		1394
1292	=item $term->selection_make ($eventtime[, $rectangular])	1395	=item $term->selection_make ($eventtime[, $rectangular])
1293		1396
1294	Tries to make a selection as set by C<selection_beg> and	1397	Tries to make a selection as set by C<selection_beg> and
1295	C<selection_end>. If C<$rectangular> is true (default: false), a	1398	C<selection_end>. If C<$rectangular> is true (default: false), a
1296	rectangular selection will be made. This is the prefered function to make	1399	rectangular selection will be made. This is the preferred function to make
1297	a selection.	1400	a selection.
1298		1401
1299	=item $success = $term->selection_grab ($eventtime)	1402	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1300		1403
1301	Try to request the primary selection text from the server (for example, as	1404	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1405	true) selection from the server. The corresponding text can be set
1302	set by the next method). No visual feedback will be given. This function	1406	with the next method. No visual feedback will be given. This function
1303	is mostly useful from within C<on_sel_grab> hooks.	1407	is mostly useful from within C<on_sel_grab> hooks.
1304		1408
1305	=item $oldtext = $term->selection ([$newtext])	1409	=item $oldtext = $term->selection ([$newtext, $clipboard])
1306		1410
1307	Return the current selection text and optionally replace it by C<$newtext>.	1411	Return the current selection (clipboard if C<$clipboard> is true) text
		1412	and optionally replace it by C<$newtext>.
		1413
		1414	=item $term->selection_clear ([$clipboard])
		1415
		1416	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1308		1417
1309	=item $term->overlay_simple ($x, $y, $text)	1418	=item $term->overlay_simple ($x, $y, $text)
1310		1419
1311	Create a simple multi-line overlay box. See the next method for details.	1420	Create a simple multi-line overlay box. See the next method for details.
1312		1421
…		…
1342		1451
1343	The methods currently supported on C<urxvt::overlay> objects are:	1452	The methods currently supported on C<urxvt::overlay> objects are:
1344		1453
1345	=over 4	1454	=over 4
1346		1455
1347	=item $overlay->set ($x, $y, $text, $rend)	1456	=item $overlay->set ($x, $y, $text[, $rend])
1348		1457
1349	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1458	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1350	text in rxvt-unicode's special encoding and an array of rendition values	1459	text in rxvt-unicode's special encoding and an array of rendition values
1351	at a specific position inside the overlay.	1460	at a specific position inside the overlay.
		1461
		1462	If C<$rend> is missing, then the rendition will not be changed.
1352		1463
1353	=item $overlay->hide	1464	=item $overlay->hide
1354		1465
1355	If visible, hide the overlay, but do not destroy it.	1466	If visible, hide the overlay, but do not destroy it.
1356		1467
…		…
1419		1530
1420	=item $term->scr_add_lines ($string)	1531	=item $term->scr_add_lines ($string)
1421		1532
1422	Write the given text string to the screen, as if output by the application	1533	Write the given text string to the screen, as if output by the application
1423	running inside the terminal. It may not contain command sequences (escape	1534	running inside the terminal. It may not contain command sequences (escape
1424	codes), but is free to use line feeds, carriage returns and tabs. The	1535	codes - see C<cmd_parse> for that), but is free to use line feeds,
1425	string is a normal text string, not in locale-dependent encoding.	1536	carriage returns and tabs. The string is a normal text string, not in
		1537	locale-dependent encoding.
1426		1538
1427	Normally its not a good idea to use this function, as programs might be	1539	Normally its not a good idea to use this function, as programs might be
1428	confused by changes in cursor position or scrolling. Its useful inside a	1540	confused by changes in cursor position or scrolling. Its useful inside a
1429	C<on_add_lines> hook, though.	1541	C<on_add_lines> hook, though.
1430		1542
…		…
1438	locale-specific encoding of the terminal and can contain command sequences	1550	locale-specific encoding of the terminal and can contain command sequences
1439	(escape codes) that will be interpreted.	1551	(escape codes) that will be interpreted.
1440		1552
1441	=item $term->tt_write ($octets)	1553	=item $term->tt_write ($octets)
1442		1554
1443	Write the octets given in C<$data> to the tty (i.e. as program input). To	1555	Write the octets given in C<$octets> to the tty (i.e. as user input
		1556	to the program, see C<cmd_parse> for the opposite direction). To pass
1444	pass characters instead of octets, you should convert your strings first	1557	characters instead of octets, you should convert your strings first to the
1445	to the locale-specific encoding using C<< $term->locale_encode >>.	1558	locale-specific encoding using C<< $term->locale_encode >>.
		1559
		1560	=item $term->tt_write_user_input ($octets)
		1561
		1562	Like C<tt_write>, but should be used when writing strings in response to
		1563	the user pressing a key, to invoke the additional actions requested by
		1564	the user for that case (C<tt_write> doesn't do that).
		1565
		1566	The typical use case would be inside C<on_action> hooks.
		1567
		1568	=item $term->tt_paste ($octets)
		1569
		1570	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1571	CR and bracketing the data with control sequences if bracketed paste mode
		1572	is set.
1446		1573
1447	=item $old_events = $term->pty_ev_events ([$new_events])	1574	=item $old_events = $term->pty_ev_events ([$new_events])
1448		1575
1449	Replaces the event mask of the pty watcher by the given event mask. Can	1576	Replaces the event mask of the pty watcher by the given event mask. Can
1450	be used to suppress input and output handling to the pty/tty. See the	1577	be used to suppress input and output handling to the pty/tty. See the
…		…
1469	Adds the specified events to the vt event mask. Useful e.g. when you want	1596	Adds the specified events to the vt event mask. Useful e.g. when you want
1470	to receive pointer events all the times:	1597	to receive pointer events all the times:
1471		1598
1472	$term->vt_emask_add (urxvt::PointerMotionMask);	1599	$term->vt_emask_add (urxvt::PointerMotionMask);
1473		1600
		1601	=item $term->set_urgency ($set)
		1602
		1603	Enable/disable the urgency hint on the toplevel window.
		1604
1474	=item $term->focus_in	1605	=item $term->focus_in
1475		1606
1476	=item $term->focus_out	1607	=item $term->focus_out
1477		1608
1478	=item $term->key_press ($state, $keycode[, $time])	1609	=item $term->key_press ($state, $keycode[, $time])
…		…
1566		1697
1567	Used after changing terminal contents to display them.	1698	Used after changing terminal contents to display them.
1568		1699
1569	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1700	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1570		1701
1571	Returns the text of the entire row with number C<$row_number>. Row C<0>	1702	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1572	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1703	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1573	terminal line. The scrollback buffer starts at line C<-1> and extends to
1574	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1704	terminal line. Nothing will be returned if a nonexistent line
1575	is requested.	1705	is requested.
1576		1706
1577	If C<$new_text> is specified, it will replace characters in the current	1707	If C<$new_text> is specified, it will replace characters in the current
1578	line, starting at column C<$start_col> (default C<0>), which is useful	1708	line, starting at column C<$start_col> (default C<0>), which is useful
1579	to replace only parts of a line. The font index in the rendition will	1709	to replace only parts of a line. The font index in the rendition will
1580	automatically be updated.	1710	automatically be updated.
1581		1711
1582	C<$text> is in a special encoding: tabs and wide characters that use more	1712	C<$text> is in a special encoding: tabs and wide characters that use more
1583	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1713	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1584	characters. Characters with combining characters and other characters that	1714	characters. Characters with combining characters and other characters that
1585	do not fit into the normal tetx encoding will be replaced with characters	1715	do not fit into the normal text encoding will be replaced with characters
1586	in the private use area.	1716	in the private use area.
1587		1717
1588	You have to obey this encoding when changing text. The advantage is	1718	You have to obey this encoding when changing text. The advantage is
1589	that C<substr> and similar functions work on screen cells and not on	1719	that C<substr> and similar functions work on screen cells and not on
1590	characters.	1720	characters.
…		…
1675	}	1805	}
1676		1806
1677	sub urxvt::line::t {	1807	sub urxvt::line::t {
1678	my ($self) = @_;	1808	my ($self) = @_;
1679		1809
1680	if (@_ > 1)	1810	if (@_ > 1) {
1681	{
1682	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1811	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1683	for $self->{beg} .. $self->{end};	1812	for $self->{beg} .. $self->{end};
1684	}	1813	}
1685		1814
1686	defined wantarray &&	1815	defined wantarray &&
1687	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1816	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1688	0, $self->{len}	1817	0, $self->{len}
1689	}	1818	}
1690		1819
1691	sub urxvt::line::r {	1820	sub urxvt::line::r {
1692	my ($self) = @_;	1821	my ($self) = @_;
1693		1822
1694	if (@_ > 1)	1823	if (@_ > 1) {
1695	{
1696	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1824	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1697	for $self->{beg} .. $self->{end};	1825	for $self->{beg} .. $self->{end};
1698	}	1826	}
1699		1827
1700	if (defined wantarray) {	1828	if (defined wantarray) {
1701	my $rend = [	1829	my $rend = [
1702	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1830	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1703	];	1831	];
…		…
1765	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1893	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1766	recent grab.	1894	recent grab.
1767		1895
1768	=item $term->ungrab	1896	=item $term->ungrab
1769		1897
1770	Calls XUngrab for the most recent grab. Is called automatically on	1898	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1771	evaluation errors, as it is better to lose the grab in the error case as	1899	evaluation errors, as it is better to lose the grab in the error case as
1772	the session.	1900	the session.
1773		1901
1774	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1902	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1775		1903
…		…
1777		1905
1778	=item @atoms = $term->XListProperties ($window)	1906	=item @atoms = $term->XListProperties ($window)
1779		1907
1780	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1908	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1781		1909
1782	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1910	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1783		1911
1784	=item $term->XDeleteProperty ($window, $property)	1912	=item $term->XDeleteProperty ($window, $property)
1785		1913
1786	=item $window = $term->DefaultRootWindow	1914	=item $window = $term->DefaultRootWindow
1787		1915
…		…
1794	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1922	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1795		1923
1796	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1924	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1797		1925
1798	=item $term->XChangeInput ($window, $add_events[, $del_events])	1926	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1927
		1928	=item $keysym = $term->XStringToKeysym ($string)
		1929
		1930	=item $string = $term->XKeysymToString ($keysym)
1799		1931
1800	Various X or X-related functions. The C<$term> object only serves as	1932	Various X or X-related functions. The C<$term> object only serves as
1801	the source of the display, otherwise those functions map more-or-less	1933	the source of the display, otherwise those functions map more-or-less
1802	directory onto the X functions of the same name.	1934	directly onto the X functions of the same name.
1803		1935
1804	=back	1936	=back
1805		1937
1806	=cut	1938	=cut
1807		1939
…		…
1909	my $env = $self->{term}->env;	2041	my $env = $self->{term}->env;
1910	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2042	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1911	delete $env->{LC_ALL};	2043	delete $env->{LC_ALL};
1912	$env->{LC_CTYPE} = $self->{term}->locale;	2044	$env->{LC_CTYPE} = $self->{term}->locale;
1913		2045
1914	urxvt::term->new ($env, "popup",	2046	my $term = urxvt::term->new (
		2047	$env, "popup",
1915	"--perl-lib" => "", "--perl-ext-common" => "",	2048	"--perl-lib" => "", "--perl-ext-common" => "",
1916	"-pty-fd" => -1, "-sl" => 0,	2049	"-pty-fd" => -1, "-sl" => 0,
1917	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2050	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1918	"--transient-for" => $self->{term}->parent,	2051	"--transient-for" => $self->{term}->parent,
1919	"-display" => $self->{term}->display_id,	2052	"-display" => $self->{term}->display_id,
1920	"-pe" => "urxvt-popup")	2053	"-pe" => "urxvt-popup",
1921	or die "unable to create popup window\n";	2054	) or die "unable to create popup window\n";
		2055
		2056	unless (delete $term->{urxvt_popup_init_done}) {
		2057	$term->ungrab;
		2058	$term->destroy;
		2059	die "unable to initialise popup window\n";
		2060	}
1922	}	2061	}
1923		2062
1924	sub DESTROY {	2063	sub DESTROY {
1925	my ($self) = @_;	2064	my ($self) = @_;
1926		2065
…		…
1931	=back	2070	=back
1932		2071
1933	=cut	2072	=cut
1934		2073
1935	package urxvt::watcher;	2074	package urxvt::watcher;
1936
1937	@urxvt::timer::ISA = __PACKAGE__;
1938	@urxvt::iow::ISA = __PACKAGE__;
1939	@urxvt::pw::ISA = __PACKAGE__;
1940	@urxvt::iw::ISA = __PACKAGE__;
1941		2075
1942	=head2 The C<urxvt::timer> Class	2076	=head2 The C<urxvt::timer> Class
1943		2077
1944	This class implements timer watchers/events. Time is represented as a	2078	This class implements timer watchers/events. Time is represented as a
1945	fractional number of seconds since the epoch. Example:	2079	fractional number of seconds since the epoch. Example:
…		…
1949	->new	2083	->new
1950	->interval (1)	2084	->interval (1)
1951	->cb (sub {	2085	->cb (sub {
1952	$term->{overlay}->set (0, 0,	2086	$term->{overlay}->set (0, 0,
1953	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2087	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1954	});	2088	});
1955		2089
1956	=over 4	2090	=over 4
1957		2091
1958	=item $timer = new urxvt::timer	2092	=item $timer = new urxvt::timer
1959		2093
…		…
1962		2096
1963	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2097	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1964		2098
1965	Set the callback to be called when the timer triggers.	2099	Set the callback to be called when the timer triggers.
1966		2100
1967	=item $tstamp = $timer->at
1968
1969	Return the time this watcher will fire next.
1970
1971	=item $timer = $timer->set ($tstamp)	2101	=item $timer = $timer->set ($tstamp[, $interval])
1972		2102
1973	Set the time the event is generated to $tstamp.	2103	Set the time the event is generated to $tstamp (and optionally specifies a
		2104	new $interval).
1974		2105
1975	=item $timer = $timer->interval ($interval)	2106	=item $timer = $timer->interval ($interval)
1976		2107
1977	Normally (and when C<$interval> is C<0>), the timer will automatically	2108	By default (and when C<$interval> is C<0>), the timer will automatically
1978	stop after it has fired once. If C<$interval> is non-zero, then the timer	2109	stop after it has fired once. If C<$interval> is non-zero, then the timer
1979	is automatically rescheduled at the given intervals.	2110	is automatically rescheduled at the given intervals.
1980		2111
1981	=item $timer = $timer->start	2112	=item $timer = $timer->start
1982		2113
1983	Start the timer.	2114	Start the timer.
1984		2115
1985	=item $timer = $timer->start ($tstamp)	2116	=item $timer = $timer->start ($tstamp[, $interval])
1986		2117
1987	Set the event trigger time to C<$tstamp> and start the timer.	2118	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2119	also replaces the interval.
1988		2120
1989	=item $timer = $timer->after ($delay)	2121	=item $timer = $timer->after ($delay[, $interval])
1990		2122
1991	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2123	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1992		2124
1993	=item $timer = $timer->stop	2125	=item $timer = $timer->stop
1994		2126
…		…
2002		2134
2003	$term->{socket} = ...	2135	$term->{socket} = ...
2004	$term->{iow} = urxvt::iow	2136	$term->{iow} = urxvt::iow
2005	->new	2137	->new
2006	->fd (fileno $term->{socket})	2138	->fd (fileno $term->{socket})
2007	->events (urxvt::EVENT_READ)	2139	->events (urxvt::EV_READ)
2008	->start	2140	->start
2009	->cb (sub {	2141	->cb (sub {
2010	my ($iow, $revents) = @_;	2142	my ($iow, $revents) = @_;
2011	# $revents must be 1 here, no need to check	2143	# $revents must be 1 here, no need to check
2012	sysread $term->{socket}, my $buf, 8192	2144	sysread $term->{socket}, my $buf, 8192
…		…
2030	Set the file descriptor (not handle) to watch.	2162	Set the file descriptor (not handle) to watch.
2031		2163
2032	=item $iow = $iow->events ($eventmask)	2164	=item $iow = $iow->events ($eventmask)
2033		2165
2034	Set the event mask to watch. The only allowed values are	2166	Set the event mask to watch. The only allowed values are
2035	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2167	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2036	together, or C<urxvt::EVENT_NONE>.	2168	together, or C<urxvt::EV_NONE>.
2037		2169
2038	=item $iow = $iow->start	2170	=item $iow = $iow->start
2039		2171
2040	Start watching for requested events on the given handle.	2172	Start watching for requested events on the given handle.
2041		2173
…		…
2082	->new	2214	->new
2083	->start ($pid)	2215	->start ($pid)
2084	->cb (sub {	2216	->cb (sub {
2085	my ($pw, $exit_status) = @_;	2217	my ($pw, $exit_status) = @_;
2086	...	2218	...
2087	});	2219	});
2088		2220
2089	=over 4	2221	=over 4
2090		2222
2091	=item $pw = new urxvt::pw	2223	=item $pw = new urxvt::pw
2092		2224
…		…
2125		2257
2126	=back	2258	=back
2127		2259
2128	=head1 AUTHOR	2260	=head1 AUTHOR
2129		2261
2130	Marc Lehmann <pcg@goof.com>	2262	Marc Lehmann <schmorp@schmorp.de>
2131	http://software.schmorp.de/pkg/rxvt-unicode	2263	http://software.schmorp.de/pkg/rxvt-unicode
2132		2264
2133	=cut	2265	=cut
2134		2266
2135	1	2267	1
		2268
		2269	# vim: sw=3:

Diff Legend

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