ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

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

Diff Legend

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