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

Diff Legend

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