ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC vs.
Revision 1.233 by sf-exg, Fri May 2 20:34:24 2014 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Every time a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions that add command line parameters or resources on their own are
45		49	loaded automatically when used.
46	=item selection (enabled by default)
47
48	(More) intelligent selection. This extension tries to be more intelligent
49	when the user extends selections (double-click and further clicks). Right
50	now, it tries to select words, urls and complete shell-quoted
51	arguments, which is very convenient, too, if your F<ls> supports
52	C<--quoting-style=shell>.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72	Another example: Programs I use often output "absolute path: " at the
73	beginning of a line when they process multiple files. The following
74	pattern matches the filename (note, there is a single space at the very
75	end):
76
77	URxvt.selection.pattern-0: ^(/[^:]+):\
78
79	You can look at the source of the selection extension to see more
80	interesting uses, such as parsing a line from beginning to end.
81
82	This extension also offers following bindable keyboard commands:
83
84	=over 4
85
86	=item rot13
87
88	Rot-13 the selection when activated. Used via keyboard trigger:
89
90	URxvt.keysym.C-M-r: perl:selection:rot13
91
92	=back
93
94	=item option-popup (enabled by default)
95
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.
98
99	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.
102
103	It's sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as
107	first argument.
108
109	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:
111
112	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};
115
116	=item selection-popup (enabled by default)
117
118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119	text into various other formats/action (such as uri unescaping, perl
120	evaluation, web-browser starting etc.), depending on content.
121
122	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.
125
126	It's sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide whether to add something or not.
128	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.
131
132	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:
135
136	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }
138	: ()
139	};
140
141	=item searchable-scrollback<hotkey> (enabled by default)
142
143	Adds regex search functionality to the scrollback buffer, triggered
144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
145	input/output is suspended and a regex is displayed at the bottom of the
146	screen.
147
148	Inputting characters appends them to the regex and continues incremental
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary
154	selection.
155
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.
159
160	See L<perlre> for more info about perl regular expression syntax.
161
162	=item readline (enabled by default)
163
164	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to
166	move the text cursor to this position. It does so by generating as many
167	cursor-left or cursor-right keypresses as required (the this only works
168	for programs that correctly support wide characters).
169
170	To avoid too many false positives, this is only done when:
171
172	=over 4
173
174	=item - the tty is in ICANON state.
175
176	=item - the text cursor is visible.
177
178	=item - the primary screen is currently being displayed.
179
180	=item - the mouse is on the same (multi-row-) line as the text cursor.
181
182	=back
183
184	The normal selection mechanism isn't disabled, so quick successive clicks
185	might interfere with selection creation in harmless ways.
186
187	=item selection-autotransform
188
189	This selection allows you to do automatic transforms on a selection
190	whenever a selection is made.
191
192	It works by specifying perl snippets (most useful is a single C<s///>
193	operator) that modify C<$_> as resources:
194
195	URxvt.selection-autotransform.0: transform
196	URxvt.selection-autotransform.1: transform
197	...
198
199	For example, the following will transform selections of the form
200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
201	$word>:
202
203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
204
205	And this example matches the same,but replaces it with vi-commands you can
206	paste directly into your (vi :) editor:
207
208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
209
210	Of course, this can be modified to suit your needs and your editor :)
211
212	To expand the example above to typical perl error messages ("XXX at
213	FILENAME line YYY."), you need a slightly more elaborate solution:
214
215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
217
218	The first line tells the selection code to treat the unchanging part of
219	every error message as a selection pattern, and the second line transforms
220	the message into vi commands to load the file.
221
222	=item tabbed
223
224	This transforms the terminal into a tabbar with additional terminals, that
225	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227	button per tab.
228
229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
230	B<Shift-Right> will switch to the tab left or right of the current one,
231	while B<Shift-Down> creates a new tab.
232
233	The tabbar itself can be configured similarly to a normal terminal, but
234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
235	following four resources (shown with defaults):
236
237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239	URxvt.tabbed.tab-fg: <colour-index, default 0>
240	URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243	indices.
244
245	=item mark-urls
246
247	Uses per-line display filtering (C<on_line_update>) to underline urls and
248	make them clickable. When middle-clicked, the program specified in the
249	resource C<urlLauncher> (default C<x-www-browser>) will be started with
250	the URL as first argument.
251
252	=item xim-onthespot
253
254	This (experimental) perl extension implements OnTheSpot editing. It does
255	not work perfectly, and some input methods don't seem to work well with
256	OnTheSpot editing in general, but it seems to work at leats for SCIM and
257	kinput2.
258
259	You enable it by specifying this extension and a preedit style of
260	C<OnTheSpot>, i.e.:
261
262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263
264	=item kuake<hotkey>
265
266	A very primitive quake-console-like extension. It was inspired by a
267	description of how the programs C<kuake> and C<yakuake> work: Whenever the
268	user presses a global accelerator key (by default C<F10>), the terminal
269	will show or hide itself. Another press of the accelerator key will hide
270	or show it again.
271
272	Initially, the window will not be shown when using this extension.
273
274	This is useful if you need a single terminal thats not using any desktop
275	space most of the time but is quickly available at the press of a key.
276
277	The accelerator key is grabbed regardless of any modifiers, so this
278	extension will actually grab a physical key just for this function.
279
280	If you want a quake-like animation, tell your window manager to do so
281	(fvwm can do it).
282
283	=item automove-background
284
285	This is basically a very small extension that dynamically changes the
286	background pixmap offset to the window position, in effect creating the
287	same effect as pseudo transparency with a custom pixmap. No scaling is
288	supported in this mode. Example:
289
290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291
292	=item block-graphics-to-ascii
293
294	A not very useful example of filtering all text output to the terminal
295	by replacing all line-drawing characters (U+2500 .. U+259F) by a
296	similar-looking ascii character.
297
298	=item digital-clock
299
300	Displays a digital clock using the built-in overlay.
301
302	=item remote-clipboard
303
304	Somewhat of a misnomer, this extension adds two menu entries to the
305	selection popup that allows one ti run external commands to store the
306	selection somewhere and fetch it again.
307
308	We use it to implement a "distributed selection mechanism", which just
309	means that one command uploads the file to a remote server, and another
310	reads it.
311
312	The commands can be set using the C<URxvt.remote-selection.store> and
313	C<URxvt.remote-selection.fetch> resources. The first should read the
314	selection to store from STDIN (always in UTF-8), the second should provide
315	the selection data on STDOUT (also in UTF-8).
316
317	The defaults (which are likely useless to you) use rsh and cat:
318
319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321
322	=item selection-pastebin
323
324	This is a little rarely useful extension that Uploads the selection as
325	textfile to a remote site (or does other things). (The implementation is
326	not currently secure for use in a multiuser environment as it writes to
327	F</tmp> directly.).
328
329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
330	i.e.
331
332	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
333
334	Pressing this combination runs a command with C<%> replaced by the name of
335	the textfile. This command can be set via a resource:
336
337	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
338
339	And the default is likely not useful to anybody but the few people around
340	here :)
341
342	The name of the textfile is the hex encoded md5 sum of the selection, so
343	the same content should lead to the same filename.
344
345	After a successful upload the selection will be replaced by the text given
346	in the C<selection-pastebin-url> resource (again, the % is the placeholder
347	for the filename):
348
349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350
351	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
352	the double C</> characters as comment start. Use C<\057\057> instead,
353	which works regardless of wether xrdb is used to parse the resource file
354	or not.
355
356	=item example-refresh-hooks
357
358	Displays a very simple digital clock in the upper right corner of the
359	window. Illustrates overwriting the refresh callbacks to create your own
360	overlays or changes.
361
362	=back
363		50
364	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
365		52
366	=head2 General API Considerations	53	=head2 General API Considerations
367		54
…		…
381		68
382	=over 4	69	=over 4
383		70
384	=item $text	71	=item $text
385		72
386	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
387	always represents one screen cell. See L<ROW_t> for a discussion of this format.	74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
388		75
389	=item $string	76	=item $string
390		77
391	A perl text string, with an emphasis on I<text>. It can store all unicode	78	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
395	=item $octets	82	=item $octets
396		83
397	Either binary data or - more common - a text string encoded in a	84	Either binary data or - more common - a text string encoded in a
398	locale-specific way.	85	locale-specific way.
399		86
		87	=item $keysym
		88
		89	an integer that is a valid X11 keysym code. You can convert a string
		90	into a keysym and viceversa by using C<XStringToKeysym> and
		91	C<XKeysymToString>.
		92
400	=back	93	=back
401		94
402	=head2 Extension Objects	95	=head2 Extension Objects
403		96
404	Every perl extension is a perl class. A separate perl object is created	97	Every perl extension is a perl class. A separate perl object is created
405	for each terminal, and each terminal has its own set of extenion objects,	98	for each terminal, and each terminal has its own set of extension objects,
406	which are passed as the first parameter to hooks. So extensions can use	99	which are passed as the first parameter to hooks. So extensions can use
407	their C<$self> object without having to think about clashes with other	100	their C<$self> object without having to think about clashes with other
408	extensions or other terminals, with the exception of methods and members	101	extensions or other terminals, with the exception of methods and members
409	that begin with an underscore character C<_>: these are reserved for	102	that begin with an underscore character C<_>: these are reserved for
410	internal use.	103	internal use.
411		104
412	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
413	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
414		107
415	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
416		109	the C<urxvt::extension> section below.
417	=over 4
418
419	=item $urxvt_term = $self->{term}
420
421	Returns the C<urxvt::term> object associated with this instance of the
422	extension. This member I<must not> be changed in any way.
423
424	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
425
426	Dynamically enable the given hooks (named without the C<on_> prefix) for
427	this extension, replacing any previous hook. This is useful when you want
428	to overwrite time-critical hooks only temporarily.
429
430	=item $self->disable ($hook_name[, $hook_name..])
431
432	Dynamically disable the given hooks.
433
434	=back
435		110
436	=head2 Hooks	111	=head2 Hooks
437		112
438	The following subroutines can be declared in extension files, and will be	113	The following subroutines can be declared in extension files, and will be
439	called whenever the relevant event happens.	114	called whenever the relevant event happens.
…		…
525		200
526	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
527	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
528	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
529		204
530	=item on_osc_seq $term, $op, $args	205	=item on_osc_seq $term, $op, $args, $resp
531		206
532	Called on every OSC sequence and can be used to suppress it or modify its	207	Called on every OSC sequence and can be used to suppress it or modify its
533	behaviour. The default should be to return an empty list. A true value	208	behaviour. The default should be to return an empty list. A true value
534	suppresses execution of the request completely. Make sure you don't get	209	suppresses execution of the request completely. Make sure you don't get
535	confused by recursive invocations when you output an osc sequence within	210	confused by recursive invocations when you output an OSC sequence within
536	this callback.	211	this callback.
537		212
538	C<on_osc_seq_perl> should be used for new behaviour.	213	C<on_osc_seq_perl> should be used for new behaviour.
539		214
540	=item on_osc_seq_perl $term, $string	215	=item on_osc_seq_perl $term, $args, $resp
541		216
542	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
543	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
544	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
545	string should start with the extension name and a colon, to distinguish	220	string should start with the extension name (sans -osc) and a semicolon,
546	it from commands for other extensions, and this might be enforced in the	221	to distinguish it from commands for other extensions, and this might be
547	future.	222	enforced in the future.
		223
		224	For example, C<overlay-osc> uses this:
		225
		226	sub on_osc_seq_perl {
		227	my ($self, $osc, $resp) = @_;
		228
		229	return unless $osc =~ s/^overlay;//;
		230
		231	... process remaining $osc string
		232	}
548		233
549	Be careful not ever to trust (in a security sense) the data you receive,	234	Be careful not ever to trust (in a security sense) the data you receive,
550	as its source can not easily be controlled (e-mail content, messages from	235	as its source can not easily be controlled (e-mail content, messages from
551	other users on the same system etc.).	236	other users on the same system etc.).
		237
		238	For responses, C<$resp> contains the end-of-args separator used by the
		239	sender.
552		240
553	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
554		242
555	Called whenever text is about to be output, with the text as argument. You	243	Called whenever text is about to be output, with the text as argument. You
556	can filter/change and output the text yourself by returning a true value	244	can filter/change and output the text yourself by returning a true value
…		…
561	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
562		250
563	Called whenever some data is written to the tty/pty and can be used to	251	Called whenever some data is written to the tty/pty and can be used to
564	suppress or filter tty input.	252	suppress or filter tty input.
565		253
		254	=item on_tt_paste $term, $octets
		255
		256	Called whenever text is about to be pasted, with the text as argument. You
		257	can filter/change and paste the text yourself by returning a true value
		258	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		259	locale-encoded.
		260
566	=item on_line_update $term, $row	261	=item on_line_update $term, $row
567		262
568	Called whenever a line was updated or changed. Can be used to filter	263	Called whenever a line was updated or changed. Can be used to filter
569	screen output (e.g. underline urls or other useless stuff). Only lines	264	screen output (e.g. underline urls or other useless stuff). Only lines
570	that are being shown will be filtered, and, due to performance reasons,	265	that are being shown will be filtered, and, due to performance reasons,
…		…
577	later with the already-modified line (e.g. if unrelated parts change), so	272	later with the already-modified line (e.g. if unrelated parts change), so
578	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
579		274
580	=item on_refresh_begin $term	275	=item on_refresh_begin $term
581		276
582	Called just before the screen gets redrawn. Can be used for overlay	277	Called just before the screen gets redrawn. Can be used for overlay or
583	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
584	restoring them in refresh_end. The built-in overlay and selection display	279	restoring them in refresh_end. The built-in overlay and selection display
585	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
586		281
587	=item on_refresh_end $term	282	=item on_refresh_end $term
588		283
589	Called just after the screen gets redrawn. See C<on_refresh_begin>.	284	Called just after the screen gets redrawn. See C<on_refresh_begin>.
590		285
591	=item on_user_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
592		287
593	Called whenever a user-configured event is being activated (e.g. via	288	Called whenever a user-configured event is being activated (e.g. via
594	a C<perl:string> action bound to a key, see description of the B<keysym>	289	a C<perl:string> action bound to a key, see description of the B<keysym>
595	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
596		291
597	The event is simply the action string. This interface is assumed to change	292	The event is simply the action string. This interface is going away in
598	slightly in the future.	293	preference to the C<< ->register_keysym_action >> method.
599		294
600	=item on_resize_all_windows $tern, $new_width, $new_height	295	=item on_resize_all_windows $term, $new_width, $new_height
601		296
602	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
603	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
604	returns TRUE, setting of the window hints is being skipped.	299	returns a true value, setting of the window hints is being skipped.
605		300
606	=item on_x_event $term, $event	301	=item on_x_event $term, $event
607		302
608	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
609	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
…		…
639		334
640	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
641		336
642	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
643		338
644	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
645	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.
646		341
647	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
648	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
649	(real, not screen-based) row and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
650		345
651	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
652	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
653		348
654	subwindow.
655
656	=item on_client_message $term, $event	349	=item on_client_message $term, $event
657		350
658	=item on_wm_protocols $term, $event	351	=item on_wm_protocols $term, $event
659		352
660	=item on_wm_delete_window $term, $event	353	=item on_wm_delete_window $term, $event
661		354
662	Called when various types of ClientMessage events are received (all with	355	Called when various types of ClientMessage events are received (all with
663	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	356	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
664		357
		358	=item on_bell $term
		359
		360	Called on receipt of a bell character.
		361
665	=back	362	=back
666		363
667	=cut	364	=cut
668		365
669	package urxvt;	366	package urxvt;
670		367
671	use utf8;	368	use utf8;
672	use strict;	369	use strict 'vars';
673	use Carp ();	370	use Carp ();
674	use Scalar::Util ();	371	use Scalar::Util ();
675	use List::Util ();	372	use List::Util ();
676		373
677	our $VERSION = 1;	374	our $VERSION = 1;
678	our $TERM;	375	our $TERM;
679	our @TERM_INIT;	376	our @TERM_INIT; # should go, prevents async I/O etc.
680	our @TERM_EXT;	377	our @TERM_EXT; # should go, prevents async I/O etc.
681	our @HOOKNAME;	378	our @HOOKNAME;
682	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
683	our %OPTION;	380	our %OPTION;
684		381
685	our $LIBDIR;	382	our $LIBDIR;
…		…
733		430
734	=over 4	431	=over 4
735		432
736	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
737		434
738	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
739	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
740	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
741		439
742	=item urxvt::warn $string	440	=item urxvt::warn $string
743		441
744	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
745	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
746	that calls this function.	444	that calls this function.
747		445
748	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
749	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
753	=item @terms = urxvt::termlist	451	=item @terms = urxvt::termlist
754		452
755	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
756	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
757	objects that have perl extensions attached will be returned (because there	455	objects that have perl extensions attached will be returned (because there
758	is no urxvt::term objet associated with others).	456	is no urxvt::term object associated with others).
759		457
760	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
761		459
762	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
763		461
…		…
806		504
807	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
808		506
809	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
810		508
811	=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
812		511
813	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
814	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
815	the bitset.	514	the bitset.
816		515
…		…
853	};	552	};
854	}	553	}
855		554
856	no warnings 'utf8';	555	no warnings 'utf8';
857		556
		557	sub parse_resource {
		558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		559
		560	$name =~ y/-/./ if $isarg;
		561
		562	$term->scan_meta;
		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_meta;
		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
858	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
859		618
860	sub verbose {	619	sub verbose {
861	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
862	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
…		…
874	$pkg =~ s/[^[:word:]]/_/g;	633	$pkg =~ s/[^[:word:]]/_/g;
875	$pkg = "urxvt::ext::$pkg";	634	$pkg = "urxvt::ext::$pkg";
876		635
877	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
878		637
		638	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		639
879	open my $fh, "<:raw", $path	640	open my $fh, "<:raw", $path
880	or die "$path: $!";	641	or die "$path: $!";
881		642
882	my $source =	643	my $source =
883	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	644	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
884	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
885	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
886	. "\n};\n1";	647	. "\n};\n1";
887		648
888	eval $source	649	eval $source
…		…
897	# called by the rxvt core	658	# called by the rxvt core
898	sub invoke {	659	sub invoke {
899	local $TERM = shift;	660	local $TERM = shift;
900	my $htype = shift;	661	my $htype = shift;
901		662
902	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
903	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = $TERM->perl_libdirs;
904		665
905	my %ext_arg;	666	my %ext_arg;
906		667
907	{	668	{
908	my @init = @TERM_INIT;	669	my @init = @TERM_INIT;
909	@TERM_INIT = ();	670	@TERM_INIT = ();
…		…
911	my @pkg = @TERM_EXT;	672	my @pkg = @TERM_EXT;
912	@TERM_EXT = ();	673	@TERM_EXT = ();
913	$TERM->register_package ($_) for @pkg;	674	$TERM->register_package ($_) for @pkg;
914	}	675	}
915		676
		677	for (
		678	@{ delete $TERM->{perl_ext_3} },
916	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	679	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		680	) {
917	if ($_ eq "default") {	681	if ($_ eq "default") {
918	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	682	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
919	} elsif (/^-(.*)$/) {	683	} elsif (/^-(.*)$/) {
920	delete $ext_arg{$1};	684	delete $ext_arg{$1};
921	} elsif (/^([^<]+)<(.*)>$/) {	685	} elsif (/^([^<]+)<(.*)>$/) {
…		…
943		707
944	if (my $cb = $TERM->{_hook}[$htype]) {	708	if (my $cb = $TERM->{_hook}[$htype]) {
945	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	709	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
946	if $verbosity >= 10;	710	if $verbosity >= 10;
947		711
948	for my $pkg (keys %$cb) {	712	for my $pkg (
		713	# this hook is only sent to the extension with the name
		714	# matching the first arg
		715	$htype == HOOK_KEYBOARD_DISPATCH
		716	? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
		717	: keys %$cb
		718	) {
949	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	719	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
950	$retval ||= $retval_;	720	$retval ||= $retval_;
951		721
952	if ($@) {	722	if ($@) {
953	$TERM->ungrab; # better to lose the grab than the session	723	$TERM->ungrab; # better to lose the grab than the session
954	warn $@;	724	warn $@;
…		…
957		727
958	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	728	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
959	if $verbosity >= 11;	729	if $verbosity >= 11;
960	}	730	}
961		731
962	if ($htype == 1) { # DESTROY	732	if ($htype == HOOK_DESTROY) {
963	# clear package objects	733	# clear package objects
964	%$_ = () for values %{ $TERM->{_pkg} };	734	%$_ = () for values %{ $TERM->{_pkg} };
965		735
966	# clear package	736	# clear package
967	%$TERM = ();	737	%$TERM = ();
…		…
972		742
973	sub SET_COLOR($$$) {	743	sub SET_COLOR($$$) {
974	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	744	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
975	}	745	}
976		746
977	# urxvt::term::extension	747	sub rend2mask {
		748	no strict 'refs';
		749	my ($str, $mask) = (@_, 0);
		750	my %color = ( fg => undef, bg => undef );
		751	my @failed;
		752	for my $spec ( split /\s+/, $str ) {
		753	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		754	$color{lc($1)} = $2;
		755	} else {
		756	my $neg = $spec =~ s/^[-^]//;
		757	unless ( exists &{"RS_$spec"} ) {
		758	push @failed, $spec;
		759	next;
		760	}
		761	my $cur = &{"RS_$spec"};
		762	if ( $neg ) {
		763	$mask &= ~$cur;
		764	} else {
		765	$mask |= $cur;
		766	}
		767	}
		768	}
		769	($mask, @color{qw(fg bg)}, \@failed)
		770	}
978		771
979	package urxvt::term::extension;	772	package urxvt::term::extension;
980		773
981	sub enable {	774	=head2 The C<urxvt::term::extension> class
982	my ($self, %hook) = @_;
983	my $pkg = $self->{_pkg};
984		775
985	while (my ($name, $cb) = each %hook) {	776	Each extension attached to a terminal object is represented by
986	my $htype = $HOOKTYPE{uc $name};	777	a C<urxvt::term::extension> object.
987	defined $htype
988	or Carp::croak "unsupported hook type '$name'";
989		778
990	$self->set_should_invoke ($htype, +1)	779	You can use these objects, which are passed to all callbacks to store any
991	unless exists $self->{term}{_hook}[$htype]{$pkg};	780	state related to the terminal and extension instance.
992		781
993	$self->{term}{_hook}[$htype]{$pkg} = $cb;	782	The methods (And data members) documented below can be called on extension
994	}	783	objects, in addition to call methods documented for the <urxvt::term>
995	}	784	class.
996		785
997	sub disable {	786	=over 4
998	my ($self, @hook) = @_;
999	my $pkg = $self->{_pkg};
1000		787
1001	for my $name (@hook) {	788	=item $urxvt_term = $self->{term}
1002	my $htype = $HOOKTYPE{uc $name};
1003	defined $htype
1004	or Carp::croak "unsupported hook type '$name'";
1005		789
1006	$self->set_should_invoke ($htype, -1)	790	Returns the C<urxvt::term> object associated with this instance of the
1007	if delete $self->{term}{_hook}[$htype]{$pkg};	791	extension. This member I<must not> be changed in any way.
1008	}	792
1009	}	793	=cut
1010		794
1011	our $AUTOLOAD;	795	our $AUTOLOAD;
1012		796
1013	sub AUTOLOAD {	797	sub AUTOLOAD {
1014	$AUTOLOAD =~ /:([^:]+)$/	798	$AUTOLOAD =~ /:([^:]+)$/
…		…
1027		811
1028	sub DESTROY {	812	sub DESTROY {
1029	# nop	813	# nop
1030	}	814	}
1031		815
1032	# urxvt::destroy_hook	816	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1033		817
1034	sub urxvt::destroy_hook::DESTROY {	818	sub urxvt::destroy_hook::DESTROY {
1035	${$_[0]}->();	819	${$_[0]}->();
1036	}	820	}
1037		821
1038	sub urxvt::destroy_hook(&) {	822	sub urxvt::destroy_hook(&) {
1039	bless \shift, urxvt::destroy_hook::	823	bless \shift, urxvt::destroy_hook::
1040	}	824	}
		825
		826	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		827
		828	Dynamically enable the given hooks (named without the C<on_> prefix) for
		829	this extension, replacing any hook previously installed via C<enable> in
		830	this extension.
		831
		832	This is useful when you want to overwrite time-critical hooks only
		833	temporarily.
		834
		835	To install additional callbacks for the same hook, you can use the C<on>
		836	method of the C<urxvt::term> class.
		837
		838	=item $self->disable ($hook_name[, $hook_name..])
		839
		840	Dynamically disable the given hooks.
		841
		842	=cut
		843
		844	sub enable {
		845	my ($self, %hook) = @_;
		846	my $pkg = $self->{_pkg};
		847
		848	while (my ($name, $cb) = each %hook) {
		849	my $htype = $HOOKTYPE{uc $name};
		850	defined $htype
		851	or Carp::croak "unsupported hook type '$name'";
		852
		853	$self->set_should_invoke ($htype, +1)
		854	unless exists $self->{term}{_hook}[$htype]{$pkg};
		855
		856	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		857	}
		858	}
		859
		860	sub disable {
		861	my ($self, @hook) = @_;
		862	my $pkg = $self->{_pkg};
		863
		864	for my $name (@hook) {
		865	my $htype = $HOOKTYPE{uc $name};
		866	defined $htype
		867	or Carp::croak "unsupported hook type '$name'";
		868
		869	$self->set_should_invoke ($htype, -1)
		870	if delete $self->{term}{_hook}[$htype]{$pkg};
		871	}
		872	}
		873
		874	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		875
		876	Similar to the C<enable> enable, but installs additional callbacks for
		877	the given hook(s) (that is, it doesn't replace existing callbacks), and
		878	returns a guard object. When the guard object is destroyed the callbacks
		879	are disabled again.
		880
		881	=cut
		882
		883	sub urxvt::extension::on_disable::DESTROY {
		884	my $disable = shift;
		885
		886	my $term = delete $disable->{""};
		887
		888	while (my ($htype, $id) = each %$disable) {
		889	delete $term->{_hook}[$htype]{$id};
		890	$term->set_should_invoke ($htype, -1);
		891	}
		892	}
		893
		894	sub on {
		895	my ($self, %hook) = @_;
		896
		897	my $term = $self->{term};
		898
		899	my %disable = ( "" => $term );
		900
		901	while (my ($name, $cb) = each %hook) {
		902	my $htype = $HOOKTYPE{uc $name};
		903	defined $htype
		904	or Carp::croak "unsupported hook type '$name'";
		905
		906	$term->set_should_invoke ($htype, +1);
		907	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		908	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		909	}
		910
		911	bless \%disable, "urxvt::extension::on_disable"
		912	}
		913
		914	=item $self->x_resource ($pattern)
		915
		916	=item $self->x_resource_boolean ($pattern)
		917
		918	These methods support an additional C<%> prefix when called on an
		919	extension object - see the description of these methods in the
		920	C<urxvt::term> class for details.
		921
		922	=cut
		923
		924	sub x_resource {
		925	my ($self, $name) = @_;
		926	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		927	$self->{term}->x_resource ($name)
		928	}
		929
		930	sub x_resource_boolean {
		931	my ($self, $name) = @_;
		932	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		933	$self->{term}->x_resource_boolean ($name)
		934	}
		935
		936	=back
		937
		938	=cut
1041		939
1042	package urxvt::anyevent;	940	package urxvt::anyevent;
1043		941
1044	=head2 The C<urxvt::anyevent> Class	942	=head2 The C<urxvt::anyevent> Class
1045		943
1046	The sole purpose of this class is to deliver an interface to the	944	The sole purpose of this class is to deliver an interface to the
1047	C<AnyEvent> module - any module using it will work inside urxvt without	945	C<AnyEvent> module - any module using it will work inside urxvt without
1048	further programming. The only exception is that you cannot wait on	946	further programming. The only exception is that you cannot wait on
1049	condition variables, but non-blocking condvar use is ok. What this means	947	condition variables, but non-blocking condvar use is ok.
1050	is that you cannot use blocking APIs, but the non-blocking variant should
1051	work.
1052		948
1053	=cut	949	In practical terms this means is that you cannot use blocking APIs, but
		950	the non-blocking variant should work.
1054		951
		952	=cut
		953
1055	our $VERSION = 1;	954	our $VERSION = '5.23';
1056		955
1057	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	956	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1058	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	957	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1059		958
1060	sub timer {	959	sub timer {
…		…
1062		961
1063	my $cb = $arg{cb};	962	my $cb = $arg{cb};
1064		963
1065	urxvt::timer	964	urxvt::timer
1066	->new	965	->new
1067	->start (urxvt::NOW + $arg{after})	966	->after ($arg{after}, $arg{interval})
1068	->cb (sub {	967	->cb ($arg{interval} ? $cb : sub {
1069	$_[0]->stop; # need to cancel manually	968	$_[0]->stop; # need to cancel manually
1070	$cb->();	969	$cb->();
1071	})	970	})
1072	}	971	}
1073		972
1074	sub io {	973	sub io {
1075	my ($class, %arg) = @_;	974	my ($class, %arg) = @_;
1076		975
1077	my $cb = $arg{cb};	976	my $cb = $arg{cb};
		977	my $fd = fileno $arg{fh};
		978	defined $fd or $fd = $arg{fh};
1078		979
1079	bless [$arg{fh}, urxvt::iow	980	bless [$arg{fh}, urxvt::iow
1080	->new	981	->new
1081	->fd (fileno $arg{fh})	982	->fd ($fd)
1082	->events (($arg{poll} =~ /r/ ? 1 : 0)	983	->events (($arg{poll} =~ /r/ ? 1 : 0)
1083	| ($arg{poll} =~ /w/ ? 2 : 0))	984	| ($arg{poll} =~ /w/ ? 2 : 0))
1084	->start	985	->start
1085	->cb (sub {	986	->cb ($cb)
1086	$cb->(($_[1] & 1 ? 'r' : '')
1087	. ($_[1] & 2 ? 'w' : ''));
1088	})],
1089	urxvt::anyevent::	987	], urxvt::anyevent::
		988	}
		989
		990	sub idle {
		991	my ($class, %arg) = @_;
		992
		993	my $cb = $arg{cb};
		994
		995	urxvt::iw
		996	->new
		997	->start
		998	->cb ($cb)
		999	}
		1000
		1001	sub child {
		1002	my ($class, %arg) = @_;
		1003
		1004	my $cb = $arg{cb};
		1005
		1006	urxvt::pw
		1007	->new
		1008	->start ($arg{pid})
		1009	->cb (sub {
		1010	$_[0]->stop; # need to cancel manually
		1011	$cb->($_[0]->rpid, $_[0]->rstatus);
		1012	})
1090	}	1013	}
1091		1014
1092	sub DESTROY {	1015	sub DESTROY {
1093	$_[0][1]->stop;	1016	$_[0][1]->stop;
1094	}	1017	}
1095		1018
1096	sub condvar {	1019	# only needed for AnyEvent < 6 compatibility
1097	bless \my $flag, urxvt::anyevent::condvar::	1020	sub one_event {
1098	}
1099
1100	sub urxvt::anyevent::condvar::broadcast {
1101	${$_[0]}++;
1102	}
1103
1104	sub urxvt::anyevent::condvar::wait {
1105	unless (${$_[0]}) {
1106	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1021	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1107	}
1108	}	1022	}
1109		1023
1110	package urxvt::term;	1024	package urxvt::term;
1111		1025
1112	=head2 The C<urxvt::term> Class	1026	=head2 The C<urxvt::term> Class
…		…
1125	urxvt::verbose 6, "register package $pkg to $self";	1039	urxvt::verbose 6, "register package $pkg to $self";
1126		1040
1127	@{"$pkg\::ISA"} = urxvt::term::extension::;	1041	@{"$pkg\::ISA"} = urxvt::term::extension::;
1128		1042
1129	my $proxy = bless {	1043	my $proxy = bless {
1130	_pkg => $pkg,	1044	_pkg => $pkg,
		1045	_name => ${"$pkg\::_NAME"}, # hackish
1131	argv => $argv,	1046	argv => $argv,
1132	}, $pkg;	1047	}, $pkg;
1133	Scalar::Util::weaken ($proxy->{term} = $self);	1048	Scalar::Util::weaken ($proxy->{term} = $self);
1134		1049
1135	$self->{_pkg}{$pkg} = $proxy;	1050	$self->{_pkg}{$pkg} = $proxy;
1136		1051
…		…
1139	$proxy->enable ($name => $ref);	1054	$proxy->enable ($name => $ref);
1140	}	1055	}
1141	}	1056	}
1142	}	1057	}
1143		1058
		1059	sub perl_libdirs {
		1060	map { split /:/ }
		1061	$_[0]->resource ("perl_lib"),
		1062	$ENV{URXVT_PERL_LIB},
		1063	"$ENV{HOME}/.urxvt/ext",
		1064	"$LIBDIR/perl"
		1065	}
		1066
		1067	sub scan_meta {
		1068	my ($self) = @_;
		1069	my @libdirs = perl_libdirs $self;
		1070
		1071	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1072
		1073	my %meta;
		1074
		1075	$self->{meta_libdirs} = join "\x00", @libdirs;
		1076	$self->{meta} = \%meta;
		1077
		1078	for my $dir (reverse @libdirs) {
		1079	opendir my $fh, $dir
		1080	or next;
		1081	for my $ext (readdir $fh) {
		1082	$ext !~ /^\./
		1083	and open my $fh, "<", "$dir/$ext"
		1084	or next;
		1085
		1086	while (<$fh>) {
		1087	if (/^#:META:X_RESOURCE:(.*)/) {
		1088	my ($pattern, $type, $desc) = split /:/, $1;
		1089	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1090	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1091	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1092	} else {
		1093	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1094	}
		1095	} elsif (/^\s*(?:#|$)/) {
		1096	# skip other comments and empty lines
		1097	} else {
		1098	last; # stop parsing on first non-empty non-comment line
		1099	}
		1100	}
		1101	}
		1102	}
		1103	}
		1104
1144	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1105	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1145		1106
1146	Creates a new terminal, very similar as if you had started it with system	1107	Creates a new terminal, very similar as if you had started it with system
1147	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1108	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1148	hash which defines the environment of the new terminal.	1109	hash which defines the environment of the new terminal.
…		…
1165	}	1126	}
1166		1127
1167	=item $term->destroy	1128	=item $term->destroy
1168		1129
1169	Destroy the terminal object (close the window, free resources	1130	Destroy the terminal object (close the window, free resources
1170	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1131	etc.). Please note that urxvt will not exit as long as any event
1171	watchers (timers, io watchers) are still active.	1132	watchers (timers, io watchers) are still active.
1172		1133
1173	=item $term->exec_async ($cmd[, @args])	1134	=item $term->exec_async ($cmd[, @args])
1174		1135
1175	Works like the combination of the C<fork>/C<exec> builtins, which executes	1136	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1202	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1163	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1203		1164
1204	Here is a likely non-exhaustive list of option names, please see the	1165	Here is a likely non-exhaustive list of option names, please see the
1205	source file F</src/optinc.h> to see the actual list:	1166	source file F</src/optinc.h> to see the actual list:
1206		1167
1207	borderLess console cursorBlink cursorUnderline hold iconic insecure	1168	borderLess buffered console cursorBlink cursorUnderline hold iconic
1208	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1169	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1209	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1170	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1210	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1171	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1211	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1172	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1212	transparent tripleclickwords utmpInhibit visualBell	1173	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1174	urgentOnBell utmpInhibit visualBell
1213		1175
1214	=item $value = $term->resource ($name[, $newval])	1176	=item $value = $term->resource ($name[, $newval])
1215		1177
1216	Returns the current resource value associated with a given name and	1178	Returns the current resource value associated with a given name and
1217	optionally sets a new value. Setting values is most useful in the C<init>	1179	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1230		1192
1231	Here is a likely non-exhaustive list of resource names, not all of which	1193	Here is a likely non-exhaustive list of resource names, not all of which
1232	are supported in every build, please see the source file F</src/rsinc.h>	1194	are supported in every build, please see the source file F</src/rsinc.h>
1233	to see the actual list:	1195	to see the actual list:
1234		1196
1235	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1197	answerbackstring backgroundPixmap backspace_key blurradius
1236	borderLess color cursorBlink cursorUnderline cutchars delete_key	1198	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1237	display_name embed ext_bwidth fade font geometry hold iconName	1199	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1238	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1200	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1201	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1239	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1202	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1240	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1203	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1241	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1204	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1242	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1205	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1243	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1206	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1244	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1207	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1245	secondaryScreen secondaryScroll selectstyle shade term_name title	1208	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1246	transient_for transparent transparent_all tripleclickwords utmpInhibit	1209	term_name title transient_for transparent tripleclickwords urgentOnBell
1247	visualBell	1210	utmpInhibit visualBell
1248		1211
1249	=cut	1212	=cut
1250		1213
1251	sub resource($$;$) {	1214	sub resource($$;$) {
1252	my ($self, $name) = (shift, shift);	1215	my ($self, $name) = (shift, shift);
1253	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1216	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1254	&urxvt::term::_resource	1217	goto &urxvt::term::_resource
1255	}	1218	}
1256		1219
1257	=item $value = $term->x_resource ($pattern)	1220	=item $value = $term->x_resource ($pattern)
1258		1221
1259	Returns the X-Resource for the given pattern, excluding the program or	1222	Returns the X-Resource for the given pattern, excluding the program or
1260	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1223	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1261	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1224	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1262	resource with that pattern exists.	1225	resource with that pattern exists.
1263		1226
		1227	Extensions that define extra resource or command line arguments also need
		1228	to call this method to access their values.
		1229
		1230	If the method is called on an extension object (basically, from an
		1231	extension), then the special prefix C<%.> will be replaced by the name of
		1232	the extension and a dot, and the lone string C<%> will be replaced by the
		1233	extension name itself. This makes it possible to code extensions so you
		1234	can rename them and get a new set of commandline switches and resources
		1235	without having to change the actual code.
		1236
1264	This method should only be called during the C<on_start> hook, as there is	1237	This method should only be called during the C<on_start> hook, as there is
1265	only one resource database per display, and later invocations might return	1238	only one resource database per display, and later invocations might return
1266	the wrong resources.	1239	the wrong resources.
1267		1240
1268	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1241	=item $value = $term->x_resource_boolean ($pattern)
1269		1242
		1243	Like C<x_resource>, above, but interprets the string value as a boolean
		1244	and returns C<1> for true values, C<0> for false values and C<undef> if
		1245	the resource or option isn't specified.
		1246
		1247	You should always use this method to parse boolean resources.
		1248
		1249	=cut
		1250
		1251	sub x_resource_boolean {
		1252	my $res = &x_resource;
		1253
		1254	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1255	}
		1256
		1257	=item $success = $term->bind_action ($key, $octets)
		1258
1270	Adds a keymap translation exactly as specified via a resource. See the	1259	Adds a key binding exactly as specified via a resource. See the
1271	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1260	C<keysym> resource in the urxvt(1) manpage.
1272		1261
1273	=item $rend = $term->rstyle ([$new_rstyle])	1262	=item $rend = $term->rstyle ([$new_rstyle])
1274		1263
1275	Return and optionally change the current rendition. Text that is output by	1264	Return and optionally change the current rendition. Text that is output by
1276	the terminal application will use this style.	1265	the terminal application will use this style.
…		…
1284		1273
1285	=item ($row, $col) = $term->selection_beg ([$row, $col])	1274	=item ($row, $col) = $term->selection_beg ([$row, $col])
1286		1275
1287	=item ($row, $col) = $term->selection_end ([$row, $col])	1276	=item ($row, $col) = $term->selection_end ([$row, $col])
1288		1277
1289	Return the current values of the selection mark, begin or end positions,	1278	Return the current values of the selection mark, begin or end positions.
1290	and optionally set them to new values.	1279
		1280	When arguments are given, then the selection coordinates are set to
		1281	C<$row> and C<$col>, and the selection screen is set to the current
		1282	screen.
		1283
		1284	=item $screen = $term->selection_screen ([$screen])
		1285
		1286	Returns the current selection screen, and then optionally sets it.
1291		1287
1292	=item $term->selection_make ($eventtime[, $rectangular])	1288	=item $term->selection_make ($eventtime[, $rectangular])
1293		1289
1294	Tries to make a selection as set by C<selection_beg> and	1290	Tries to make a selection as set by C<selection_beg> and
1295	C<selection_end>. If C<$rectangular> is true (default: false), a	1291	C<selection_end>. If C<$rectangular> is true (default: false), a
1296	rectangular selection will be made. This is the prefered function to make	1292	rectangular selection will be made. This is the preferred function to make
1297	a selection.	1293	a selection.
1298		1294
1299	=item $success = $term->selection_grab ($eventtime)	1295	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1300		1296
1301	Try to request the primary selection text from the server (for example, as	1297	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1298	true) selection from the server. The corresponding text can be set
1302	set by the next method). No visual feedback will be given. This function	1299	with the next method. No visual feedback will be given. This function
1303	is mostly useful from within C<on_sel_grab> hooks.	1300	is mostly useful from within C<on_sel_grab> hooks.
1304		1301
1305	=item $oldtext = $term->selection ([$newtext])	1302	=item $oldtext = $term->selection ([$newtext, $clipboard])
1306		1303
1307	Return the current selection text and optionally replace it by C<$newtext>.	1304	Return the current selection (clipboard if C<$clipboard> is true) text
		1305	and optionally replace it by C<$newtext>.
		1306
		1307	=item $term->selection_clear ([$clipboard])
		1308
		1309	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1308		1310
1309	=item $term->overlay_simple ($x, $y, $text)	1311	=item $term->overlay_simple ($x, $y, $text)
1310		1312
1311	Create a simple multi-line overlay box. See the next method for details.	1313	Create a simple multi-line overlay box. See the next method for details.
1312		1314
…		…
1342		1344
1343	The methods currently supported on C<urxvt::overlay> objects are:	1345	The methods currently supported on C<urxvt::overlay> objects are:
1344		1346
1345	=over 4	1347	=over 4
1346		1348
1347	=item $overlay->set ($x, $y, $text, $rend)	1349	=item $overlay->set ($x, $y, $text[, $rend])
1348		1350
1349	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1351	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1350	text in rxvt-unicode's special encoding and an array of rendition values	1352	text in rxvt-unicode's special encoding and an array of rendition values
1351	at a specific position inside the overlay.	1353	at a specific position inside the overlay.
		1354
		1355	If C<$rend> is missing, then the rendition will not be changed.
1352		1356
1353	=item $overlay->hide	1357	=item $overlay->hide
1354		1358
1355	If visible, hide the overlay, but do not destroy it.	1359	If visible, hide the overlay, but do not destroy it.
1356		1360
…		…
1438	locale-specific encoding of the terminal and can contain command sequences	1442	locale-specific encoding of the terminal and can contain command sequences
1439	(escape codes) that will be interpreted.	1443	(escape codes) that will be interpreted.
1440		1444
1441	=item $term->tt_write ($octets)	1445	=item $term->tt_write ($octets)
1442		1446
1443	Write the octets given in C<$data> to the tty (i.e. as program input). To	1447	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1444	pass characters instead of octets, you should convert your strings first	1448	pass characters instead of octets, you should convert your strings first
1445	to the locale-specific encoding using C<< $term->locale_encode >>.	1449	to the locale-specific encoding using C<< $term->locale_encode >>.
		1450
		1451	=item $term->tt_paste ($octets)
		1452
		1453	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1454	CR and bracketing the data with control sequences if bracketed paste mode
		1455	is set.
1446		1456
1447	=item $old_events = $term->pty_ev_events ([$new_events])	1457	=item $old_events = $term->pty_ev_events ([$new_events])
1448		1458
1449	Replaces the event mask of the pty watcher by the given event mask. Can	1459	Replaces the event mask of the pty watcher by the given event mask. Can
1450	be used to suppress input and output handling to the pty/tty. See the	1460	be used to suppress input and output handling to the pty/tty. See the
…		…
1469	Adds the specified events to the vt event mask. Useful e.g. when you want	1479	Adds the specified events to the vt event mask. Useful e.g. when you want
1470	to receive pointer events all the times:	1480	to receive pointer events all the times:
1471		1481
1472	$term->vt_emask_add (urxvt::PointerMotionMask);	1482	$term->vt_emask_add (urxvt::PointerMotionMask);
1473		1483
		1484	=item $term->set_urgency ($set)
		1485
		1486	Enable/disable the urgency hint on the toplevel window.
		1487
1474	=item $term->focus_in	1488	=item $term->focus_in
1475		1489
1476	=item $term->focus_out	1490	=item $term->focus_out
1477		1491
1478	=item $term->key_press ($state, $keycode[, $time])	1492	=item $term->key_press ($state, $keycode[, $time])
…		…
1566		1580
1567	Used after changing terminal contents to display them.	1581	Used after changing terminal contents to display them.
1568		1582
1569	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1583	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1570		1584
1571	Returns the text of the entire row with number C<$row_number>. Row C<0>	1585	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1572	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1586	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1573	terminal line. The scrollback buffer starts at line C<-1> and extends to
1574	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1587	terminal line. Nothing will be returned if a nonexistent line
1575	is requested.	1588	is requested.
1576		1589
1577	If C<$new_text> is specified, it will replace characters in the current	1590	If C<$new_text> is specified, it will replace characters in the current
1578	line, starting at column C<$start_col> (default C<0>), which is useful	1591	line, starting at column C<$start_col> (default C<0>), which is useful
1579	to replace only parts of a line. The font index in the rendition will	1592	to replace only parts of a line. The font index in the rendition will
1580	automatically be updated.	1593	automatically be updated.
1581		1594
1582	C<$text> is in a special encoding: tabs and wide characters that use more	1595	C<$text> is in a special encoding: tabs and wide characters that use more
1583	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1596	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1584	characters. Characters with combining characters and other characters that	1597	characters. Characters with combining characters and other characters that
1585	do not fit into the normal tetx encoding will be replaced with characters	1598	do not fit into the normal text encoding will be replaced with characters
1586	in the private use area.	1599	in the private use area.
1587		1600
1588	You have to obey this encoding when changing text. The advantage is	1601	You have to obey this encoding when changing text. The advantage is
1589	that C<substr> and similar functions work on screen cells and not on	1602	that C<substr> and similar functions work on screen cells and not on
1590	characters.	1603	characters.
…		…
1675	}	1688	}
1676		1689
1677	sub urxvt::line::t {	1690	sub urxvt::line::t {
1678	my ($self) = @_;	1691	my ($self) = @_;
1679		1692
1680	if (@_ > 1)	1693	if (@_ > 1) {
1681	{
1682	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1694	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1683	for $self->{beg} .. $self->{end};	1695	for $self->{beg} .. $self->{end};
1684	}	1696	}
1685		1697
1686	defined wantarray &&	1698	defined wantarray &&
1687	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1699	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1688	0, $self->{len}	1700	0, $self->{len}
1689	}	1701	}
1690		1702
1691	sub urxvt::line::r {	1703	sub urxvt::line::r {
1692	my ($self) = @_;	1704	my ($self) = @_;
1693		1705
1694	if (@_ > 1)	1706	if (@_ > 1) {
1695	{
1696	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1707	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1697	for $self->{beg} .. $self->{end};	1708	for $self->{beg} .. $self->{end};
1698	}	1709	}
1699		1710
1700	if (defined wantarray) {	1711	if (defined wantarray) {
1701	my $rend = [	1712	my $rend = [
1702	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1713	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1703	];	1714	];
…		…
1765	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1776	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1766	recent grab.	1777	recent grab.
1767		1778
1768	=item $term->ungrab	1779	=item $term->ungrab
1769		1780
1770	Calls XUngrab for the most recent grab. Is called automatically on	1781	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1771	evaluation errors, as it is better to lose the grab in the error case as	1782	evaluation errors, as it is better to lose the grab in the error case as
1772	the session.	1783	the session.
1773		1784
1774	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1785	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1775		1786
…		…
1777		1788
1778	=item @atoms = $term->XListProperties ($window)	1789	=item @atoms = $term->XListProperties ($window)
1779		1790
1780	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1791	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1781		1792
1782	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1793	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1783		1794
1784	=item $term->XDeleteProperty ($window, $property)	1795	=item $term->XDeleteProperty ($window, $property)
1785		1796
1786	=item $window = $term->DefaultRootWindow	1797	=item $window = $term->DefaultRootWindow
1787		1798
…		…
1794	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1805	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1795		1806
1796	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1807	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1797		1808
1798	=item $term->XChangeInput ($window, $add_events[, $del_events])	1809	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1810
		1811	=item $keysym = $term->XStringToKeysym ($string)
		1812
		1813	=item $string = $term->XKeysymToString ($keysym)
1799		1814
1800	Various X or X-related functions. The C<$term> object only serves as	1815	Various X or X-related functions. The C<$term> object only serves as
1801	the source of the display, otherwise those functions map more-or-less	1816	the source of the display, otherwise those functions map more-or-less
1802	directory onto the X functions of the same name.	1817	directly onto the X functions of the same name.
1803		1818
1804	=back	1819	=back
1805		1820
1806	=cut	1821	=cut
1807		1822
…		…
1909	my $env = $self->{term}->env;	1924	my $env = $self->{term}->env;
1910	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1925	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1911	delete $env->{LC_ALL};	1926	delete $env->{LC_ALL};
1912	$env->{LC_CTYPE} = $self->{term}->locale;	1927	$env->{LC_CTYPE} = $self->{term}->locale;
1913		1928
1914	urxvt::term->new ($env, "popup",	1929	my $term = urxvt::term->new (
		1930	$env, "popup",
1915	"--perl-lib" => "", "--perl-ext-common" => "",	1931	"--perl-lib" => "", "--perl-ext-common" => "",
1916	"-pty-fd" => -1, "-sl" => 0,	1932	"-pty-fd" => -1, "-sl" => 0,
1917	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1933	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1918	"--transient-for" => $self->{term}->parent,	1934	"--transient-for" => $self->{term}->parent,
1919	"-display" => $self->{term}->display_id,	1935	"-display" => $self->{term}->display_id,
1920	"-pe" => "urxvt-popup")	1936	"-pe" => "urxvt-popup",
1921	or die "unable to create popup window\n";	1937	) or die "unable to create popup window\n";
		1938
		1939	unless (delete $term->{urxvt_popup_init_done}) {
		1940	$term->ungrab;
		1941	$term->destroy;
		1942	die "unable to initialise popup window\n";
		1943	}
1922	}	1944	}
1923		1945
1924	sub DESTROY {	1946	sub DESTROY {
1925	my ($self) = @_;	1947	my ($self) = @_;
1926		1948
…		…
1931	=back	1953	=back
1932		1954
1933	=cut	1955	=cut
1934		1956
1935	package urxvt::watcher;	1957	package urxvt::watcher;
1936
1937	@urxvt::timer::ISA = __PACKAGE__;
1938	@urxvt::iow::ISA = __PACKAGE__;
1939	@urxvt::pw::ISA = __PACKAGE__;
1940	@urxvt::iw::ISA = __PACKAGE__;
1941		1958
1942	=head2 The C<urxvt::timer> Class	1959	=head2 The C<urxvt::timer> Class
1943		1960
1944	This class implements timer watchers/events. Time is represented as a	1961	This class implements timer watchers/events. Time is represented as a
1945	fractional number of seconds since the epoch. Example:	1962	fractional number of seconds since the epoch. Example:
…		…
1949	->new	1966	->new
1950	->interval (1)	1967	->interval (1)
1951	->cb (sub {	1968	->cb (sub {
1952	$term->{overlay}->set (0, 0,	1969	$term->{overlay}->set (0, 0,
1953	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1970	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1954	});	1971	});
1955		1972
1956	=over 4	1973	=over 4
1957		1974
1958	=item $timer = new urxvt::timer	1975	=item $timer = new urxvt::timer
1959		1976
…		…
1962		1979
1963	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1980	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1964		1981
1965	Set the callback to be called when the timer triggers.	1982	Set the callback to be called when the timer triggers.
1966		1983
1967	=item $tstamp = $timer->at
1968
1969	Return the time this watcher will fire next.
1970
1971	=item $timer = $timer->set ($tstamp)	1984	=item $timer = $timer->set ($tstamp[, $interval])
1972		1985
1973	Set the time the event is generated to $tstamp.	1986	Set the time the event is generated to $tstamp (and optionally specifies a
		1987	new $interval).
1974		1988
1975	=item $timer = $timer->interval ($interval)	1989	=item $timer = $timer->interval ($interval)
1976		1990
1977	Normally (and when C<$interval> is C<0>), the timer will automatically	1991	By default (and when C<$interval> is C<0>), the timer will automatically
1978	stop after it has fired once. If C<$interval> is non-zero, then the timer	1992	stop after it has fired once. If C<$interval> is non-zero, then the timer
1979	is automatically rescheduled at the given intervals.	1993	is automatically rescheduled at the given intervals.
1980		1994
1981	=item $timer = $timer->start	1995	=item $timer = $timer->start
1982		1996
1983	Start the timer.	1997	Start the timer.
1984		1998
1985	=item $timer = $timer->start ($tstamp)	1999	=item $timer = $timer->start ($tstamp[, $interval])
1986		2000
1987	Set the event trigger time to C<$tstamp> and start the timer.	2001	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2002	also replaces the interval.
1988		2003
1989	=item $timer = $timer->after ($delay)	2004	=item $timer = $timer->after ($delay[, $interval])
1990		2005
1991	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2006	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1992		2007
1993	=item $timer = $timer->stop	2008	=item $timer = $timer->stop
1994		2009
…		…
2002		2017
2003	$term->{socket} = ...	2018	$term->{socket} = ...
2004	$term->{iow} = urxvt::iow	2019	$term->{iow} = urxvt::iow
2005	->new	2020	->new
2006	->fd (fileno $term->{socket})	2021	->fd (fileno $term->{socket})
2007	->events (urxvt::EVENT_READ)	2022	->events (urxvt::EV_READ)
2008	->start	2023	->start
2009	->cb (sub {	2024	->cb (sub {
2010	my ($iow, $revents) = @_;	2025	my ($iow, $revents) = @_;
2011	# $revents must be 1 here, no need to check	2026	# $revents must be 1 here, no need to check
2012	sysread $term->{socket}, my $buf, 8192	2027	sysread $term->{socket}, my $buf, 8192
…		…
2030	Set the file descriptor (not handle) to watch.	2045	Set the file descriptor (not handle) to watch.
2031		2046
2032	=item $iow = $iow->events ($eventmask)	2047	=item $iow = $iow->events ($eventmask)
2033		2048
2034	Set the event mask to watch. The only allowed values are	2049	Set the event mask to watch. The only allowed values are
2035	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2050	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2036	together, or C<urxvt::EVENT_NONE>.	2051	together, or C<urxvt::EV_NONE>.
2037		2052
2038	=item $iow = $iow->start	2053	=item $iow = $iow->start
2039		2054
2040	Start watching for requested events on the given handle.	2055	Start watching for requested events on the given handle.
2041		2056
…		…
2082	->new	2097	->new
2083	->start ($pid)	2098	->start ($pid)
2084	->cb (sub {	2099	->cb (sub {
2085	my ($pw, $exit_status) = @_;	2100	my ($pw, $exit_status) = @_;
2086	...	2101	...
2087	});	2102	});
2088		2103
2089	=over 4	2104	=over 4
2090		2105
2091	=item $pw = new urxvt::pw	2106	=item $pw = new urxvt::pw
2092		2107
…		…
2125		2140
2126	=back	2141	=back
2127		2142
2128	=head1 AUTHOR	2143	=head1 AUTHOR
2129		2144
2130	Marc Lehmann <pcg@goof.com>	2145	Marc Lehmann <schmorp@schmorp.de>
2131	http://software.schmorp.de/pkg/rxvt-unicode	2146	http://software.schmorp.de/pkg/rxvt-unicode
2132		2147
2133	=cut	2148	=cut
2134		2149
2135	1	2150	1
		2151
		2152	# vim: sw=3:

Diff Legend

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