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.229 by root, Sat Apr 26 18:53:51 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 that add command line parameters or resources on their own are
45		49	loaded automatically when used.
46	=item selection (enabled by default)
47
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	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		50
364	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
365		52
366	=head2 General API Considerations	53	=head2 General API Considerations
367		54
…		…
381		68
382	=over 4	69	=over 4
383		70
384	=item $text	71	=item $text
385		72
386	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	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.	74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
388		75
389	=item $string	76	=item $string
390		77
391	A perl text string, with an emphasis on I<text>. It can store all unicode	78	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
395	=item $octets	82	=item $octets
396		83
397	Either binary data or - more common - a text string encoded in a	84	Either binary data or - more common - a text string encoded in a
398	locale-specific way.	85	locale-specific way.
399		86
		87	=item $keysym
		88
		89	an integer that is a valid X11 keysym code. You can convert a string
		90	into a keysym and viceversa by using C<XStringToKeysym> and
		91	C<XKeysymToString>.
		92
400	=back	93	=back
401		94
402	=head2 Extension Objects	95	=head2 Extension Objects
403		96
404	Every perl extension is a perl class. A separate perl object is created	97	Every perl extension is a perl class. A separate perl object is created
405	for each terminal, and each terminal has its own set of extenion objects,	98	for each terminal, and each terminal has its own set of extension objects,
406	which are passed as the first parameter to hooks. So extensions can use	99	which are passed as the first parameter to hooks. So extensions can use
407	their C<$self> object without having to think about clashes with other	100	their C<$self> object without having to think about clashes with other
408	extensions or other terminals, with the exception of methods and members	101	extensions or other terminals, with the exception of methods and members
409	that begin with an underscore character C<_>: these are reserved for	102	that begin with an underscore character C<_>: these are reserved for
410	internal use.	103	internal use.
411		104
412	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
413	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
414		107
415	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
416		109	the C<urxvt::extension> section below.
417	=over 4
418
419	=item $urxvt_term = $self->{term}
420
421	Returns the C<urxvt::term> object associated with this instance of the
422	extension. This member I<must not> be changed in any way.
423
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
434	=back
435		110
436	=head2 Hooks	111	=head2 Hooks
437		112
438	The following subroutines can be declared in extension files, and will be	113	The following subroutines can be declared in extension files, and will be
439	called whenever the relevant event happens.	114	called whenever the relevant event happens.
…		…
525		200
526	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
527	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
528	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
529		204
530	=item on_osc_seq $term, $op, $args	205	=item on_osc_seq $term, $op, $args, $resp
531		206
532	Called on every OSC sequence and can be used to suppress it or modify its	207	Called on every OSC sequence and can be used to suppress it or modify its
533	behaviour. The default should be to return an empty list. A true value	208	behaviour. The default should be to return an empty list. A true value
534	suppresses execution of the request completely. Make sure you don't get	209	suppresses execution of the request completely. Make sure you don't get
535	confused by recursive invocations when you output an osc sequence within	210	confused by recursive invocations when you output an OSC sequence within
536	this callback.	211	this callback.
537		212
538	C<on_osc_seq_perl> should be used for new behaviour.	213	C<on_osc_seq_perl> should be used for new behaviour.
539		214
540	=item on_osc_seq_perl $term, $string	215	=item on_osc_seq_perl $term, $args, $resp
541		216
542	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
543	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
544	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
545	string should start with the extension name and a colon, to distinguish	220	string should start with the extension name (sans -osc) and a semicolon,
546	it from commands for other extensions, and this might be enforced in the	221	to distinguish it from commands for other extensions, and this might be
547	future.	222	enforced in the future.
		223
		224	For example, C<overlay-osc> uses this:
		225
		226	sub on_osc_seq_perl {
		227	my ($self, $osc, $resp) = @_;
		228
		229	return unless $osc =~ s/^overlay;//;
		230
		231	... process remaining $osc string
		232	}
548		233
549	Be careful not ever to trust (in a security sense) the data you receive,	234	Be careful not ever to trust (in a security sense) the data you receive,
550	as its source can not easily be controlled (e-mail content, messages from	235	as its source can not easily be controlled (e-mail content, messages from
551	other users on the same system etc.).	236	other users on the same system etc.).
		237
		238	For responses, C<$resp> contains the end-of-args separator used by the
		239	sender.
552		240
553	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
554		242
555	Called whenever text is about to be output, with the text as argument. You	243	Called whenever text is about to be output, with the text as argument. You
556	can filter/change and output the text yourself by returning a true value	244	can filter/change and output the text yourself by returning a true value
…		…
561	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
562		250
563	Called whenever some data is written to the tty/pty and can be used to	251	Called whenever some data is written to the tty/pty and can be used to
564	suppress or filter tty input.	252	suppress or filter tty input.
565		253
		254	=item on_tt_paste $term, $octets
		255
		256	Called whenever text is about to be pasted, with the text as argument. You
		257	can filter/change and paste the text yourself by returning a true value
		258	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		259	locale-encoded.
		260
566	=item on_line_update $term, $row	261	=item on_line_update $term, $row
567		262
568	Called whenever a line was updated or changed. Can be used to filter	263	Called whenever a line was updated or changed. Can be used to filter
569	screen output (e.g. underline urls or other useless stuff). Only lines	264	screen output (e.g. underline urls or other useless stuff). Only lines
570	that are being shown will be filtered, and, due to performance reasons,	265	that are being shown will be filtered, and, due to performance reasons,
…		…
577	later with the already-modified line (e.g. if unrelated parts change), so	272	later with the already-modified line (e.g. if unrelated parts change), so
578	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
579		274
580	=item on_refresh_begin $term	275	=item on_refresh_begin $term
581		276
582	Called just before the screen gets redrawn. Can be used for overlay	277	Called just before the screen gets redrawn. Can be used for overlay or
583	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
584	restoring them in refresh_end. The built-in overlay and selection display	279	restoring them in refresh_end. The built-in overlay and selection display
585	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
586		281
587	=item on_refresh_end $term	282	=item on_refresh_end $term
588		283
589	Called just after the screen gets redrawn. See C<on_refresh_begin>.	284	Called just after the screen gets redrawn. See C<on_refresh_begin>.
590		285
591	=item on_user_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
592		287
593	Called whenever a user-configured event is being activated (e.g. via	288	Called whenever a user-configured event is being activated (e.g. via
594	a C<perl:string> action bound to a key, see description of the B<keysym>	289	a C<perl:string> action bound to a key, see description of the B<keysym>
595	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
596		291
597	The event is simply the action string. This interface is assumed to change	292	The event is simply the action string. This interface is going away in
598	slightly in the future.	293	preference to the C<< ->register_keysym_action >> method.
599		294
		295	=item on_register_command $term, $keysym, $modifiermask, $string
		296
		297	Called after parsing a keysym resource but before registering the
		298	associated binding. If this hook returns a true value the binding
		299	is not registered. It can be used to modify a binding by calling
		300	C<register_command>.
		301
600	=item on_resize_all_windows $tern, $new_width, $new_height	302	=item on_resize_all_windows $term, $new_width, $new_height
601		303
602	Called just after the new window size has been calculated, but before	304	Called just after the new window size has been calculated, but before
603	windows are actually being resized or hints are being set. If this hook	305	windows are actually being resized or hints are being set. If this hook
604	returns TRUE, setting of the window hints is being skipped.	306	returns a true value, setting of the window hints is being skipped.
605		307
606	=item on_x_event $term, $event	308	=item on_x_event $term, $event
607		309
608	Called on every X event received on the vt window (and possibly other	310	Called on every X event received on the vt window (and possibly other
609	windows). Should only be used as a last resort. Most event structure	311	windows). Should only be used as a last resort. Most event structure
…		…
639		341
640	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
641		343
642	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
643		345
644	Called whenever the corresponding X event is received for the terminal If	346	Called whenever the corresponding X event is received for the terminal. If
645	the hook returns true, then the even will be ignored by rxvt-unicode.	347	the hook returns true, then the event will be ignored by rxvt-unicode.
646		348
647	The event is a hash with most values as named by Xlib (see the XEvent	349	The event is a hash with most values as named by Xlib (see the XEvent
648	manpage), with the additional members C<row> and C<col>, which are the	350	manpage), with the additional members C<row> and C<col>, which are the
649	(real, not screen-based) row and column under the mouse cursor.	351	(real, not screen-based) row and column under the mouse cursor.
650		352
…		…
660	=item on_wm_delete_window $term, $event	362	=item on_wm_delete_window $term, $event
661		363
662	Called when various types of ClientMessage events are received (all with	364	Called when various types of ClientMessage events are received (all with
663	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	365	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
664		366
		367	=item on_bell $term
		368
		369	Called on receipt of a bell character.
		370
665	=back	371	=back
666		372
667	=cut	373	=cut
668		374
669	package urxvt;	375	package urxvt;
670		376
671	use utf8;	377	use utf8;
672	use strict;	378	use strict 'vars';
673	use Carp ();	379	use Carp ();
674	use Scalar::Util ();	380	use Scalar::Util ();
675	use List::Util ();	381	use List::Util ();
676		382
677	our $VERSION = 1;	383	our $VERSION = 1;
678	our $TERM;	384	our $TERM;
679	our @TERM_INIT;	385	our @TERM_INIT; # should go, prevents async I/O etc.
680	our @TERM_EXT;	386	our @TERM_EXT; # should go, prevents async I/O etc.
681	our @HOOKNAME;	387	our @HOOKNAME;
682	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	388	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
683	our %OPTION;	389	our %OPTION;
684		390
685	our $LIBDIR;	391	our $LIBDIR;
…		…
733		439
734	=over 4	440	=over 4
735		441
736	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
737		443
738	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
739	costs! The only time this is acceptable is when the terminal process	445	include a trailing newline). Avoid at all costs! The only time this
740	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
741		448
742	=item urxvt::warn $string	449	=item urxvt::warn $string
743		450
744	Calls C<rxvt_warn> with the given string which should not include a	451	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	452	newline. The module also overwrites the C<warn> builtin with a function
746	that calls this function.	453	that calls this function.
747		454
748	Using this function has the advantage that its output ends up in the	455	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.	456	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
753	=item @terms = urxvt::termlist	460	=item @terms = urxvt::termlist
754		461
755	Returns all urxvt::term objects that exist in this process, regardless of	462	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	463	whether they are started, being destroyed etc., so be careful. Only term
757	objects that have perl extensions attached will be returned (because there	464	objects that have perl extensions attached will be returned (because there
758	is no urxvt::term objet associated with others).	465	is no urxvt::term object associated with others).
759		466
760	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
761		468
762	Returns the "current time" (as per the event loop).	469	Returns the "current time" (as per the event loop).
763		470
…		…
806		513
807	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
808		515
809	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
810		517
811	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	518	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		519	urxvt::RS_RVid, urxvt::RS_Uline
812		520
813	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
814	underline, respectively. To enable such a style, just logically OR it into	522	underline, respectively. To enable such a style, just logically OR it into
815	the bitset.	523	the bitset.
816		524
…		…
853	};	561	};
854	}	562	}
855		563
856	no warnings 'utf8';	564	no warnings 'utf8';
857		565
		566	sub parse_resource {
		567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		568
		569	$name =~ y/-/./ if $isarg;
		570
		571	$term->scan_meta;
		572
		573	my $r = $term->{meta}{resource};
		574	keys %$r; # reset iterator
		575	while (my ($pattern, $v) = each %$r) {
		576	if (
		577	$pattern =~ /\.$/
		578	? $pattern eq substr $name, 0, length $pattern
		579	: $pattern eq $name
		580	) {
		581	$name = "$urxvt::RESCLASS.$name";
		582
		583	push @{ $term->{perl_ext_3} }, $v->[0];
		584
		585	if ($v->[1] eq "boolean") {
		586	$term->put_option_db ($name, $flag ? "true" : "false");
		587	return 1;
		588	} else {
		589	$term->put_option_db ($name, $value);
		590	return 1 + 2;
		591	}
		592	}
		593	}
		594
		595	0
		596	}
		597
		598	sub usage {
		599	my ($term, $usage_type) = @_;
		600
		601	$term->scan_meta;
		602
		603	my $r = $term->{meta}{resource};
		604
		605	for my $pattern (sort keys %$r) {
		606	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		607
		608	$desc .= " (-pe $ext)";
		609
		610	if ($usage_type == 1) {
		611	$pattern =~ y/./-/;
		612	$pattern =~ s/-$/-.../g;
		613
		614	if ($type eq "boolean") {
		615	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		616	} else {
		617	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		618	}
		619	} else {
		620	$pattern =~ s/\.$/.*/g;
		621	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		622	}
		623	}
		624	}
		625
858	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
859		627
860	sub verbose {	628	sub verbose {
861	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
862	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
…		…
874	$pkg =~ s/[^[:word:]]/_/g;	642	$pkg =~ s/[^[:word:]]/_/g;
875	$pkg = "urxvt::ext::$pkg";	643	$pkg = "urxvt::ext::$pkg";
876		644
877	verbose 3, "loading extension '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
878		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		648
879	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
880	or die "$path: $!";	650	or die "$path: $!";
881		651
882	my $source =	652	my $source =
883	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
884	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
885	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
886	. "\n};\n1";	656	. "\n};\n1";
887		657
888	eval $source	658	eval $source
…		…
898	sub invoke {	668	sub invoke {
899	local $TERM = shift;	669	local $TERM = shift;
900	my $htype = shift;	670	my $htype = shift;
901		671
902	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
903	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
904		674
905	my %ext_arg;	675	my %ext_arg;
906		676
907	{	677	{
908	my @init = @TERM_INIT;	678	my @init = @TERM_INIT;
909	@TERM_INIT = ();	679	@TERM_INIT = ();
…		…
911	my @pkg = @TERM_EXT;	681	my @pkg = @TERM_EXT;
912	@TERM_EXT = ();	682	@TERM_EXT = ();
913	$TERM->register_package ($_) for @pkg;	683	$TERM->register_package ($_) for @pkg;
914	}	684	}
915		685
		686	for (
		687	@{ delete $TERM->{perl_ext_3} },
916	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		689	) {
917	if ($_ eq "default") {	690	if ($_ eq "default") {
918	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	691	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
919	} elsif (/^-(.*)$/) {	692	} elsif (/^-(.*)$/) {
920	delete $ext_arg{$1};	693	delete $ext_arg{$1};
921	} elsif (/^([^<]+)<(.*)>$/) {	694	} elsif (/^([^<]+)<(.*)>$/) {
…		…
944	if (my $cb = $TERM->{_hook}[$htype]) {	717	if (my $cb = $TERM->{_hook}[$htype]) {
945	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
946	if $verbosity >= 10;	719	if $verbosity >= 10;
947		720
948	for my $pkg (keys %$cb) {	721	for my $pkg (keys %$cb) {
949	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
950	$retval ||= $retval_;	723	$retval ||= $retval_;
951		724
952	if ($@) {	725	if ($@) {
953	$TERM->ungrab; # better to lose the grab than the session	726	$TERM->ungrab; # better to lose the grab than the session
954	warn $@;	727	warn $@;
…		…
972		745
973	sub SET_COLOR($$$) {	746	sub SET_COLOR($$$) {
974	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	747	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
975	}	748	}
976		749
977	# urxvt::term::extension	750	sub rend2mask {
		751	no strict 'refs';
		752	my ($str, $mask) = (@_, 0);
		753	my %color = ( fg => undef, bg => undef );
		754	my @failed;
		755	for my $spec ( split /\s+/, $str ) {
		756	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		757	$color{lc($1)} = $2;
		758	} else {
		759	my $neg = $spec =~ s/^[-^]//;
		760	unless ( exists &{"RS_$spec"} ) {
		761	push @failed, $spec;
		762	next;
		763	}
		764	my $cur = &{"RS_$spec"};
		765	if ( $neg ) {
		766	$mask &= ~$cur;
		767	} else {
		768	$mask |= $cur;
		769	}
		770	}
		771	}
		772	($mask, @color{qw(fg bg)}, \@failed)
		773	}
978		774
979	package urxvt::term::extension;	775	package urxvt::term::extension;
980		776
981	sub enable {	777	=head2 The C<urxvt::term::extension> class
982	my ($self, %hook) = @_;
983	my $pkg = $self->{_pkg};
984		778
985	while (my ($name, $cb) = each %hook) {	779	Each extension attached to a terminal object is represented by
986	my $htype = $HOOKTYPE{uc $name};	780	a C<urxvt::term::extension> object.
987	defined $htype
988	or Carp::croak "unsupported hook type '$name'";
989		781
990	$self->set_should_invoke ($htype, +1)	782	You can use these objects, which are passed to all callbacks to store any
991	unless exists $self->{term}{_hook}[$htype]{$pkg};	783	state related to the terminal and extension instance.
992		784
993	$self->{term}{_hook}[$htype]{$pkg} = $cb;	785	The methods (And data members) documented below can be called on extension
994	}	786	objects, in addition to call methods documented for the <urxvt::term>
995	}	787	class.
996		788
997	sub disable {	789	=over 4
998	my ($self, @hook) = @_;
999	my $pkg = $self->{_pkg};
1000		790
1001	for my $name (@hook) {	791	=item $urxvt_term = $self->{term}
1002	my $htype = $HOOKTYPE{uc $name};
1003	defined $htype
1004	or Carp::croak "unsupported hook type '$name'";
1005		792
1006	$self->set_should_invoke ($htype, -1)	793	Returns the C<urxvt::term> object associated with this instance of the
1007	if delete $self->{term}{_hook}[$htype]{$pkg};	794	extension. This member I<must not> be changed in any way.
1008	}	795
1009	}	796	=cut
1010		797
1011	our $AUTOLOAD;	798	our $AUTOLOAD;
1012		799
1013	sub AUTOLOAD {	800	sub AUTOLOAD {
1014	$AUTOLOAD =~ /:([^:]+)$/	801	$AUTOLOAD =~ /:([^:]+)$/
…		…
1027		814
1028	sub DESTROY {	815	sub DESTROY {
1029	# nop	816	# nop
1030	}	817	}
1031		818
1032	# urxvt::destroy_hook	819	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1033		820
1034	sub urxvt::destroy_hook::DESTROY {	821	sub urxvt::destroy_hook::DESTROY {
1035	${$_[0]}->();	822	${$_[0]}->();
1036	}	823	}
1037		824
1038	sub urxvt::destroy_hook(&) {	825	sub urxvt::destroy_hook(&) {
1039	bless \shift, urxvt::destroy_hook::	826	bless \shift, urxvt::destroy_hook::
1040	}	827	}
		828
		829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		830
		831	Dynamically enable the given hooks (named without the C<on_> prefix) for
		832	this extension, replacing any hook previously installed via C<enable> in
		833	this extension.
		834
		835	This is useful when you want to overwrite time-critical hooks only
		836	temporarily.
		837
		838	To install additional callbacks for the same hook, you can use the C<on>
		839	method of the C<urxvt::term> class.
		840
		841	=item $self->disable ($hook_name[, $hook_name..])
		842
		843	Dynamically disable the given hooks.
		844
		845	=cut
		846
		847	sub enable {
		848	my ($self, %hook) = @_;
		849	my $pkg = $self->{_pkg};
		850
		851	while (my ($name, $cb) = each %hook) {
		852	my $htype = $HOOKTYPE{uc $name};
		853	defined $htype
		854	or Carp::croak "unsupported hook type '$name'";
		855
		856	$self->set_should_invoke ($htype, +1)
		857	unless exists $self->{term}{_hook}[$htype]{$pkg};
		858
		859	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		860	}
		861	}
		862
		863	sub disable {
		864	my ($self, @hook) = @_;
		865	my $pkg = $self->{_pkg};
		866
		867	for my $name (@hook) {
		868	my $htype = $HOOKTYPE{uc $name};
		869	defined $htype
		870	or Carp::croak "unsupported hook type '$name'";
		871
		872	$self->set_should_invoke ($htype, -1)
		873	if delete $self->{term}{_hook}[$htype]{$pkg};
		874	}
		875	}
		876
		877	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		878
		879	Similar to the C<enable> enable, but installs additional callbacks for
		880	the given hook(s) (that is, it doesn't replace existing callbacks), and
		881	returns a guard object. When the guard object is destroyed the callbacks
		882	are disabled again.
		883
		884	=cut
		885
		886	sub urxvt::extension::on_disable::DESTROY {
		887	my $disable = shift;
		888
		889	my $term = delete $disable->{""};
		890
		891	while (my ($htype, $id) = each %$disable) {
		892	delete $term->{_hook}[$htype]{$id};
		893	$term->set_should_invoke ($htype, -1);
		894	}
		895	}
		896
		897	sub on {
		898	my ($self, %hook) = @_;
		899
		900	my $term = $self->{term};
		901
		902	my %disable = ( "" => $term );
		903
		904	while (my ($name, $cb) = each %hook) {
		905	my $htype = $HOOKTYPE{uc $name};
		906	defined $htype
		907	or Carp::croak "unsupported hook type '$name'";
		908
		909	$term->set_should_invoke ($htype, +1);
		910	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		911	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		912	}
		913
		914	bless \%disable, "urxvt::extension::on_disable"
		915	}
		916
		917	=item $self->x_resource ($pattern)
		918
		919	=item $self->x_resource_boolean ($pattern)
		920
		921	These methods support an additional C<%> prefix when called on an
		922	extension object - see the description of these methods in the
		923	C<urxvt::term> class for details.
		924
		925	=cut
		926
		927	sub x_resource {
		928	my ($self, $name) = @_;
		929	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		930	$self->{term}->x_resource ($name)
		931	}
		932
		933	sub x_resource_boolean {
		934	my ($self, $name) = @_;
		935	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		936	$self->{term}->x_resource_boolean ($name)
		937	}
		938
		939	=back
		940
		941	=cut
1041		942
1042	package urxvt::anyevent;	943	package urxvt::anyevent;
1043		944
1044	=head2 The C<urxvt::anyevent> Class	945	=head2 The C<urxvt::anyevent> Class
1045		946
1046	The sole purpose of this class is to deliver an interface to the	947	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	948	C<AnyEvent> module - any module using it will work inside urxvt without
1048	further programming. The only exception is that you cannot wait on	949	further programming. The only exception is that you cannot wait on
1049	condition variables, but non-blocking condvar use is ok. What this means	950	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		951
1053	=cut	952	In practical terms this means is that you cannot use blocking APIs, but
		953	the non-blocking variant should work.
1054		954
		955	=cut
		956
1055	our $VERSION = 1;	957	our $VERSION = '5.23';
1056		958
1057	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	959	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1058	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	960	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1059		961
1060	sub timer {	962	sub timer {
…		…
1062		964
1063	my $cb = $arg{cb};	965	my $cb = $arg{cb};
1064		966
1065	urxvt::timer	967	urxvt::timer
1066	->new	968	->new
1067	->start (urxvt::NOW + $arg{after})	969	->after ($arg{after}, $arg{interval})
1068	->cb (sub {	970	->cb ($arg{interval} ? $cb : sub {
1069	$_[0]->stop; # need to cancel manually	971	$_[0]->stop; # need to cancel manually
1070	$cb->();	972	$cb->();
1071	})	973	})
1072	}	974	}
1073		975
1074	sub io {	976	sub io {
1075	my ($class, %arg) = @_;	977	my ($class, %arg) = @_;
1076		978
1077	my $cb = $arg{cb};	979	my $cb = $arg{cb};
		980	my $fd = fileno $arg{fh};
		981	defined $fd or $fd = $arg{fh};
1078		982
1079	bless [$arg{fh}, urxvt::iow	983	bless [$arg{fh}, urxvt::iow
1080	->new	984	->new
1081	->fd (fileno $arg{fh})	985	->fd ($fd)
1082	->events (($arg{poll} =~ /r/ ? 1 : 0)	986	->events (($arg{poll} =~ /r/ ? 1 : 0)
1083	| ($arg{poll} =~ /w/ ? 2 : 0))	987	| ($arg{poll} =~ /w/ ? 2 : 0))
1084	->start	988	->start
1085	->cb (sub {	989	->cb ($cb)
1086	$cb->(($_[1] & 1 ? 'r' : '')
1087	. ($_[1] & 2 ? 'w' : ''));
1088	})],
1089	urxvt::anyevent::	990	], urxvt::anyevent::
		991	}
		992
		993	sub idle {
		994	my ($class, %arg) = @_;
		995
		996	my $cb = $arg{cb};
		997
		998	urxvt::iw
		999	->new
		1000	->start
		1001	->cb ($cb)
		1002	}
		1003
		1004	sub child {
		1005	my ($class, %arg) = @_;
		1006
		1007	my $cb = $arg{cb};
		1008
		1009	urxvt::pw
		1010	->new
		1011	->start ($arg{pid})
		1012	->cb (sub {
		1013	$_[0]->stop; # need to cancel manually
		1014	$cb->($_[0]->rpid, $_[0]->rstatus);
		1015	})
1090	}	1016	}
1091		1017
1092	sub DESTROY {	1018	sub DESTROY {
1093	$_[0][1]->stop;	1019	$_[0][1]->stop;
1094	}	1020	}
1095		1021
1096	sub condvar {	1022	# only needed for AnyEvent < 6 compatibility
1097	bless \my $flag, urxvt::anyevent::condvar::	1023	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";	1024	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1107	}
1108	}	1025	}
1109		1026
1110	package urxvt::term;	1027	package urxvt::term;
1111		1028
1112	=head2 The C<urxvt::term> Class	1029	=head2 The C<urxvt::term> Class
…		…
1125	urxvt::verbose 6, "register package $pkg to $self";	1042	urxvt::verbose 6, "register package $pkg to $self";
1126		1043
1127	@{"$pkg\::ISA"} = urxvt::term::extension::;	1044	@{"$pkg\::ISA"} = urxvt::term::extension::;
1128		1045
1129	my $proxy = bless {	1046	my $proxy = bless {
1130	_pkg => $pkg,	1047	_pkg => $pkg,
		1048	_name => ${"$pkg\::_NAME"}, # hackish
1131	argv => $argv,	1049	argv => $argv,
1132	}, $pkg;	1050	}, $pkg;
1133	Scalar::Util::weaken ($proxy->{term} = $self);	1051	Scalar::Util::weaken ($proxy->{term} = $self);
1134		1052
1135	$self->{_pkg}{$pkg} = $proxy;	1053	$self->{_pkg}{$pkg} = $proxy;
1136		1054
…		…
1139	$proxy->enable ($name => $ref);	1057	$proxy->enable ($name => $ref);
1140	}	1058	}
1141	}	1059	}
1142	}	1060	}
1143		1061
		1062	sub perl_libdirs {
		1063	map { split /:/ }
		1064	$_[0]->resource ("perl_lib"),
		1065	$ENV{URXVT_PERL_LIB},
		1066	"$ENV{HOME}/.urxvt/ext",
		1067	"$LIBDIR/perl"
		1068	}
		1069
		1070	sub scan_meta {
		1071	my ($self) = @_;
		1072	my @libdirs = perl_libdirs $self;
		1073
		1074	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1075
		1076	my %meta;
		1077
		1078	$self->{meta_libdirs} = join "\x00", @libdirs;
		1079	$self->{meta} = \%meta;
		1080
		1081	for my $dir (reverse @libdirs) {
		1082	opendir my $fh, $dir
		1083	or next;
		1084	for my $ext (readdir $fh) {
		1085	$ext !~ /^\./
		1086	and open my $fh, "<", "$dir/$ext"
		1087	or next;
		1088
		1089	while (<$fh>) {
		1090	if (/^#:META:X_RESOURCE:(.*)/) {
		1091	my ($pattern, $type, $desc) = split /:/, $1;
		1092	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1093	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1094	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1095	} else {
		1096	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1097	}
		1098	} elsif (/^\s*(?:#|$)/) {
		1099	# skip other comments and empty lines
		1100	} else {
		1101	last; # stop parsing on first non-empty non-comment line
		1102	}
		1103	}
		1104	}
		1105	}
		1106	}
		1107
1144	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1108	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1145		1109
1146	Creates a new terminal, very similar as if you had started it with system	1110	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	1111	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1148	hash which defines the environment of the new terminal.	1112	hash which defines the environment of the new terminal.
…		…
1165	}	1129	}
1166		1130
1167	=item $term->destroy	1131	=item $term->destroy
1168		1132
1169	Destroy the terminal object (close the window, free resources	1133	Destroy the terminal object (close the window, free resources
1170	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1134	etc.). Please note that urxvt will not exit as long as any event
1171	watchers (timers, io watchers) are still active.	1135	watchers (timers, io watchers) are still active.
1172		1136
1173	=item $term->exec_async ($cmd[, @args])	1137	=item $term->exec_async ($cmd[, @args])
1174		1138
1175	Works like the combination of the C<fork>/C<exec> builtins, which executes	1139	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.	1166	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1203		1167
1204	Here is a likely non-exhaustive list of option names, please see the	1168	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:	1169	source file F</src/optinc.h> to see the actual list:
1206		1170
1207	borderLess console cursorBlink cursorUnderline hold iconic insecure	1171	borderLess buffered console cursorBlink cursorUnderline hold iconic
1208	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1172	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1209	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1173	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1210	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1174	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1211	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1175	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1212	transparent tripleclickwords utmpInhibit visualBell	1176	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1177	urgentOnBell utmpInhibit visualBell
1213		1178
1214	=item $value = $term->resource ($name[, $newval])	1179	=item $value = $term->resource ($name[, $newval])
1215		1180
1216	Returns the current resource value associated with a given name and	1181	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>	1182	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1230		1195
1231	Here is a likely non-exhaustive list of resource names, not all of which	1196	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>	1197	are supported in every build, please see the source file F</src/rsinc.h>
1233	to see the actual list:	1198	to see the actual list:
1234		1199
1235	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1200	answerbackstring backgroundPixmap backspace_key blurradius
1236	borderLess color cursorBlink cursorUnderline cutchars delete_key	1201	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1237	display_name embed ext_bwidth fade font geometry hold iconName	1202	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1238	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1203	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1204	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1239	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1205	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1240	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1206	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1241	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1207	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1242	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1208	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1243	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1209	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1244	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1210	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1245	secondaryScreen secondaryScroll selectstyle shade term_name title	1211	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1246	transient_for transparent transparent_all tripleclickwords utmpInhibit	1212	term_name title transient_for transparent tripleclickwords urgentOnBell
1247	visualBell	1213	utmpInhibit visualBell
1248		1214
1249	=cut	1215	=cut
1250		1216
1251	sub resource($$;$) {	1217	sub resource($$;$) {
1252	my ($self, $name) = (shift, shift);	1218	my ($self, $name) = (shift, shift);
1253	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1219	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1254	&urxvt::term::_resource	1220	goto &urxvt::term::_resource
1255	}	1221	}
1256		1222
1257	=item $value = $term->x_resource ($pattern)	1223	=item $value = $term->x_resource ($pattern)
1258		1224
1259	Returns the X-Resource for the given pattern, excluding the program or	1225	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	1226	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	1227	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1262	resource with that pattern exists.	1228	resource with that pattern exists.
1263		1229
		1230	Extensions that define extra resource or command line arguments also need
		1231	to call this method to access their values.
		1232
		1233	If the method is called on an extension object (basically, from an
		1234	extension), then the special prefix C<%.> will be replaced by the name of
		1235	the extension and a dot, and the lone string C<%> will be replaced by the
		1236	extension name itself. This makes it possible to code extensions so you
		1237	can rename them and get a new set of commandline switches and resources
		1238	without having to change the actual code.
		1239
1264	This method should only be called during the C<on_start> hook, as there is	1240	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	1241	only one resource database per display, and later invocations might return
1266	the wrong resources.	1242	the wrong resources.
1267		1243
1268	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1244	=item $value = $term->x_resource_boolean ($pattern)
1269		1245
		1246	Like C<x_resource>, above, but interprets the string value as a boolean
		1247	and returns C<1> for true values, C<0> for false values and C<undef> if
		1248	the resource or option isn't specified.
		1249
		1250	You should always use this method to parse boolean resources.
		1251
		1252	=cut
		1253
		1254	sub x_resource_boolean {
		1255	my $res = &x_resource;
		1256
		1257	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1258	}
		1259
		1260	=item $success = $term->parse_keysym ($key, $octets)
		1261
1270	Adds a keymap translation exactly as specified via a resource. See the	1262	Adds a key binding exactly as specified via a resource. See the
1271	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1263	C<keysym> resource in the urxvt(1) manpage.
		1264
		1265	=item $term->register_command ($keysym, $modifiermask, $string)
		1266
		1267	Adds a key binding. This is a lower level api compared to
		1268	C<parse_keysym>, as it expects a parsed key description, and can be
		1269	used only inside either the C<on_init> hook, to add a binding, or the
		1270	C<on_register_command> hook, to modify a parsed binding.
1272		1271
1273	=item $rend = $term->rstyle ([$new_rstyle])	1272	=item $rend = $term->rstyle ([$new_rstyle])
1274		1273
1275	Return and optionally change the current rendition. Text that is output by	1274	Return and optionally change the current rendition. Text that is output by
1276	the terminal application will use this style.	1275	the terminal application will use this style.
…		…
1284		1283
1285	=item ($row, $col) = $term->selection_beg ([$row, $col])	1284	=item ($row, $col) = $term->selection_beg ([$row, $col])
1286		1285
1287	=item ($row, $col) = $term->selection_end ([$row, $col])	1286	=item ($row, $col) = $term->selection_end ([$row, $col])
1288		1287
1289	Return the current values of the selection mark, begin or end positions,	1288	Return the current values of the selection mark, begin or end positions.
1290	and optionally set them to new values.	1289
		1290	When arguments are given, then the selection coordinates are set to
		1291	C<$row> and C<$col>, and the selection screen is set to the current
		1292	screen.
		1293
		1294	=item $screen = $term->selection_screen ([$screen])
		1295
		1296	Returns the current selection screen, and then optionally sets it.
1291		1297
1292	=item $term->selection_make ($eventtime[, $rectangular])	1298	=item $term->selection_make ($eventtime[, $rectangular])
1293		1299
1294	Tries to make a selection as set by C<selection_beg> and	1300	Tries to make a selection as set by C<selection_beg> and
1295	C<selection_end>. If C<$rectangular> is true (default: false), a	1301	C<selection_end>. If C<$rectangular> is true (default: false), a
1296	rectangular selection will be made. This is the prefered function to make	1302	rectangular selection will be made. This is the preferred function to make
1297	a selection.	1303	a selection.
1298		1304
1299	=item $success = $term->selection_grab ($eventtime)	1305	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1300		1306
1301	Try to request the primary selection text from the server (for example, as	1307	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1308	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	1309	with the next method. No visual feedback will be given. This function
1303	is mostly useful from within C<on_sel_grab> hooks.	1310	is mostly useful from within C<on_sel_grab> hooks.
1304		1311
1305	=item $oldtext = $term->selection ([$newtext])	1312	=item $oldtext = $term->selection ([$newtext, $clipboard])
1306		1313
1307	Return the current selection text and optionally replace it by C<$newtext>.	1314	Return the current selection (clipboard if C<$clipboard> is true) text
		1315	and optionally replace it by C<$newtext>.
		1316
		1317	=item $term->selection_clear ([$clipboard])
		1318
		1319	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1308		1320
1309	=item $term->overlay_simple ($x, $y, $text)	1321	=item $term->overlay_simple ($x, $y, $text)
1310		1322
1311	Create a simple multi-line overlay box. See the next method for details.	1323	Create a simple multi-line overlay box. See the next method for details.
1312		1324
…		…
1342		1354
1343	The methods currently supported on C<urxvt::overlay> objects are:	1355	The methods currently supported on C<urxvt::overlay> objects are:
1344		1356
1345	=over 4	1357	=over 4
1346		1358
1347	=item $overlay->set ($x, $y, $text, $rend)	1359	=item $overlay->set ($x, $y, $text[, $rend])
1348		1360
1349	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1361	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	1362	text in rxvt-unicode's special encoding and an array of rendition values
1351	at a specific position inside the overlay.	1363	at a specific position inside the overlay.
		1364
		1365	If C<$rend> is missing, then the rendition will not be changed.
1352		1366
1353	=item $overlay->hide	1367	=item $overlay->hide
1354		1368
1355	If visible, hide the overlay, but do not destroy it.	1369	If visible, hide the overlay, but do not destroy it.
1356		1370
…		…
1438	locale-specific encoding of the terminal and can contain command sequences	1452	locale-specific encoding of the terminal and can contain command sequences
1439	(escape codes) that will be interpreted.	1453	(escape codes) that will be interpreted.
1440		1454
1441	=item $term->tt_write ($octets)	1455	=item $term->tt_write ($octets)
1442		1456
1443	Write the octets given in C<$data> to the tty (i.e. as program input). To	1457	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1444	pass characters instead of octets, you should convert your strings first	1458	pass characters instead of octets, you should convert your strings first
1445	to the locale-specific encoding using C<< $term->locale_encode >>.	1459	to the locale-specific encoding using C<< $term->locale_encode >>.
		1460
		1461	=item $term->tt_paste ($octets)
		1462
		1463	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1464	CR and bracketing the data with control sequences if bracketed paste mode
		1465	is set.
1446		1466
1447	=item $old_events = $term->pty_ev_events ([$new_events])	1467	=item $old_events = $term->pty_ev_events ([$new_events])
1448		1468
1449	Replaces the event mask of the pty watcher by the given event mask. Can	1469	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	1470	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	1489	Adds the specified events to the vt event mask. Useful e.g. when you want
1470	to receive pointer events all the times:	1490	to receive pointer events all the times:
1471		1491
1472	$term->vt_emask_add (urxvt::PointerMotionMask);	1492	$term->vt_emask_add (urxvt::PointerMotionMask);
1473		1493
		1494	=item $term->set_urgency ($set)
		1495
		1496	Enable/disable the urgency hint on the toplevel window.
		1497
1474	=item $term->focus_in	1498	=item $term->focus_in
1475		1499
1476	=item $term->focus_out	1500	=item $term->focus_out
1477		1501
1478	=item $term->key_press ($state, $keycode[, $time])	1502	=item $term->key_press ($state, $keycode[, $time])
…		…
1566		1590
1567	Used after changing terminal contents to display them.	1591	Used after changing terminal contents to display them.
1568		1592
1569	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1593	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1570		1594
1571	Returns the text of the entire row with number C<$row_number>. Row C<0>	1595	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	1596	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	1597	terminal line. Nothing will be returned if a nonexistent line
1575	is requested.	1598	is requested.
1576		1599
1577	If C<$new_text> is specified, it will replace characters in the current	1600	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	1601	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	1602	to replace only parts of a line. The font index in the rendition will
1580	automatically be updated.	1603	automatically be updated.
1581		1604
1582	C<$text> is in a special encoding: tabs and wide characters that use more	1605	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)	1606	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1584	characters. Characters with combining characters and other characters that	1607	characters. Characters with combining characters and other characters that
1585	do not fit into the normal tetx encoding will be replaced with characters	1608	do not fit into the normal text encoding will be replaced with characters
1586	in the private use area.	1609	in the private use area.
1587		1610
1588	You have to obey this encoding when changing text. The advantage is	1611	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	1612	that C<substr> and similar functions work on screen cells and not on
1590	characters.	1613	characters.
…		…
1675	}	1698	}
1676		1699
1677	sub urxvt::line::t {	1700	sub urxvt::line::t {
1678	my ($self) = @_;	1701	my ($self) = @_;
1679		1702
1680	if (@_ > 1)	1703	if (@_ > 1) {
1681	{
1682	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1704	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1683	for $self->{beg} .. $self->{end};	1705	for $self->{beg} .. $self->{end};
1684	}	1706	}
1685		1707
1686	defined wantarray &&	1708	defined wantarray &&
1687	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1709	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1688	0, $self->{len}	1710	0, $self->{len}
1689	}	1711	}
1690		1712
1691	sub urxvt::line::r {	1713	sub urxvt::line::r {
1692	my ($self) = @_;	1714	my ($self) = @_;
1693		1715
1694	if (@_ > 1)	1716	if (@_ > 1) {
1695	{
1696	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1717	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1697	for $self->{beg} .. $self->{end};	1718	for $self->{beg} .. $self->{end};
1698	}	1719	}
1699		1720
1700	if (defined wantarray) {	1721	if (defined wantarray) {
1701	my $rend = [	1722	my $rend = [
1702	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1723	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1703	];	1724	];
…		…
1765	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1786	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1766	recent grab.	1787	recent grab.
1767		1788
1768	=item $term->ungrab	1789	=item $term->ungrab
1769		1790
1770	Calls XUngrab for the most recent grab. Is called automatically on	1791	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	1792	evaluation errors, as it is better to lose the grab in the error case as
1772	the session.	1793	the session.
1773		1794
1774	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1795	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1775		1796
…		…
1777		1798
1778	=item @atoms = $term->XListProperties ($window)	1799	=item @atoms = $term->XListProperties ($window)
1779		1800
1780	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1801	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1781		1802
1782	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1803	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1783		1804
1784	=item $term->XDeleteProperty ($window, $property)	1805	=item $term->XDeleteProperty ($window, $property)
1785		1806
1786	=item $window = $term->DefaultRootWindow	1807	=item $window = $term->DefaultRootWindow
1787		1808
…		…
1794	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1815	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1795		1816
1796	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1817	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1797		1818
1798	=item $term->XChangeInput ($window, $add_events[, $del_events])	1819	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1820
		1821	=item $keysym = $term->XStringToKeysym ($string)
		1822
		1823	=item $string = $term->XKeysymToString ($keysym)
1799		1824
1800	Various X or X-related functions. The C<$term> object only serves as	1825	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	1826	the source of the display, otherwise those functions map more-or-less
1802	directory onto the X functions of the same name.	1827	directly onto the X functions of the same name.
1803		1828
1804	=back	1829	=back
1805		1830
1806	=cut	1831	=cut
1807		1832
…		…
1909	my $env = $self->{term}->env;	1934	my $env = $self->{term}->env;
1910	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1935	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1911	delete $env->{LC_ALL};	1936	delete $env->{LC_ALL};
1912	$env->{LC_CTYPE} = $self->{term}->locale;	1937	$env->{LC_CTYPE} = $self->{term}->locale;
1913		1938
1914	urxvt::term->new ($env, "popup",	1939	my $term = urxvt::term->new (
		1940	$env, "popup",
1915	"--perl-lib" => "", "--perl-ext-common" => "",	1941	"--perl-lib" => "", "--perl-ext-common" => "",
1916	"-pty-fd" => -1, "-sl" => 0,	1942	"-pty-fd" => -1, "-sl" => 0,
1917	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1943	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1918	"--transient-for" => $self->{term}->parent,	1944	"--transient-for" => $self->{term}->parent,
1919	"-display" => $self->{term}->display_id,	1945	"-display" => $self->{term}->display_id,
1920	"-pe" => "urxvt-popup")	1946	"-pe" => "urxvt-popup",
1921	or die "unable to create popup window\n";	1947	) or die "unable to create popup window\n";
		1948
		1949	unless (delete $term->{urxvt_popup_init_done}) {
		1950	$term->ungrab;
		1951	$term->destroy;
		1952	die "unable to initialise popup window\n";
		1953	}
1922	}	1954	}
1923		1955
1924	sub DESTROY {	1956	sub DESTROY {
1925	my ($self) = @_;	1957	my ($self) = @_;
1926		1958
…		…
1931	=back	1963	=back
1932		1964
1933	=cut	1965	=cut
1934		1966
1935	package urxvt::watcher;	1967	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		1968
1942	=head2 The C<urxvt::timer> Class	1969	=head2 The C<urxvt::timer> Class
1943		1970
1944	This class implements timer watchers/events. Time is represented as a	1971	This class implements timer watchers/events. Time is represented as a
1945	fractional number of seconds since the epoch. Example:	1972	fractional number of seconds since the epoch. Example:
…		…
1949	->new	1976	->new
1950	->interval (1)	1977	->interval (1)
1951	->cb (sub {	1978	->cb (sub {
1952	$term->{overlay}->set (0, 0,	1979	$term->{overlay}->set (0, 0,
1953	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1980	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1954	});	1981	});
1955		1982
1956	=over 4	1983	=over 4
1957		1984
1958	=item $timer = new urxvt::timer	1985	=item $timer = new urxvt::timer
1959		1986
…		…
1962		1989
1963	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1990	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1964		1991
1965	Set the callback to be called when the timer triggers.	1992	Set the callback to be called when the timer triggers.
1966		1993
1967	=item $tstamp = $timer->at
1968
1969	Return the time this watcher will fire next.
1970
1971	=item $timer = $timer->set ($tstamp)	1994	=item $timer = $timer->set ($tstamp[, $interval])
1972		1995
1973	Set the time the event is generated to $tstamp.	1996	Set the time the event is generated to $tstamp (and optionally specifies a
		1997	new $interval).
1974		1998
1975	=item $timer = $timer->interval ($interval)	1999	=item $timer = $timer->interval ($interval)
1976		2000
1977	Normally (and when C<$interval> is C<0>), the timer will automatically	2001	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	2002	stop after it has fired once. If C<$interval> is non-zero, then the timer
1979	is automatically rescheduled at the given intervals.	2003	is automatically rescheduled at the given intervals.
1980		2004
1981	=item $timer = $timer->start	2005	=item $timer = $timer->start
1982		2006
1983	Start the timer.	2007	Start the timer.
1984		2008
1985	=item $timer = $timer->start ($tstamp)	2009	=item $timer = $timer->start ($tstamp[, $interval])
1986		2010
1987	Set the event trigger time to C<$tstamp> and start the timer.	2011	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2012	also replaces the interval.
1988		2013
1989	=item $timer = $timer->after ($delay)	2014	=item $timer = $timer->after ($delay[, $interval])
1990		2015
1991	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2016	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1992		2017
1993	=item $timer = $timer->stop	2018	=item $timer = $timer->stop
1994		2019
…		…
2002		2027
2003	$term->{socket} = ...	2028	$term->{socket} = ...
2004	$term->{iow} = urxvt::iow	2029	$term->{iow} = urxvt::iow
2005	->new	2030	->new
2006	->fd (fileno $term->{socket})	2031	->fd (fileno $term->{socket})
2007	->events (urxvt::EVENT_READ)	2032	->events (urxvt::EV_READ)
2008	->start	2033	->start
2009	->cb (sub {	2034	->cb (sub {
2010	my ($iow, $revents) = @_;	2035	my ($iow, $revents) = @_;
2011	# $revents must be 1 here, no need to check	2036	# $revents must be 1 here, no need to check
2012	sysread $term->{socket}, my $buf, 8192	2037	sysread $term->{socket}, my $buf, 8192
…		…
2030	Set the file descriptor (not handle) to watch.	2055	Set the file descriptor (not handle) to watch.
2031		2056
2032	=item $iow = $iow->events ($eventmask)	2057	=item $iow = $iow->events ($eventmask)
2033		2058
2034	Set the event mask to watch. The only allowed values are	2059	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	2060	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2036	together, or C<urxvt::EVENT_NONE>.	2061	together, or C<urxvt::EV_NONE>.
2037		2062
2038	=item $iow = $iow->start	2063	=item $iow = $iow->start
2039		2064
2040	Start watching for requested events on the given handle.	2065	Start watching for requested events on the given handle.
2041		2066
…		…
2082	->new	2107	->new
2083	->start ($pid)	2108	->start ($pid)
2084	->cb (sub {	2109	->cb (sub {
2085	my ($pw, $exit_status) = @_;	2110	my ($pw, $exit_status) = @_;
2086	...	2111	...
2087	});	2112	});
2088		2113
2089	=over 4	2114	=over 4
2090		2115
2091	=item $pw = new urxvt::pw	2116	=item $pw = new urxvt::pw
2092		2117
…		…
2125		2150
2126	=back	2151	=back
2127		2152
2128	=head1 AUTHOR	2153	=head1 AUTHOR
2129		2154
2130	Marc Lehmann <pcg@goof.com>	2155	Marc Lehmann <schmorp@schmorp.de>
2131	http://software.schmorp.de/pkg/rxvt-unicode	2156	http://software.schmorp.de/pkg/rxvt-unicode
2132		2157
2133	=cut	2158	=cut
2134		2159
2135	1	2160	1
		2161
		2162	# vim: sw=3:

Diff Legend

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