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.148 by root, Tue Oct 3 21:41:07 2006 UTC vs.
Revision 1.231 by root, Sun Apr 27 20:26:28 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 matcher
246
247	Uses per-line display filtering (C<on_line_update>) to underline text
248	matching a certain pattern and make it clickable. When clicked with the
249	mouse button specified in the C<matcher.button> resource (default 2, or
250	middle), the program specified in the C<matcher.launcher> resource
251	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
252	with the matched text as first argument. The default configuration is
253	suitable for matching URLs and launching a web browser, like the
254	former "mark-urls" extension.
255
256	The default pattern to match URLs can be overridden with the
257	C<matcher.pattern.0> resource, and additional patterns can be specified
258	with numbered patterns, in a manner similar to the "selection" extension.
259	The launcher can also be overridden on a per-pattern basis.
260
261	Example configuration:
262
263	URxvt.perl-ext: default,matcher
264	URxvt.urlLauncher: sensible-browser
265	URxvt.matcher.button: 1
266	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
267	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
268	URxvt.matcher.launcher.2: gvim +$2 $1
269
270	=item xim-onthespot
271
272	This (experimental) perl extension implements OnTheSpot editing. It does
273	not work perfectly, and some input methods don't seem to work well with
274	OnTheSpot editing in general, but it seems to work at leats for SCIM and
275	kinput2.
276
277	You enable it by specifying this extension and a preedit style of
278	C<OnTheSpot>, i.e.:
279
280	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
281
282	=item kuake<hotkey>
283
284	A very primitive quake-console-like extension. It was inspired by a
285	description of how the programs C<kuake> and C<yakuake> work: Whenever the
286	user presses a global accelerator key (by default C<F10>), the terminal
287	will show or hide itself. Another press of the accelerator key will hide
288	or show it again.
289
290	Initially, the window will not be shown when using this extension.
291
292	This is useful if you need a single terminal thats not using any desktop
293	space most of the time but is quickly available at the press of a key.
294
295	The accelerator key is grabbed regardless of any modifiers, so this
296	extension will actually grab a physical key just for this function.
297
298	If you want a quake-like animation, tell your window manager to do so
299	(fvwm can do it).
300
301	=item automove-background
302
303	This is basically a very small extension that dynamically changes the
304	background pixmap offset to the window position, in effect creating the
305	same effect as pseudo transparency with a custom pixmap. No scaling is
306	supported in this mode. Example:
307
308	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
309
310	=item block-graphics-to-ascii
311
312	A not very useful example of filtering all text output to the terminal
313	by replacing all line-drawing characters (U+2500 .. U+259F) by a
314	similar-looking ascii character.
315
316	=item digital-clock
317
318	Displays a digital clock using the built-in overlay.
319
320	=item remote-clipboard
321
322	Somewhat of a misnomer, this extension adds two menu entries to the
323	selection popup that allows one ti run external commands to store the
324	selection somewhere and fetch it again.
325
326	We use it to implement a "distributed selection mechanism", which just
327	means that one command uploads the file to a remote server, and another
328	reads it.
329
330	The commands can be set using the C<URxvt.remote-selection.store> and
331	C<URxvt.remote-selection.fetch> resources. The first should read the
332	selection to store from STDIN (always in UTF-8), the second should provide
333	the selection data on STDOUT (also in UTF-8).
334
335	The defaults (which are likely useless to you) use rsh and cat:
336
337	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
338	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
339
340	=item selection-pastebin
341
342	This is a little rarely useful extension that Uploads the selection as
343	textfile to a remote site (or does other things). (The implementation is
344	not currently secure for use in a multiuser environment as it writes to
345	F</tmp> directly.).
346
347	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
348	i.e.
349
350	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
351
352	Pressing this combination runs a command with C<%> replaced by the name of
353	the textfile. This command can be set via a resource:
354
355	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
356
357	And the default is likely not useful to anybody but the few people around
358	here :)
359
360	The name of the textfile is the hex encoded md5 sum of the selection, so
361	the same content should lead to the same filename.
362
363	After a successful upload the selection will be replaced by the text given
364	in the C<selection-pastebin-url> resource (again, the % is the placeholder
365	for the filename):
366
367	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
368
369	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
370	the double C</> characters as comment start. Use C<\057\057> instead,
371	which works regardless of wether xrdb is used to parse the resource file
372	or not.
373
374	=item example-refresh-hooks
375
376	Displays a very simple digital clock in the upper right corner of the
377	window. Illustrates overwriting the refresh callbacks to create your own
378	overlays or changes.
379
380	=back
381		50
382	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
383		52
384	=head2 General API Considerations	53	=head2 General API Considerations
385		54
…		…
399		68
400	=over 4	69	=over 4
401		70
402	=item $text	71	=item $text
403		72
404	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
405	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.
406		75
407	=item $string	76	=item $string
408		77
409	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
…		…
413	=item $octets	82	=item $octets
414		83
415	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
416	locale-specific way.	85	locale-specific way.
417		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
418	=back	93	=back
419		94
420	=head2 Extension Objects	95	=head2 Extension Objects
421		96
422	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
423	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,
424	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
425	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
426	extensions or other terminals, with the exception of methods and members	101	extensions or other terminals, with the exception of methods and members
427	that begin with an underscore character C<_>: these are reserved for	102	that begin with an underscore character C<_>: these are reserved for
428	internal use.	103	internal use.
429		104
430	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
431	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
432		107
433	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
434		109	the C<urxvt::extension> section below.
435	=over 4
436
437	=item $urxvt_term = $self->{term}
438
439	Returns the C<urxvt::term> object associated with this instance of the
440	extension. This member I<must not> be changed in any way.
441
442	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
443
444	Dynamically enable the given hooks (named without the C<on_> prefix) for
445	this extension, replacing any previous hook. This is useful when you want
446	to overwrite time-critical hooks only temporarily.
447
448	=item $self->disable ($hook_name[, $hook_name..])
449
450	Dynamically disable the given hooks.
451
452	=back
453		110
454	=head2 Hooks	111	=head2 Hooks
455		112
456	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
457	called whenever the relevant event happens.	114	called whenever the relevant event happens.
…		…
543		200
544	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,
545	$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
546	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
547		204
548	=item on_osc_seq $term, $op, $args	205	=item on_osc_seq $term, $op, $args, $resp
549		206
550	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
551	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
552	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
553	confused by recursive invocations when you output an osc sequence within	210	confused by recursive invocations when you output an OSC sequence within
554	this callback.	211	this callback.
555		212
556	C<on_osc_seq_perl> should be used for new behaviour.	213	C<on_osc_seq_perl> should be used for new behaviour.
557		214
558	=item on_osc_seq_perl $term, $string	215	=item on_osc_seq_perl $term, $args, $resp
559		216
560	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
561	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
562	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
563	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,
564	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
565	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	}
566		233
567	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,
568	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
569	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.
570		240
571	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
572		242
573	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
574	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
…		…
579	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
580		250
581	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
582	suppress or filter tty input.	252	suppress or filter tty input.
583		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
584	=item on_line_update $term, $row	261	=item on_line_update $term, $row
585		262
586	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
587	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
588	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,
…		…
595	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
596	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
597		274
598	=item on_refresh_begin $term	275	=item on_refresh_begin $term
599		276
600	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
601	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
602	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
603	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
604		281
605	=item on_refresh_end $term	282	=item on_refresh_end $term
606		283
607	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>.
608		285
609	=item on_user_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
610		287
611	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
612	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>
613	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
614		291
615	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
616	slightly in the future.	293	preference to the C<< ->register_keysym_action >> method.
617		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
618	=item on_resize_all_windows $tern, $new_width, $new_height	302	=item on_resize_all_windows $term, $new_width, $new_height
619		303
620	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
621	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
622	returns TRUE, setting of the window hints is being skipped.	306	returns a true value, setting of the window hints is being skipped.
623		307
624	=item on_x_event $term, $event	308	=item on_x_event $term, $event
625		309
626	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
627	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
…		…
657		341
658	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
659		343
660	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
661		345
662	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
663	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.
664		348
665	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
666	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
667	(real, not screen-based) row and column under the mouse cursor.	351	(real, not screen-based) row and column under the mouse cursor.
668		352
669	C<on_key_press> additionally receives the string rxvt-unicode would	353	C<on_key_press> additionally receives the string rxvt-unicode would
670	output, if any, in locale-specific encoding.	354	output, if any, in locale-specific encoding.
671		355
672	subwindow.
673
674	=item on_client_message $term, $event	356	=item on_client_message $term, $event
675		357
676	=item on_wm_protocols $term, $event	358	=item on_wm_protocols $term, $event
677		359
678	=item on_wm_delete_window $term, $event	360	=item on_wm_delete_window $term, $event
679		361
680	Called when various types of ClientMessage events are received (all with	362	Called when various types of ClientMessage events are received (all with
681	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	363	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
682		364
		365	=item on_bell $term
		366
		367	Called on receipt of a bell character.
		368
683	=back	369	=back
684		370
685	=cut	371	=cut
686		372
687	package urxvt;	373	package urxvt;
688		374
689	use utf8;	375	use utf8;
690	use strict;	376	use strict 'vars';
691	use Carp ();	377	use Carp ();
692	use Scalar::Util ();	378	use Scalar::Util ();
693	use List::Util ();	379	use List::Util ();
694		380
695	our $VERSION = 1;	381	our $VERSION = 1;
696	our $TERM;	382	our $TERM;
697	our @TERM_INIT;	383	our @TERM_INIT; # should go, prevents async I/O etc.
698	our @TERM_EXT;	384	our @TERM_EXT; # should go, prevents async I/O etc.
699	our @HOOKNAME;	385	our @HOOKNAME;
700	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	386	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
701	our %OPTION;	387	our %OPTION;
702		388
703	our $LIBDIR;	389	our $LIBDIR;
…		…
751		437
752	=over 4	438	=over 4
753		439
754	=item urxvt::fatal $errormessage	440	=item urxvt::fatal $errormessage
755		441
756	Fatally aborts execution with the given error message. Avoid at all	442	Fatally aborts execution with the given error message (which should
757	costs! The only time this is acceptable is when the terminal process	443	include a trailing newline). Avoid at all costs! The only time this
758	starts up.	444	is acceptable (and useful) is in the init hook, where it prevents the
		445	terminal from starting up.
759		446
760	=item urxvt::warn $string	447	=item urxvt::warn $string
761		448
762	Calls C<rxvt_warn> with the given string which should not include a	449	Calls C<rxvt_warn> with the given string which should include a trailing
763	newline. The module also overwrites the C<warn> builtin with a function	450	newline. The module also overwrites the C<warn> builtin with a function
764	that calls this function.	451	that calls this function.
765		452
766	Using this function has the advantage that its output ends up in the	453	Using this function has the advantage that its output ends up in the
767	correct place, e.g. on stderr of the connecting urxvtc client.	454	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
771	=item @terms = urxvt::termlist	458	=item @terms = urxvt::termlist
772		459
773	Returns all urxvt::term objects that exist in this process, regardless of	460	Returns all urxvt::term objects that exist in this process, regardless of
774	whether they are started, being destroyed etc., so be careful. Only term	461	whether they are started, being destroyed etc., so be careful. Only term
775	objects that have perl extensions attached will be returned (because there	462	objects that have perl extensions attached will be returned (because there
776	is no urxvt::term objet associated with others).	463	is no urxvt::term object associated with others).
777		464
778	=item $time = urxvt::NOW	465	=item $time = urxvt::NOW
779		466
780	Returns the "current time" (as per the event loop).	467	Returns the "current time" (as per the event loop).
781		468
…		…
824		511
825	=item $rend = urxvt::OVERLAY_RSTYLE	512	=item $rend = urxvt::OVERLAY_RSTYLE
826		513
827	Return the rendition mask used for overlays by default.	514	Return the rendition mask used for overlays by default.
828		515
829	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	516	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		517	urxvt::RS_RVid, urxvt::RS_Uline
830		518
831	Return the bit that enabled bold, italic, blink, reverse-video and	519	Return the bit that enabled bold, italic, blink, reverse-video and
832	underline, respectively. To enable such a style, just logically OR it into	520	underline, respectively. To enable such a style, just logically OR it into
833	the bitset.	521	the bitset.
834		522
…		…
871	};	559	};
872	}	560	}
873		561
874	no warnings 'utf8';	562	no warnings 'utf8';
875		563
		564	sub parse_resource {
		565	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		566
		567	$name =~ y/-/./ if $isarg;
		568
		569	$term->scan_meta;
		570
		571	my $r = $term->{meta}{resource};
		572	keys %$r; # reset iterator
		573	while (my ($pattern, $v) = each %$r) {
		574	if (
		575	$pattern =~ /\.$/
		576	? $pattern eq substr $name, 0, length $pattern
		577	: $pattern eq $name
		578	) {
		579	$name = "$urxvt::RESCLASS.$name";
		580
		581	push @{ $term->{perl_ext_3} }, $v->[0];
		582
		583	if ($v->[1] eq "boolean") {
		584	$term->put_option_db ($name, $flag ? "true" : "false");
		585	return 1;
		586	} else {
		587	$term->put_option_db ($name, $value);
		588	return 1 + 2;
		589	}
		590	}
		591	}
		592
		593	0
		594	}
		595
		596	sub usage {
		597	my ($term, $usage_type) = @_;
		598
		599	$term->scan_meta;
		600
		601	my $r = $term->{meta}{resource};
		602
		603	for my $pattern (sort keys %$r) {
		604	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		605
		606	$desc .= " (-pe $ext)";
		607
		608	if ($usage_type == 1) {
		609	$pattern =~ y/./-/;
		610	$pattern =~ s/-$/-.../g;
		611
		612	if ($type eq "boolean") {
		613	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		614	} else {
		615	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		616	}
		617	} else {
		618	$pattern =~ s/\.$/.*/g;
		619	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		620	}
		621	}
		622	}
		623
876	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	624	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
877		625
878	sub verbose {	626	sub verbose {
879	my ($level, $msg) = @_;	627	my ($level, $msg) = @_;
880	warn "$msg\n" if $level <= $verbosity;	628	warn "$msg\n" if $level <= $verbosity;
…		…
892	$pkg =~ s/[^[:word:]]/_/g;	640	$pkg =~ s/[^[:word:]]/_/g;
893	$pkg = "urxvt::ext::$pkg";	641	$pkg = "urxvt::ext::$pkg";
894		642
895	verbose 3, "loading extension '$path' into package '$pkg'";	643	verbose 3, "loading extension '$path' into package '$pkg'";
896		644
		645	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		646
897	open my $fh, "<:raw", $path	647	open my $fh, "<:raw", $path
898	or die "$path: $!";	648	or die "$path: $!";
899		649
900	my $source =	650	my $source =
901	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	651	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
902	. "#line 1 \"$path\"\n{\n"	652	. "#line 1 \"$path\"\n{\n"
903	. (do { local $/; <$fh> })	653	. (do { local $/; <$fh> })
904	. "\n};\n1";	654	. "\n};\n1";
905		655
906	eval $source	656	eval $source
…		…
915	# called by the rxvt core	665	# called by the rxvt core
916	sub invoke {	666	sub invoke {
917	local $TERM = shift;	667	local $TERM = shift;
918	my $htype = shift;	668	my $htype = shift;
919		669
920	if ($htype == 0) { # INIT	670	if ($htype == HOOK_INIT) {
921	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	671	my @dirs = $TERM->perl_libdirs;
922		672
923	my %ext_arg;	673	my %ext_arg;
924		674
925	{	675	{
926	my @init = @TERM_INIT;	676	my @init = @TERM_INIT;
927	@TERM_INIT = ();	677	@TERM_INIT = ();
…		…
929	my @pkg = @TERM_EXT;	679	my @pkg = @TERM_EXT;
930	@TERM_EXT = ();	680	@TERM_EXT = ();
931	$TERM->register_package ($_) for @pkg;	681	$TERM->register_package ($_) for @pkg;
932	}	682	}
933		683
		684	for (
		685	@{ delete $TERM->{perl_ext_3} },
934	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	686	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		687	) {
935	if ($_ eq "default") {	688	if ($_ eq "default") {
936	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	689	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
937	} elsif (/^-(.*)$/) {	690	} elsif (/^-(.*)$/) {
938	delete $ext_arg{$1};	691	delete $ext_arg{$1};
939	} elsif (/^([^<]+)<(.*)>$/) {	692	} elsif (/^([^<]+)<(.*)>$/) {
…		…
961		714
962	if (my $cb = $TERM->{_hook}[$htype]) {	715	if (my $cb = $TERM->{_hook}[$htype]) {
963	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	716	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
964	if $verbosity >= 10;	717	if $verbosity >= 10;
965		718
966	for my $pkg (keys %$cb) {	719	for my $pkg (
		720	# this hook is only sent to the extension with the name
		721	# matching the first arg
		722	$htype == HOOK_KEYBOARD_DISPATCH
		723	? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
		724	: keys %$cb
		725	) {
967	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	726	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
968	$retval ||= $retval_;	727	$retval ||= $retval_;
969		728
970	if ($@) {	729	if ($@) {
971	$TERM->ungrab; # better to lose the grab than the session	730	$TERM->ungrab; # better to lose the grab than the session
972	warn $@;	731	warn $@;
…		…
975		734
976	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	735	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
977	if $verbosity >= 11;	736	if $verbosity >= 11;
978	}	737	}
979		738
980	if ($htype == 1) { # DESTROY	739	if ($htype == HOOK_DESTROY) {
981	# clear package objects	740	# clear package objects
982	%$_ = () for values %{ $TERM->{_pkg} };	741	%$_ = () for values %{ $TERM->{_pkg} };
983		742
984	# clear package	743	# clear package
985	%$TERM = ();	744	%$TERM = ();
…		…
990		749
991	sub SET_COLOR($$$) {	750	sub SET_COLOR($$$) {
992	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	751	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
993	}	752	}
994		753
995	# urxvt::term::extension	754	sub rend2mask {
		755	no strict 'refs';
		756	my ($str, $mask) = (@_, 0);
		757	my %color = ( fg => undef, bg => undef );
		758	my @failed;
		759	for my $spec ( split /\s+/, $str ) {
		760	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		761	$color{lc($1)} = $2;
		762	} else {
		763	my $neg = $spec =~ s/^[-^]//;
		764	unless ( exists &{"RS_$spec"} ) {
		765	push @failed, $spec;
		766	next;
		767	}
		768	my $cur = &{"RS_$spec"};
		769	if ( $neg ) {
		770	$mask &= ~$cur;
		771	} else {
		772	$mask |= $cur;
		773	}
		774	}
		775	}
		776	($mask, @color{qw(fg bg)}, \@failed)
		777	}
996		778
997	package urxvt::term::extension;	779	package urxvt::term::extension;
998		780
999	sub enable {	781	=head2 The C<urxvt::term::extension> class
1000	my ($self, %hook) = @_;
1001	my $pkg = $self->{_pkg};
1002		782
1003	while (my ($name, $cb) = each %hook) {	783	Each extension attached to a terminal object is represented by
1004	my $htype = $HOOKTYPE{uc $name};	784	a C<urxvt::term::extension> object.
1005	defined $htype
1006	or Carp::croak "unsupported hook type '$name'";
1007		785
1008	$self->set_should_invoke ($htype, +1)	786	You can use these objects, which are passed to all callbacks to store any
1009	unless exists $self->{term}{_hook}[$htype]{$pkg};	787	state related to the terminal and extension instance.
1010		788
1011	$self->{term}{_hook}[$htype]{$pkg} = $cb;	789	The methods (And data members) documented below can be called on extension
1012	}	790	objects, in addition to call methods documented for the <urxvt::term>
1013	}	791	class.
1014		792
1015	sub disable {	793	=over 4
1016	my ($self, @hook) = @_;
1017	my $pkg = $self->{_pkg};
1018		794
1019	for my $name (@hook) {	795	=item $urxvt_term = $self->{term}
1020	my $htype = $HOOKTYPE{uc $name};
1021	defined $htype
1022	or Carp::croak "unsupported hook type '$name'";
1023		796
1024	$self->set_should_invoke ($htype, -1)	797	Returns the C<urxvt::term> object associated with this instance of the
1025	if delete $self->{term}{_hook}[$htype]{$pkg};	798	extension. This member I<must not> be changed in any way.
1026	}	799
1027	}	800	=cut
1028		801
1029	our $AUTOLOAD;	802	our $AUTOLOAD;
1030		803
1031	sub AUTOLOAD {	804	sub AUTOLOAD {
1032	$AUTOLOAD =~ /:([^:]+)$/	805	$AUTOLOAD =~ /:([^:]+)$/
…		…
1045		818
1046	sub DESTROY {	819	sub DESTROY {
1047	# nop	820	# nop
1048	}	821	}
1049		822
1050	# urxvt::destroy_hook	823	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1051		824
1052	sub urxvt::destroy_hook::DESTROY {	825	sub urxvt::destroy_hook::DESTROY {
1053	${$_[0]}->();	826	${$_[0]}->();
1054	}	827	}
1055		828
1056	sub urxvt::destroy_hook(&) {	829	sub urxvt::destroy_hook(&) {
1057	bless \shift, urxvt::destroy_hook::	830	bless \shift, urxvt::destroy_hook::
1058	}	831	}
		832
		833	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		834
		835	Dynamically enable the given hooks (named without the C<on_> prefix) for
		836	this extension, replacing any hook previously installed via C<enable> in
		837	this extension.
		838
		839	This is useful when you want to overwrite time-critical hooks only
		840	temporarily.
		841
		842	To install additional callbacks for the same hook, you can use the C<on>
		843	method of the C<urxvt::term> class.
		844
		845	=item $self->disable ($hook_name[, $hook_name..])
		846
		847	Dynamically disable the given hooks.
		848
		849	=cut
		850
		851	sub enable {
		852	my ($self, %hook) = @_;
		853	my $pkg = $self->{_pkg};
		854
		855	while (my ($name, $cb) = each %hook) {
		856	my $htype = $HOOKTYPE{uc $name};
		857	defined $htype
		858	or Carp::croak "unsupported hook type '$name'";
		859
		860	$self->set_should_invoke ($htype, +1)
		861	unless exists $self->{term}{_hook}[$htype]{$pkg};
		862
		863	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		864	}
		865	}
		866
		867	sub disable {
		868	my ($self, @hook) = @_;
		869	my $pkg = $self->{_pkg};
		870
		871	for my $name (@hook) {
		872	my $htype = $HOOKTYPE{uc $name};
		873	defined $htype
		874	or Carp::croak "unsupported hook type '$name'";
		875
		876	$self->set_should_invoke ($htype, -1)
		877	if delete $self->{term}{_hook}[$htype]{$pkg};
		878	}
		879	}
		880
		881	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		882
		883	Similar to the C<enable> enable, but installs additional callbacks for
		884	the given hook(s) (that is, it doesn't replace existing callbacks), and
		885	returns a guard object. When the guard object is destroyed the callbacks
		886	are disabled again.
		887
		888	=cut
		889
		890	sub urxvt::extension::on_disable::DESTROY {
		891	my $disable = shift;
		892
		893	my $term = delete $disable->{""};
		894
		895	while (my ($htype, $id) = each %$disable) {
		896	delete $term->{_hook}[$htype]{$id};
		897	$term->set_should_invoke ($htype, -1);
		898	}
		899	}
		900
		901	sub on {
		902	my ($self, %hook) = @_;
		903
		904	my $term = $self->{term};
		905
		906	my %disable = ( "" => $term );
		907
		908	while (my ($name, $cb) = each %hook) {
		909	my $htype = $HOOKTYPE{uc $name};
		910	defined $htype
		911	or Carp::croak "unsupported hook type '$name'";
		912
		913	$term->set_should_invoke ($htype, +1);
		914	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		915	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		916	}
		917
		918	bless \%disable, "urxvt::extension::on_disable"
		919	}
		920
		921	=item $self->x_resource ($pattern)
		922
		923	=item $self->x_resource_boolean ($pattern)
		924
		925	These methods support an additional C<%> prefix when called on an
		926	extension object - see the description of these methods in the
		927	C<urxvt::term> class for details.
		928
		929	=cut
		930
		931	sub x_resource {
		932	my ($self, $name) = @_;
		933	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		934	$self->{term}->x_resource ($name)
		935	}
		936
		937	sub x_resource_boolean {
		938	my ($self, $name) = @_;
		939	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		940	$self->{term}->x_resource_boolean ($name)
		941	}
		942
		943	=back
		944
		945	=cut
1059		946
1060	package urxvt::anyevent;	947	package urxvt::anyevent;
1061		948
1062	=head2 The C<urxvt::anyevent> Class	949	=head2 The C<urxvt::anyevent> Class
1063		950
1064	The sole purpose of this class is to deliver an interface to the	951	The sole purpose of this class is to deliver an interface to the
1065	C<AnyEvent> module - any module using it will work inside urxvt without	952	C<AnyEvent> module - any module using it will work inside urxvt without
1066	further programming. The only exception is that you cannot wait on	953	further programming. The only exception is that you cannot wait on
1067	condition variables, but non-blocking condvar use is ok. What this means	954	condition variables, but non-blocking condvar use is ok.
1068	is that you cannot use blocking APIs, but the non-blocking variant should
1069	work.
1070		955
1071	=cut	956	In practical terms this means is that you cannot use blocking APIs, but
		957	the non-blocking variant should work.
1072		958
		959	=cut
		960
1073	our $VERSION = 1;	961	our $VERSION = '5.23';
1074		962
1075	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	963	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1076	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	964	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1077		965
1078	sub timer {	966	sub timer {
…		…
1080		968
1081	my $cb = $arg{cb};	969	my $cb = $arg{cb};
1082		970
1083	urxvt::timer	971	urxvt::timer
1084	->new	972	->new
1085	->start (urxvt::NOW + $arg{after})	973	->after ($arg{after}, $arg{interval})
1086	->cb (sub {	974	->cb ($arg{interval} ? $cb : sub {
1087	$_[0]->stop; # need to cancel manually	975	$_[0]->stop; # need to cancel manually
1088	$cb->();	976	$cb->();
1089	})	977	})
1090	}	978	}
1091		979
1092	sub io {	980	sub io {
1093	my ($class, %arg) = @_;	981	my ($class, %arg) = @_;
1094		982
1095	my $cb = $arg{cb};	983	my $cb = $arg{cb};
		984	my $fd = fileno $arg{fh};
		985	defined $fd or $fd = $arg{fh};
1096		986
1097	bless [$arg{fh}, urxvt::iow	987	bless [$arg{fh}, urxvt::iow
1098	->new	988	->new
1099	->fd (fileno $arg{fh})	989	->fd ($fd)
1100	->events (($arg{poll} =~ /r/ ? 1 : 0)	990	->events (($arg{poll} =~ /r/ ? 1 : 0)
1101	| ($arg{poll} =~ /w/ ? 2 : 0))	991	| ($arg{poll} =~ /w/ ? 2 : 0))
1102	->start	992	->start
1103	->cb (sub {	993	->cb ($cb)
1104	$cb->(($_[1] & 1 ? 'r' : '')
1105	. ($_[1] & 2 ? 'w' : ''));
1106	})],
1107	urxvt::anyevent::	994	], urxvt::anyevent::
		995	}
		996
		997	sub idle {
		998	my ($class, %arg) = @_;
		999
		1000	my $cb = $arg{cb};
		1001
		1002	urxvt::iw
		1003	->new
		1004	->start
		1005	->cb ($cb)
		1006	}
		1007
		1008	sub child {
		1009	my ($class, %arg) = @_;
		1010
		1011	my $cb = $arg{cb};
		1012
		1013	urxvt::pw
		1014	->new
		1015	->start ($arg{pid})
		1016	->cb (sub {
		1017	$_[0]->stop; # need to cancel manually
		1018	$cb->($_[0]->rpid, $_[0]->rstatus);
		1019	})
1108	}	1020	}
1109		1021
1110	sub DESTROY {	1022	sub DESTROY {
1111	$_[0][1]->stop;	1023	$_[0][1]->stop;
1112	}	1024	}
1113		1025
1114	sub condvar {	1026	# only needed for AnyEvent < 6 compatibility
1115	bless \my $flag, urxvt::anyevent::condvar::	1027	sub one_event {
1116	}
1117
1118	sub urxvt::anyevent::condvar::broadcast {
1119	${$_[0]}++;
1120	}
1121
1122	sub urxvt::anyevent::condvar::wait {
1123	unless (${$_[0]}) {
1124	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1028	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1125	}
1126	}	1029	}
1127		1030
1128	package urxvt::term;	1031	package urxvt::term;
1129		1032
1130	=head2 The C<urxvt::term> Class	1033	=head2 The C<urxvt::term> Class
…		…
1143	urxvt::verbose 6, "register package $pkg to $self";	1046	urxvt::verbose 6, "register package $pkg to $self";
1144		1047
1145	@{"$pkg\::ISA"} = urxvt::term::extension::;	1048	@{"$pkg\::ISA"} = urxvt::term::extension::;
1146		1049
1147	my $proxy = bless {	1050	my $proxy = bless {
1148	_pkg => $pkg,	1051	_pkg => $pkg,
		1052	_name => ${"$pkg\::_NAME"}, # hackish
1149	argv => $argv,	1053	argv => $argv,
1150	}, $pkg;	1054	}, $pkg;
1151	Scalar::Util::weaken ($proxy->{term} = $self);	1055	Scalar::Util::weaken ($proxy->{term} = $self);
1152		1056
1153	$self->{_pkg}{$pkg} = $proxy;	1057	$self->{_pkg}{$pkg} = $proxy;
1154		1058
…		…
1157	$proxy->enable ($name => $ref);	1061	$proxy->enable ($name => $ref);
1158	}	1062	}
1159	}	1063	}
1160	}	1064	}
1161		1065
		1066	sub perl_libdirs {
		1067	map { split /:/ }
		1068	$_[0]->resource ("perl_lib"),
		1069	$ENV{URXVT_PERL_LIB},
		1070	"$ENV{HOME}/.urxvt/ext",
		1071	"$LIBDIR/perl"
		1072	}
		1073
		1074	sub scan_meta {
		1075	my ($self) = @_;
		1076	my @libdirs = perl_libdirs $self;
		1077
		1078	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1079
		1080	my %meta;
		1081
		1082	$self->{meta_libdirs} = join "\x00", @libdirs;
		1083	$self->{meta} = \%meta;
		1084
		1085	for my $dir (reverse @libdirs) {
		1086	opendir my $fh, $dir
		1087	or next;
		1088	for my $ext (readdir $fh) {
		1089	$ext !~ /^\./
		1090	and open my $fh, "<", "$dir/$ext"
		1091	or next;
		1092
		1093	while (<$fh>) {
		1094	if (/^#:META:X_RESOURCE:(.*)/) {
		1095	my ($pattern, $type, $desc) = split /:/, $1;
		1096	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1097	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1098	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1099	} else {
		1100	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1101	}
		1102	} elsif (/^\s*(?:#|$)/) {
		1103	# skip other comments and empty lines
		1104	} else {
		1105	last; # stop parsing on first non-empty non-comment line
		1106	}
		1107	}
		1108	}
		1109	}
		1110	}
		1111
1162	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1112	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1163		1113
1164	Creates a new terminal, very similar as if you had started it with system	1114	Creates a new terminal, very similar as if you had started it with system
1165	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1115	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1166	hash which defines the environment of the new terminal.	1116	hash which defines the environment of the new terminal.
…		…
1183	}	1133	}
1184		1134
1185	=item $term->destroy	1135	=item $term->destroy
1186		1136
1187	Destroy the terminal object (close the window, free resources	1137	Destroy the terminal object (close the window, free resources
1188	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1138	etc.). Please note that urxvt will not exit as long as any event
1189	watchers (timers, io watchers) are still active.	1139	watchers (timers, io watchers) are still active.
1190		1140
1191	=item $term->exec_async ($cmd[, @args])	1141	=item $term->exec_async ($cmd[, @args])
1192		1142
1193	Works like the combination of the C<fork>/C<exec> builtins, which executes	1143	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1220	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1170	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1221		1171
1222	Here is a likely non-exhaustive list of option names, please see the	1172	Here is a likely non-exhaustive list of option names, please see the
1223	source file F</src/optinc.h> to see the actual list:	1173	source file F</src/optinc.h> to see the actual list:
1224		1174
1225	borderLess console cursorBlink cursorUnderline hold iconic insecure	1175	borderLess buffered console cursorBlink cursorUnderline hold iconic
1226	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1176	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1227	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1177	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1228	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1178	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1229	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1179	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1230	transparent tripleclickwords utmpInhibit visualBell	1180	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1181	urgentOnBell utmpInhibit visualBell
1231		1182
1232	=item $value = $term->resource ($name[, $newval])	1183	=item $value = $term->resource ($name[, $newval])
1233		1184
1234	Returns the current resource value associated with a given name and	1185	Returns the current resource value associated with a given name and
1235	optionally sets a new value. Setting values is most useful in the C<init>	1186	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1248		1199
1249	Here is a likely non-exhaustive list of resource names, not all of which	1200	Here is a likely non-exhaustive list of resource names, not all of which
1250	are supported in every build, please see the source file F</src/rsinc.h>	1201	are supported in every build, please see the source file F</src/rsinc.h>
1251	to see the actual list:	1202	to see the actual list:
1252		1203
1253	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1204	answerbackstring backgroundPixmap backspace_key blurradius
1254	borderLess color cursorBlink cursorUnderline cutchars delete_key	1205	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1255	display_name embed ext_bwidth fade font geometry hold iconName	1206	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1256	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1207	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1208	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1257	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1209	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1258	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1210	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1259	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1211	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1260	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1212	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1261	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1213	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1262	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1214	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1263	secondaryScreen secondaryScroll selectstyle shade term_name title	1215	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1264	transient_for transparent transparent_all tripleclickwords utmpInhibit	1216	term_name title transient_for transparent tripleclickwords urgentOnBell
1265	visualBell	1217	utmpInhibit visualBell
1266		1218
1267	=cut	1219	=cut
1268		1220
1269	sub resource($$;$) {	1221	sub resource($$;$) {
1270	my ($self, $name) = (shift, shift);	1222	my ($self, $name) = (shift, shift);
1271	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1223	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1272	&urxvt::term::_resource	1224	goto &urxvt::term::_resource
1273	}	1225	}
1274		1226
1275	=item $value = $term->x_resource ($pattern)	1227	=item $value = $term->x_resource ($pattern)
1276		1228
1277	Returns the X-Resource for the given pattern, excluding the program or	1229	Returns the X-Resource for the given pattern, excluding the program or
1278	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1230	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1279	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1231	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1280	resource with that pattern exists.	1232	resource with that pattern exists.
1281		1233
		1234	Extensions that define extra resource or command line arguments also need
		1235	to call this method to access their values.
		1236
		1237	If the method is called on an extension object (basically, from an
		1238	extension), then the special prefix C<%.> will be replaced by the name of
		1239	the extension and a dot, and the lone string C<%> will be replaced by the
		1240	extension name itself. This makes it possible to code extensions so you
		1241	can rename them and get a new set of commandline switches and resources
		1242	without having to change the actual code.
		1243
1282	This method should only be called during the C<on_start> hook, as there is	1244	This method should only be called during the C<on_start> hook, as there is
1283	only one resource database per display, and later invocations might return	1245	only one resource database per display, and later invocations might return
1284	the wrong resources.	1246	the wrong resources.
1285		1247
1286	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1248	=item $value = $term->x_resource_boolean ($pattern)
1287		1249
		1250	Like C<x_resource>, above, but interprets the string value as a boolean
		1251	and returns C<1> for true values, C<0> for false values and C<undef> if
		1252	the resource or option isn't specified.
		1253
		1254	You should always use this method to parse boolean resources.
		1255
		1256	=cut
		1257
		1258	sub x_resource_boolean {
		1259	my $res = &x_resource;
		1260
		1261	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1262	}
		1263
		1264	=item $success = $term->parse_keysym ($key, $octets)
		1265
1288	Adds a keymap translation exactly as specified via a resource. See the	1266	Adds a key binding exactly as specified via a resource. See the
1289	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1267	C<keysym> resource in the urxvt(1) manpage.
		1268
		1269	=item $term->register_command ($keysym, $modifiermask, $string)
		1270
		1271	Adds a key binding. This is a lower level api compared to
		1272	C<parse_keysym>, as it expects a parsed key description, and can be
		1273	used only inside either the C<on_init> hook, to add a binding, or the
		1274	C<on_register_command> hook, to modify a parsed binding.
1290		1275
1291	=item $rend = $term->rstyle ([$new_rstyle])	1276	=item $rend = $term->rstyle ([$new_rstyle])
1292		1277
1293	Return and optionally change the current rendition. Text that is output by	1278	Return and optionally change the current rendition. Text that is output by
1294	the terminal application will use this style.	1279	the terminal application will use this style.
…		…
1302		1287
1303	=item ($row, $col) = $term->selection_beg ([$row, $col])	1288	=item ($row, $col) = $term->selection_beg ([$row, $col])
1304		1289
1305	=item ($row, $col) = $term->selection_end ([$row, $col])	1290	=item ($row, $col) = $term->selection_end ([$row, $col])
1306		1291
1307	Return the current values of the selection mark, begin or end positions,	1292	Return the current values of the selection mark, begin or end positions.
1308	and optionally set them to new values.	1293
		1294	When arguments are given, then the selection coordinates are set to
		1295	C<$row> and C<$col>, and the selection screen is set to the current
		1296	screen.
		1297
		1298	=item $screen = $term->selection_screen ([$screen])
		1299
		1300	Returns the current selection screen, and then optionally sets it.
1309		1301
1310	=item $term->selection_make ($eventtime[, $rectangular])	1302	=item $term->selection_make ($eventtime[, $rectangular])
1311		1303
1312	Tries to make a selection as set by C<selection_beg> and	1304	Tries to make a selection as set by C<selection_beg> and
1313	C<selection_end>. If C<$rectangular> is true (default: false), a	1305	C<selection_end>. If C<$rectangular> is true (default: false), a
1314	rectangular selection will be made. This is the prefered function to make	1306	rectangular selection will be made. This is the preferred function to make
1315	a selection.	1307	a selection.
1316		1308
1317	=item $success = $term->selection_grab ($eventtime)	1309	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1318		1310
1319	Try to request the primary selection text from the server (for example, as	1311	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1312	true) selection from the server. The corresponding text can be set
1320	set by the next method). No visual feedback will be given. This function	1313	with the next method. No visual feedback will be given. This function
1321	is mostly useful from within C<on_sel_grab> hooks.	1314	is mostly useful from within C<on_sel_grab> hooks.
1322		1315
1323	=item $oldtext = $term->selection ([$newtext])	1316	=item $oldtext = $term->selection ([$newtext, $clipboard])
1324		1317
1325	Return the current selection text and optionally replace it by C<$newtext>.	1318	Return the current selection (clipboard if C<$clipboard> is true) text
		1319	and optionally replace it by C<$newtext>.
		1320
		1321	=item $term->selection_clear ([$clipboard])
		1322
		1323	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1326		1324
1327	=item $term->overlay_simple ($x, $y, $text)	1325	=item $term->overlay_simple ($x, $y, $text)
1328		1326
1329	Create a simple multi-line overlay box. See the next method for details.	1327	Create a simple multi-line overlay box. See the next method for details.
1330		1328
…		…
1360		1358
1361	The methods currently supported on C<urxvt::overlay> objects are:	1359	The methods currently supported on C<urxvt::overlay> objects are:
1362		1360
1363	=over 4	1361	=over 4
1364		1362
1365	=item $overlay->set ($x, $y, $text, $rend)	1363	=item $overlay->set ($x, $y, $text[, $rend])
1366		1364
1367	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1365	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1368	text in rxvt-unicode's special encoding and an array of rendition values	1366	text in rxvt-unicode's special encoding and an array of rendition values
1369	at a specific position inside the overlay.	1367	at a specific position inside the overlay.
		1368
		1369	If C<$rend> is missing, then the rendition will not be changed.
1370		1370
1371	=item $overlay->hide	1371	=item $overlay->hide
1372		1372
1373	If visible, hide the overlay, but do not destroy it.	1373	If visible, hide the overlay, but do not destroy it.
1374		1374
…		…
1456	locale-specific encoding of the terminal and can contain command sequences	1456	locale-specific encoding of the terminal and can contain command sequences
1457	(escape codes) that will be interpreted.	1457	(escape codes) that will be interpreted.
1458		1458
1459	=item $term->tt_write ($octets)	1459	=item $term->tt_write ($octets)
1460		1460
1461	Write the octets given in C<$data> to the tty (i.e. as program input). To	1461	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1462	pass characters instead of octets, you should convert your strings first	1462	pass characters instead of octets, you should convert your strings first
1463	to the locale-specific encoding using C<< $term->locale_encode >>.	1463	to the locale-specific encoding using C<< $term->locale_encode >>.
		1464
		1465	=item $term->tt_paste ($octets)
		1466
		1467	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1468	CR and bracketing the data with control sequences if bracketed paste mode
		1469	is set.
1464		1470
1465	=item $old_events = $term->pty_ev_events ([$new_events])	1471	=item $old_events = $term->pty_ev_events ([$new_events])
1466		1472
1467	Replaces the event mask of the pty watcher by the given event mask. Can	1473	Replaces the event mask of the pty watcher by the given event mask. Can
1468	be used to suppress input and output handling to the pty/tty. See the	1474	be used to suppress input and output handling to the pty/tty. See the
…		…
1487	Adds the specified events to the vt event mask. Useful e.g. when you want	1493	Adds the specified events to the vt event mask. Useful e.g. when you want
1488	to receive pointer events all the times:	1494	to receive pointer events all the times:
1489		1495
1490	$term->vt_emask_add (urxvt::PointerMotionMask);	1496	$term->vt_emask_add (urxvt::PointerMotionMask);
1491		1497
		1498	=item $term->set_urgency ($set)
		1499
		1500	Enable/disable the urgency hint on the toplevel window.
		1501
1492	=item $term->focus_in	1502	=item $term->focus_in
1493		1503
1494	=item $term->focus_out	1504	=item $term->focus_out
1495		1505
1496	=item $term->key_press ($state, $keycode[, $time])	1506	=item $term->key_press ($state, $keycode[, $time])
…		…
1584		1594
1585	Used after changing terminal contents to display them.	1595	Used after changing terminal contents to display them.
1586		1596
1587	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1597	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1588		1598
1589	Returns the text of the entire row with number C<$row_number>. Row C<0>	1599	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1590	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1600	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1591	terminal line. The scrollback buffer starts at line C<-1> and extends to
1592	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1601	terminal line. Nothing will be returned if a nonexistent line
1593	is requested.	1602	is requested.
1594		1603
1595	If C<$new_text> is specified, it will replace characters in the current	1604	If C<$new_text> is specified, it will replace characters in the current
1596	line, starting at column C<$start_col> (default C<0>), which is useful	1605	line, starting at column C<$start_col> (default C<0>), which is useful
1597	to replace only parts of a line. The font index in the rendition will	1606	to replace only parts of a line. The font index in the rendition will
1598	automatically be updated.	1607	automatically be updated.
1599		1608
1600	C<$text> is in a special encoding: tabs and wide characters that use more	1609	C<$text> is in a special encoding: tabs and wide characters that use more
1601	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1610	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1602	characters. Characters with combining characters and other characters that	1611	characters. Characters with combining characters and other characters that
1603	do not fit into the normal tetx encoding will be replaced with characters	1612	do not fit into the normal text encoding will be replaced with characters
1604	in the private use area.	1613	in the private use area.
1605		1614
1606	You have to obey this encoding when changing text. The advantage is	1615	You have to obey this encoding when changing text. The advantage is
1607	that C<substr> and similar functions work on screen cells and not on	1616	that C<substr> and similar functions work on screen cells and not on
1608	characters.	1617	characters.
…		…
1693	}	1702	}
1694		1703
1695	sub urxvt::line::t {	1704	sub urxvt::line::t {
1696	my ($self) = @_;	1705	my ($self) = @_;
1697		1706
1698	if (@_ > 1)	1707	if (@_ > 1) {
1699	{
1700	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1708	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1701	for $self->{beg} .. $self->{end};	1709	for $self->{beg} .. $self->{end};
1702	}	1710	}
1703		1711
1704	defined wantarray &&	1712	defined wantarray &&
1705	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1713	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1706	0, $self->{len}	1714	0, $self->{len}
1707	}	1715	}
1708		1716
1709	sub urxvt::line::r {	1717	sub urxvt::line::r {
1710	my ($self) = @_;	1718	my ($self) = @_;
1711		1719
1712	if (@_ > 1)	1720	if (@_ > 1) {
1713	{
1714	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1721	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1715	for $self->{beg} .. $self->{end};	1722	for $self->{beg} .. $self->{end};
1716	}	1723	}
1717		1724
1718	if (defined wantarray) {	1725	if (defined wantarray) {
1719	my $rend = [	1726	my $rend = [
1720	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1727	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1721	];	1728	];
…		…
1783	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1790	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1784	recent grab.	1791	recent grab.
1785		1792
1786	=item $term->ungrab	1793	=item $term->ungrab
1787		1794
1788	Calls XUngrab for the most recent grab. Is called automatically on	1795	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1789	evaluation errors, as it is better to lose the grab in the error case as	1796	evaluation errors, as it is better to lose the grab in the error case as
1790	the session.	1797	the session.
1791		1798
1792	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1799	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1793		1800
…		…
1795		1802
1796	=item @atoms = $term->XListProperties ($window)	1803	=item @atoms = $term->XListProperties ($window)
1797		1804
1798	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1805	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1799		1806
1800	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1807	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1801		1808
1802	=item $term->XDeleteProperty ($window, $property)	1809	=item $term->XDeleteProperty ($window, $property)
1803		1810
1804	=item $window = $term->DefaultRootWindow	1811	=item $window = $term->DefaultRootWindow
1805		1812
…		…
1812	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1819	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1813		1820
1814	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1821	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1815		1822
1816	=item $term->XChangeInput ($window, $add_events[, $del_events])	1823	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1824
		1825	=item $keysym = $term->XStringToKeysym ($string)
		1826
		1827	=item $string = $term->XKeysymToString ($keysym)
1817		1828
1818	Various X or X-related functions. The C<$term> object only serves as	1829	Various X or X-related functions. The C<$term> object only serves as
1819	the source of the display, otherwise those functions map more-or-less	1830	the source of the display, otherwise those functions map more-or-less
1820	directory onto the X functions of the same name.	1831	directly onto the X functions of the same name.
1821		1832
1822	=back	1833	=back
1823		1834
1824	=cut	1835	=cut
1825		1836
…		…
1927	my $env = $self->{term}->env;	1938	my $env = $self->{term}->env;
1928	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1939	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1929	delete $env->{LC_ALL};	1940	delete $env->{LC_ALL};
1930	$env->{LC_CTYPE} = $self->{term}->locale;	1941	$env->{LC_CTYPE} = $self->{term}->locale;
1931		1942
1932	urxvt::term->new ($env, "popup",	1943	my $term = urxvt::term->new (
		1944	$env, "popup",
1933	"--perl-lib" => "", "--perl-ext-common" => "",	1945	"--perl-lib" => "", "--perl-ext-common" => "",
1934	"-pty-fd" => -1, "-sl" => 0,	1946	"-pty-fd" => -1, "-sl" => 0,
1935	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1947	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1936	"--transient-for" => $self->{term}->parent,	1948	"--transient-for" => $self->{term}->parent,
1937	"-display" => $self->{term}->display_id,	1949	"-display" => $self->{term}->display_id,
1938	"-pe" => "urxvt-popup")	1950	"-pe" => "urxvt-popup",
1939	or die "unable to create popup window\n";	1951	) or die "unable to create popup window\n";
		1952
		1953	unless (delete $term->{urxvt_popup_init_done}) {
		1954	$term->ungrab;
		1955	$term->destroy;
		1956	die "unable to initialise popup window\n";
		1957	}
1940	}	1958	}
1941		1959
1942	sub DESTROY {	1960	sub DESTROY {
1943	my ($self) = @_;	1961	my ($self) = @_;
1944		1962
…		…
1949	=back	1967	=back
1950		1968
1951	=cut	1969	=cut
1952		1970
1953	package urxvt::watcher;	1971	package urxvt::watcher;
1954
1955	@urxvt::timer::ISA = __PACKAGE__;
1956	@urxvt::iow::ISA = __PACKAGE__;
1957	@urxvt::pw::ISA = __PACKAGE__;
1958	@urxvt::iw::ISA = __PACKAGE__;
1959		1972
1960	=head2 The C<urxvt::timer> Class	1973	=head2 The C<urxvt::timer> Class
1961		1974
1962	This class implements timer watchers/events. Time is represented as a	1975	This class implements timer watchers/events. Time is represented as a
1963	fractional number of seconds since the epoch. Example:	1976	fractional number of seconds since the epoch. Example:
…		…
1967	->new	1980	->new
1968	->interval (1)	1981	->interval (1)
1969	->cb (sub {	1982	->cb (sub {
1970	$term->{overlay}->set (0, 0,	1983	$term->{overlay}->set (0, 0,
1971	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1984	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1972	});	1985	});
1973		1986
1974	=over 4	1987	=over 4
1975		1988
1976	=item $timer = new urxvt::timer	1989	=item $timer = new urxvt::timer
1977		1990
…		…
1980		1993
1981	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1994	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1982		1995
1983	Set the callback to be called when the timer triggers.	1996	Set the callback to be called when the timer triggers.
1984		1997
1985	=item $tstamp = $timer->at
1986
1987	Return the time this watcher will fire next.
1988
1989	=item $timer = $timer->set ($tstamp)	1998	=item $timer = $timer->set ($tstamp[, $interval])
1990		1999
1991	Set the time the event is generated to $tstamp.	2000	Set the time the event is generated to $tstamp (and optionally specifies a
		2001	new $interval).
1992		2002
1993	=item $timer = $timer->interval ($interval)	2003	=item $timer = $timer->interval ($interval)
1994		2004
1995	Normally (and when C<$interval> is C<0>), the timer will automatically	2005	By default (and when C<$interval> is C<0>), the timer will automatically
1996	stop after it has fired once. If C<$interval> is non-zero, then the timer	2006	stop after it has fired once. If C<$interval> is non-zero, then the timer
1997	is automatically rescheduled at the given intervals.	2007	is automatically rescheduled at the given intervals.
1998		2008
1999	=item $timer = $timer->start	2009	=item $timer = $timer->start
2000		2010
2001	Start the timer.	2011	Start the timer.
2002		2012
2003	=item $timer = $timer->start ($tstamp)	2013	=item $timer = $timer->start ($tstamp[, $interval])
2004		2014
2005	Set the event trigger time to C<$tstamp> and start the timer.	2015	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2016	also replaces the interval.
2006		2017
2007	=item $timer = $timer->after ($delay)	2018	=item $timer = $timer->after ($delay[, $interval])
2008		2019
2009	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2020	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2010		2021
2011	=item $timer = $timer->stop	2022	=item $timer = $timer->stop
2012		2023
…		…
2020		2031
2021	$term->{socket} = ...	2032	$term->{socket} = ...
2022	$term->{iow} = urxvt::iow	2033	$term->{iow} = urxvt::iow
2023	->new	2034	->new
2024	->fd (fileno $term->{socket})	2035	->fd (fileno $term->{socket})
2025	->events (urxvt::EVENT_READ)	2036	->events (urxvt::EV_READ)
2026	->start	2037	->start
2027	->cb (sub {	2038	->cb (sub {
2028	my ($iow, $revents) = @_;	2039	my ($iow, $revents) = @_;
2029	# $revents must be 1 here, no need to check	2040	# $revents must be 1 here, no need to check
2030	sysread $term->{socket}, my $buf, 8192	2041	sysread $term->{socket}, my $buf, 8192
…		…
2048	Set the file descriptor (not handle) to watch.	2059	Set the file descriptor (not handle) to watch.
2049		2060
2050	=item $iow = $iow->events ($eventmask)	2061	=item $iow = $iow->events ($eventmask)
2051		2062
2052	Set the event mask to watch. The only allowed values are	2063	Set the event mask to watch. The only allowed values are
2053	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2064	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2054	together, or C<urxvt::EVENT_NONE>.	2065	together, or C<urxvt::EV_NONE>.
2055		2066
2056	=item $iow = $iow->start	2067	=item $iow = $iow->start
2057		2068
2058	Start watching for requested events on the given handle.	2069	Start watching for requested events on the given handle.
2059		2070
…		…
2100	->new	2111	->new
2101	->start ($pid)	2112	->start ($pid)
2102	->cb (sub {	2113	->cb (sub {
2103	my ($pw, $exit_status) = @_;	2114	my ($pw, $exit_status) = @_;
2104	...	2115	...
2105	});	2116	});
2106		2117
2107	=over 4	2118	=over 4
2108		2119
2109	=item $pw = new urxvt::pw	2120	=item $pw = new urxvt::pw
2110		2121
…		…
2143		2154
2144	=back	2155	=back
2145		2156
2146	=head1 AUTHOR	2157	=head1 AUTHOR
2147		2158
2148	Marc Lehmann <pcg@goof.com>	2159	Marc Lehmann <schmorp@schmorp.de>
2149	http://software.schmorp.de/pkg/rxvt-unicode	2160	http://software.schmorp.de/pkg/rxvt-unicode
2150		2161
2151	=cut	2162	=cut
2152		2163
2153	1	2164	1
		2165
		2166	# vim: sw=3:

Diff Legend

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