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.142 by root, Thu Jul 6 18:56:10 2006 UTC vs.
Revision 1.267 by sf-exg, Sat Jul 24 12:17:08 2021 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 some directory:
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 instance using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib path/to/somedirectory -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime 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 qw(vars subs)' and 'use utf8'
26	thus must be encoded as UTF-8.	26	environment, and 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 may add additional resources and C<actions>, i.e., methods
45		49	which can be bound to a key and invoked by the user. An extension can
46	=item selection (enabled by default)	50	define the resources it support using so called META comments,
47		51	described below. Similarly to builtin resources, extension resources
48	(More) intelligent selection. This extension tries to be more intelligent	52	can also be specified on the command line as long options (with C<.>
49	when the user extends selections (double-click and further clicks). Right	53	replaced by C<->), in which case the corresponding extension is loaded
50	now, it tries to select words, urls and complete shell-quoted	54	automatically. For this to work the extension B<must> define META
51	arguments, which is very convenient, too, if your F<ls> supports	55	comments for its resources.
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 followign 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 wether 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 refered 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 automove-background
265
266	This is basically a very small extension that dynamically changes the
267	background pixmap offset to the window position, in effect creating the
268	same effect as pseudo transparency with a custom pixmap. No scaling is
269	supported in this mode. Exmaple:
270
271	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
272
273	=item block-graphics-to-ascii
274
275	A not very useful example of filtering all text output to the terminal
276	by replacing all line-drawing characters (U+2500 .. U+259F) by a
277	similar-looking ascii character.
278
279	=item digital-clock
280
281	Displays a digital clock using the built-in overlay.
282
283	=item remote-clipboard
284
285	Somewhat of a misnomer, this extension adds two menu entries to the
286	selection popup that allows one ti run external commands to store the
287	selection somewhere and fetch it again.
288
289	We use it to implement a "distributed selection mechanism", which just
290	means that one command uploads the file to a remote server, and another
291	reads it.
292
293	The commands can be set using the C<URxvt.remote-selection.store> and
294	C<URxvt.remote-selection.fetch> resources. The first should read the
295	selection to store from STDIN (always in UTF-8), the second should provide
296	the selection data on STDOUT (also in UTF-8).
297
298	The defaults (which are likely useless to you) use rsh and cat:
299
300	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
301	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
302
303	=item selection-pastebin
304
305	This is a little rarely useful extension that Uploads the selection as
306	textfile to a remote site (or does other things). (The implementation is
307	not currently secure for use in a multiuser environment as it writes to
308	F</tmp> directly.).
309
310	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
311	i.e.
312
313	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
314
315	Pressing this combination runs a command with C<%> replaced by the name of
316	the textfile. This command can be set via a resource:
317
318	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
319
320	And the default is likely not useful to anybody but the few people around
321	here :)
322
323	The name of the textfile is the hex encoded md5 sum of the selection, so
324	the same content should lead to the same filename.
325
326	After a successful upload the selection will be replaced by the text given
327	in the C<selection-pastebin-url> resource (again, the % is the placeholder
328	for the filename):
329
330	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
331
332	=item example-refresh-hooks
333
334	Displays a very simple digital clock in the upper right corner of the
335	window. Illustrates overwriting the refresh callbacks to create your own
336	overlays or changes.
337
338	=back
339		56
340	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
341		58
342	=head2 General API Considerations	59	=head2 General API Considerations
343		60
…		…
353	terminal is destroyed.	70	terminal is destroyed.
354		71
355	Argument names also often indicate the type of a parameter. Here are some	72	Argument names also often indicate the type of a parameter. Here are some
356	hints on what they mean:	73	hints on what they mean:
357		74
358	=over 4	75	=over
359		76
360	=item $text	77	=item $text
361		78
362	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
363	always represents one screen cell. See L<ROW_t> for a discussion of this format.	80	always represents one screen cell. See L<ROW_t> for a discussion of this format.
364		81
365	=item $string	82	=item $string
366		83
367	A perl text string, with an emphasis on I<text>. It can store all unicode	84	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
371	=item $octets	88	=item $octets
372		89
373	Either binary data or - more common - a text string encoded in a	90	Either binary data or - more common - a text string encoded in a
374	locale-specific way.	91	locale-specific way.
375		92
		93	=item $keysym
		94
		95	an integer that is a valid X11 keysym code. You can convert a string
		96	into a keysym and viceversa by using C<XStringToKeysym> and
		97	C<XKeysymToString>.
		98
376	=back	99	=back
377		100
378	=head2 Extension Objects	101	=head2 Extension Objects
379		102
380	Every perl extension is a perl class. A separate perl object is created	103	Every perl extension is a perl class. A separate perl object is created
381	for each terminal and each extension and passed as the first parameter to	104	for each terminal, and each terminal has its own set of extension objects,
382	hooks. So extensions can use their C<$self> object without having to think	105	which are passed as the first parameter to hooks. So extensions can use
383	about other extensions, with the exception of methods and members that	106	their C<$self> object without having to think about clashes with other
		107	extensions or other terminals, with the exception of methods and members
384	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
385	use.	109	internal use.
386		110
387	Although it isn't a C<urxvt::term> object, you can call all methods of the	111	Although it isn't a C<urxvt::term> object, you can call all methods of the
388	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
389		113
390	It has the following methods and data members:	114	Additional methods only supported for extension objects are described in
		115	the C<urxvt::extension> section below.
391		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata. These comments are scanned whenever a
		121	terminal is created and are typically used to autoload extensions when
		122	their resources or command line parameters are used.
		123
		124	Currently, it recognises these comments below. Individual components are
		125	separated by colons (C<:>), and should not contain colons themselves -
		126	there is also currently no escaping mechanism provided for this.
		127
392	=over 4	128	=over
393		129
394	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
395		131
396	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
397	extension. This member I<must not> be changed in any way.	133	C<name> is the resource name, C<type> is the resource type, C<boolean>
		134	or C<string>, and C<desc> is the resource description.
398		135
399	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	136	The extension will be autoloaded when this resource is specified or used
		137	as a command line parameter.
400		138
401	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
402	this extension, replacing any previous hook. This is useful when you want	140	comment:
403	to overwrite time-critical hooks only temporarily.
404		141
405	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
406		143
407	Dynamically disable the given hooks.	144	Example: load this extension when the C<-tr> command line option or
		145	resource name is used.
		146
		147	#:META:RESOURCE:tr:boolean:set root pixmap as background
		148
		149	=item #:META:OSC:number:desc
		150
		151	The OSC comment specifies an OSC sequence, where C<number> is the
		152	numerical OSC code and C<desc> is a short description that is currently
		153	unused.
		154
		155	This will cause the extension to be autoloaded when the OSC sequence is
		156	used for the first time.
		157
		158	Note that autoloading carries some extra responsibilities with it:
		159	although the terminal cannot really protect itself against malicious
		160	sources of command sequences, therefore relying on the programs running
		161	I<inside> to sanitize data that they output, it is very common for
		162	programs to emit command sequences from untrusted sources.
		163
		164	While this means that extensions should, as a defense-in-depth mechanism,
		165	always consider whether OSC sequences are safe, autoloading automatically
		166	exposes any autoloaded extension in all terminal windows, so extra care
		167	should be taken.
		168
		169	Example: the background extension registers OSC C<20> like this:
		170
		171	#:META:OSC:20:change/query background image
		172
		173	=item #:META:OSC_PERL:prefix:desc
		174
		175	The same as the OSC comment, but for the Perl OSC sequence (C<777>). The
		176	C<prefix> should be unique among extensions, of course, which is most
		177	easily arranged by using the extension name, although this is not
		178	required.
		179
		180	Example: the overlay-osc extension registers its Perl OSC like this:
		181
		182	#:META:OSC_PERL:overlay:man overlay-osc
408		183
409	=back	184	=back
410		185
411	=head2 Hooks	186	=head2 Hooks
412		187
413	The following subroutines can be declared in extension files, and will be	188	The following subroutines can be declared in extension files, and will be
414	called whenever the relevant event happens.	189	called whenever the relevant event happens.
415		190
416	The first argument passed to them is an extension oject as described in	191	The first argument passed to them is an extension object as described in
417	the in the C<Extension Objects> section.	192	the in the C<Extension Objects> section.
418		193
419	B<All> of these hooks must return a boolean value. If any of the called	194	B<All> of these hooks must return a boolean value. If any of the called
420	hooks returns true, then the event counts as being I<consumed>, and the	195	hooks returns true, then the event counts as being I<consumed>, and the
421	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
422		197
423	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
424		199
425	=over 4	200	=over
426		201
427	=item on_init $term	202	=item on_init $term
428		203
429	Called after a new terminal object has been initialized, but before	204	Called after a new terminal object has been initialized, but before
430	windows are created or the command gets run. Most methods are unsafe to	205	windows are created or the command gets run. Most methods are unsafe to
…		…
434	place.	209	place.
435		210
436	=item on_start $term	211	=item on_start $term
437		212
438	Called at the very end of initialisation of a new terminal, just before	213	Called at the very end of initialisation of a new terminal, just before
439	trying to map (display) the toplevel and returning to the mainloop.	214	trying to map (display) the toplevel and returning to the main loop.
440		215
441	=item on_destroy $term	216	=item on_destroy $term
442		217
443	Called whenever something tries to destroy terminal, when the terminal is	218	Called whenever something tries to destroy terminal, when the terminal is
444	still fully functional (not for long, though).	219	still fully functional (not for long, though).
…		…
471		246
472	Called whenever a selection has been copied, but before the selection is	247	Called whenever a selection has been copied, but before the selection is
473	requested from the server. The selection text can be queried and changed	248	requested from the server. The selection text can be queried and changed
474	by calling C<< $term->selection >>.	249	by calling C<< $term->selection >>.
475		250
476	Returning a true value aborts selection grabbing. It will still be hilighted.	251	Returning a true value aborts selection grabbing. It will still be highlighted.
477		252
478	=item on_sel_extend $term	253	=item on_sel_extend $term
479		254
480	Called whenever the user tries to extend the selection (e.g. with a double	255	Called whenever the user tries to extend the selection (e.g. with a double
481	click) and is either supposed to return false (normal operation), or	256	click) and is either supposed to return false (normal operation), or
482	should extend the selection itelf and return true to suppress the built-in	257	should extend the selection itself and return true to suppress the built-in
483	processing. This can happen multiple times, as long as the callback	258	processing. This can happen multiple times, as long as the callback
484	returns true, it will be called on every further click by the user and is	259	returns true, it will be called on every further click by the user and is
485	supposed to enlarge the selection more and more, if possible.	260	supposed to enlarge the selection more and more, if possible.
486		261
487	See the F<selection> example extension.	262	See the F<selection> example extension.
488		263
489	=item on_view_change $term, $offset	264	=item on_view_change $term, $offset
490		265
491	Called whenever the view offset changes, i..e the user or program	266	Called whenever the view offset changes, i.e. the user or program
492	scrolls. Offset C<0> means display the normal terminal, positive values	267	scrolls. Offset C<0> means display the normal terminal, positive values
493	show this many lines of scrollback.	268	show this many lines of scrollback.
494		269
495	=item on_scroll_back $term, $lines, $saved	270	=item on_scroll_back $term, $lines, $saved
496		271
…		…
500		275
501	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	276	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
502	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	277	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
503	number of lines that will be in the scrollback buffer.	278	number of lines that will be in the scrollback buffer.
504		279
505	=item on_osc_seq $term, $op, $args	280	=item on_osc_seq $term, $op, $args, $resp
506		281
507	Called on every OSC sequence and can be used to suppress it or modify its	282	Called on every OSC sequence and can be used to suppress it or modify its
508	behaviour. The default should be to return an empty list. A true value	283	behaviour. The default should be to return an empty list. A true value
509	suppresses execution of the request completely. Make sure you don't get	284	suppresses execution of the request completely. Make sure you don't get
510	confused by recursive invocations when you output an osc sequence within	285	confused by recursive invocations when you output an OSC sequence within
511	this callback.	286	this callback.
512		287
513	C<on_osc_seq_perl> should be used for new behaviour.	288	C<on_osc_seq_perl> should be used for new behaviour.
514		289
515	=item on_osc_seq_perl $term, $string	290	=item on_osc_seq_perl $term, $args, $resp
516		291
517	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	292	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
518	operating system command) is processed. Cursor position and other state	293	(OSC = operating system command) is processed. Cursor position and other
519	information is up-to-date when this happens. For interoperability, the	294	state information is up-to-date when this happens. For interoperability,
520	string should start with the extension name and a colon, to distinguish	295	the argument should start with the extension name (sans -osc) or some
521	it from commands for other extensions, and this might be enforced in the	296	other suitable prefix, and a semicolon, to distinguish it from commands
522	future.	297	for other extensions.
		298
		299	For example, C<overlay-osc> uses this:
		300
		301	sub on_osc_seq_perl {
		302	my ($self, $osc, $resp) = @_;
		303
		304	return unless $osc =~ s/^overlay;//;
		305
		306	... process remaining $osc string
		307	}
523		308
524	Be careful not ever to trust (in a security sense) the data you receive,	309	Be careful not ever to trust (in a security sense) the data you receive,
525	as its source can not easily be controleld (e-mail content, messages from	310	as its source can not easily be controlled (e-mail content, messages from
526	other users on the same system etc.).	311	other users on the same system etc.).
		312
		313	For responses, C<$resp> contains the end-of-args separator used by the
		314	sender.
527		315
528	=item on_add_lines $term, $string	316	=item on_add_lines $term, $string
529		317
530	Called whenever text is about to be output, with the text as argument. You	318	Called whenever text is about to be output, with the text as argument. You
531	can filter/change and output the text yourself by returning a true value	319	can filter/change and output the text yourself by returning a true value
…		…
536	=item on_tt_write $term, $octets	324	=item on_tt_write $term, $octets
537		325
538	Called whenever some data is written to the tty/pty and can be used to	326	Called whenever some data is written to the tty/pty and can be used to
539	suppress or filter tty input.	327	suppress or filter tty input.
540		328
		329	=item on_tt_paste $term, $octets
		330
		331	Called whenever text is about to be pasted, with the text as argument. You
		332	can filter/change and paste the text yourself by returning a true value
		333	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		334	locale-encoded.
		335
541	=item on_line_update $term, $row	336	=item on_line_update $term, $row
542		337
543	Called whenever a line was updated or changed. Can be used to filter	338	Called whenever a line was updated or changed. Can be used to filter
544	screen output (e.g. underline urls or other useless stuff). Only lines	339	screen output (e.g. underline urls or other useless stuff). Only lines
545	that are being shown will be filtered, and, due to performance reasons,	340	that are being shown will be filtered, and, due to performance reasons,
…		…
552	later with the already-modified line (e.g. if unrelated parts change), so	347	later with the already-modified line (e.g. if unrelated parts change), so
553	you cannot just toggle rendition bits, but only set them.	348	you cannot just toggle rendition bits, but only set them.
554		349
555	=item on_refresh_begin $term	350	=item on_refresh_begin $term
556		351
557	Called just before the screen gets redrawn. Can be used for overlay	352	Called just before the screen gets redrawn. Can be used for overlay or
558	or similar effects by modify terminal contents in refresh_begin, and	353	similar effects by modifying the terminal contents in refresh_begin, and
559	restoring them in refresh_end. The built-in overlay and selection display	354	restoring them in refresh_end. The built-in overlay and selection display
560	code is run after this hook, and takes precedence.	355	code is run after this hook, and takes precedence.
561		356
562	=item on_refresh_end $term	357	=item on_refresh_end $term
563		358
564	Called just after the screen gets redrawn. See C<on_refresh_begin>.	359	Called just after the screen gets redrawn. See C<on_refresh_begin>.
565		360
		361	=item on_action $term, $string
		362
		363	Called whenever an action is invoked for the corresponding extension
		364	(e.g. via a C<extension:string> builtin action bound to a key, see
		365	description of the B<keysym> resource in the urxvt(1) manpage). The
		366	event is simply the action string. Note that an action event is always
		367	associated to a single extension.
		368
566	=item on_user_command $term, $string	369	=item on_user_command $term, $string *DEPRECATED*
567		370
568	Called whenever the a user-configured event is being activated (e.g. via	371	Called whenever a user-configured event is being activated (e.g. via
569	a C<perl:string> action bound to a key, see description of the B<keysym>	372	a C<perl:string> action bound to a key, see description of the B<keysym>
570	resource in the @@RXVT_NAME@@(1) manpage).	373	resource in the urxvt(1) manpage).
571		374
572	The event is simply the action string. This interface is assumed to change	375	The event is simply the action string. This interface is going away in
573	slightly in the future.	376	preference to the C<on_action> hook.
574		377
575	=item on_resize_all_windows $tern, $new_width, $new_height	378	=item on_resize_all_windows $term, $new_width, $new_height
576		379
577	Called just after the new window size has been calculcated, but before	380	Called just after the new window size has been calculated, but before
578	windows are actually being resized or hints are being set. If this hook	381	windows are actually being resized or hints are being set. If this hook
579	returns TRUE, setting of the window hints is being skipped.	382	returns a true value, setting of the window hints is being skipped.
580		383
581	=item on_x_event $term, $event	384	=item on_x_event $term, $event
582		385
583	Called on every X event received on the vt window (and possibly other	386	Called on every X event received on the vt window (and possibly other
584	windows). Should only be used as a last resort. Most event structure	387	windows). Should only be used as a last resort. Most event structure
585	members are not passed.	388	members are not passed.
586		389
		390	=item on_root_event $term, $event
		391
		392	Like C<on_x_event>, but is called for events on the root window.
		393
587	=item on_focus_in $term	394	=item on_focus_in $term
588		395
589	Called whenever the window gets the keyboard focus, before rxvt-unicode	396	Called whenever the window gets the keyboard focus, before rxvt-unicode
590	does focus in processing.	397	does focus in processing.
591		398
592	=item on_focus_out $term	399	=item on_focus_out $term
593		400
594	Called wheneever the window loses keyboard focus, before rxvt-unicode does	401	Called whenever the window loses keyboard focus, before rxvt-unicode does
595	focus out processing.	402	focus out processing.
596		403
597	=item on_configure_notify $term, $event	404	=item on_configure_notify $term, $event
598		405
599	=item on_property_notify $term, $event	406	=item on_property_notify $term, $event
…		…
610		417
611	=item on_map_notify $term, $event	418	=item on_map_notify $term, $event
612		419
613	=item on_unmap_notify $term, $event	420	=item on_unmap_notify $term, $event
614		421
615	Called whenever the corresponding X event is received for the terminal If	422	Called whenever the corresponding X event is received for the terminal. If
616	the hook returns true, then the even will be ignored by rxvt-unicode.	423	the hook returns true, then the event will be ignored by rxvt-unicode.
617		424
618	The event is a hash with most values as named by Xlib (see the XEvent	425	The event is a hash with most values as named by Xlib (see the XEvent
619	manpage), with the additional members C<row> and C<col>, which are the	426	manpage), with the additional members C<row> and C<col>, which are the
620	(real, not screen-based) row and column under the mouse cursor.	427	(real, not screen-based) row and column under the mouse cursor.
621		428
622	C<on_key_press> additionally receives the string rxvt-unicode would	429	C<on_key_press> additionally receives the string rxvt-unicode would
623	output, if any, in locale-specific encoding.	430	output, if any, in locale-specific encoding.
624		431
625	subwindow.
626
627	=item on_client_message $term, $event	432	=item on_client_message $term, $event
628		433
629	=item on_wm_protocols $term, $event	434	=item on_wm_protocols $term, $event
630		435
631	=item on_wm_delete_window $term, $event	436	=item on_wm_delete_window $term, $event
632		437
633	Called when various types of ClientMessage events are received (all with	438	Called when various types of ClientMessage events are received (all with
634	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	439	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
635		440
		441	=item on_bell $term
		442
		443	Called on receipt of a bell character.
		444
636	=back	445	=back
637		446
638	=cut	447	=cut
639		448
640	package urxvt;	449	package urxvt;
641		450
642	use utf8;	451	use utf8;
643	use strict;	452	use strict qw(vars subs);
644	use Carp ();	453	use Carp ();
645	use Scalar::Util ();	454	use Scalar::Util ();
646	use List::Util ();	455	use List::Util ();
647		456
648	our $VERSION = 1;	457	our $VERSION = 1;
649	our $TERM;	458	our $TERM;
650	our @TERM_INIT;	459	our @TERM_INIT; # should go, prevents async I/O etc.
651	our @TERM_EXT;	460	our @TERM_EXT; # should go, prevents async I/O etc.
652	our @HOOKNAME;	461	our @HOOKNAME;
653	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	462	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
654	our %OPTION;	463	our %OPTION;
655		464
656	our $LIBDIR;	465	our $LIBDIR;
…		…
660		469
661	our $NOCHAR = chr 0xffff;	470	our $NOCHAR = chr 0xffff;
662		471
663	=head2 Variables in the C<urxvt> Package	472	=head2 Variables in the C<urxvt> Package
664		473
665	=over 4	474	=over
666		475
667	=item $urxvt::LIBDIR	476	=item $urxvt::LIBDIR
668		477
669	The rxvt-unicode library directory, where, among other things, the perl	478	The rxvt-unicode library directory, where, among other things, the perl
670	modules and scripts are stored.	479	modules and scripts are stored.
…		…
682	The current terminal. This variable stores the current C<urxvt::term>	491	The current terminal. This variable stores the current C<urxvt::term>
683	object, whenever a callback/hook is executing.	492	object, whenever a callback/hook is executing.
684		493
685	=item @urxvt::TERM_INIT	494	=item @urxvt::TERM_INIT
686		495
687	All coderefs in this array will be called as methods of the next newly	496	All code references in this array will be called as methods of the next newly
688	created C<urxvt::term> object (during the C<on_init> phase). The array	497	created C<urxvt::term> object (during the C<on_init> phase). The array
689	gets cleared before the codereferences that were in it are being executed,	498	gets cleared before the code references that were in it are being executed,
690	so coderefs can push themselves onto it again if they so desire.	499	so references can push themselves onto it again if they so desire.
691		500
692	This complements to the perl-eval commandline option, but gets executed	501	This complements to the perl-eval command line option, but gets executed
693	first.	502	first.
694		503
695	=item @urxvt::TERM_EXT	504	=item @urxvt::TERM_EXT
696		505
697	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	506	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
700		509
701	=back	510	=back
702		511
703	=head2 Functions in the C<urxvt> Package	512	=head2 Functions in the C<urxvt> Package
704		513
705	=over 4	514	=over
706		515
707	=item urxvt::fatal $errormessage	516	=item urxvt::fatal $errormessage
708		517
709	Fatally aborts execution with the given error message. Avoid at all	518	Fatally aborts execution with the given error message (which should
710	costs! The only time this is acceptable is when the terminal process	519	include a trailing newline). Avoid at all costs! The only time this
711	starts up.	520	is acceptable (and useful) is in the init hook, where it prevents the
		521	terminal from starting up.
712		522
713	=item urxvt::warn $string	523	=item urxvt::warn $string
714		524
715	Calls C<rxvt_warn> with the given string which should not include a	525	Calls C<rxvt_warn> with the given string which should include a trailing
716	newline. The module also overwrites the C<warn> builtin with a function	526	newline. The module also overwrites the C<warn> builtin with a function
717	that calls this function.	527	that calls this function.
718		528
719	Using this function has the advantage that its output ends up in the	529	Using this function has the advantage that its output ends up in the
720	correct place, e.g. on stderr of the connecting urxvtc client.	530	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
722	Messages have a size limit of 1023 bytes currently.	532	Messages have a size limit of 1023 bytes currently.
723		533
724	=item @terms = urxvt::termlist	534	=item @terms = urxvt::termlist
725		535
726	Returns all urxvt::term objects that exist in this process, regardless of	536	Returns all urxvt::term objects that exist in this process, regardless of
727	wether they are started, being destroyed etc., so be careful. Only term	537	whether they are started, being destroyed etc., so be careful. Only term
728	objects that have perl extensions attached will be returned (because there	538	objects that have perl extensions attached will be returned (because there
729	is no urxvt::term objet associated with others).	539	is no urxvt::term object associated with others).
730		540
731	=item $time = urxvt::NOW	541	=item $time = urxvt::NOW
732		542
733	Returns the "current time" (as per the event loop).	543	Returns the "current time" (as per the event loop).
734		544
…		…
754	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	564	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
755	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	565	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
756		566
757	Various constants for use in X calls and event processing.	567	Various constants for use in X calls and event processing.
758		568
		569	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		570	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		571	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		572	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		573	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		574	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		575	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
		576	PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		577	PrivMode_Default
		578
		579	Constants for checking DEC private modes.
		580
759	=back	581	=back
760		582
761	=head2 RENDITION	583	=head2 RENDITION
762		584
763	Rendition bitsets contain information about colour, font, font styles and	585	Rendition bitsets contain information about colour, font, font styles and
…		…
766	The following "macros" deal with changes in rendition sets. You should	588	The following "macros" deal with changes in rendition sets. You should
767	never just create a bitset, you should always modify an existing one,	589	never just create a bitset, you should always modify an existing one,
768	as they contain important information required for correct operation of	590	as they contain important information required for correct operation of
769	rxvt-unicode.	591	rxvt-unicode.
770		592
771	=over 4	593	=over
772		594
773	=item $rend = urxvt::DEFAULT_RSTYLE	595	=item $rend = urxvt::DEFAULT_RSTYLE
774		596
775	Returns the default rendition, as used when the terminal is starting up or	597	Returns the default rendition, as used when the terminal is starting up or
776	being reset. Useful as a base to start when creating renditions.	598	being reset. Useful as a base to start when creating renditions.
777		599
778	=item $rend = urxvt::OVERLAY_RSTYLE	600	=item $rend = urxvt::OVERLAY_RSTYLE
779		601
780	Return the rendition mask used for overlays by default.	602	Return the rendition mask used for overlays by default.
781		603
782	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	604	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		605	urxvt::RS_RVid, urxvt::RS_Uline
783		606
784	Return the bit that enabled bold, italic, blink, reverse-video and	607	Return the bit that enabled bold, italic, blink, reverse-video and
785	underline, respectively. To enable such a style, just logically OR it into	608	underline, respectively. To enable such a style, just logically OR it into
786	the bitset.	609	the bitset.
787		610
…		…
824	};	647	};
825	}	648	}
826		649
827	no warnings 'utf8';	650	no warnings 'utf8';
828		651
		652	sub parse_resource {
		653	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		654
		655	$term->scan_extensions;
		656
		657	# iterating over all resources has quadratic time overhead
		658	# overall, maybe this could be optimised?
		659	my $r = $term->{meta}{resource};
		660	keys %$r; # reset iterator
		661	while (my ($k, $v) = each %$r) {
		662	my $pattern = $k;
		663	$pattern =~ y/./-/ if $isarg;
		664	my $prefix = $name;
		665	my $suffix;
		666	if ($pattern =~ /\-$/) {
		667	$prefix = substr $name, 0, length $pattern;
		668	$suffix = substr $name, length $pattern;
		669	}
		670	if ($pattern eq $prefix) {
		671	$name = "$urxvt::RESCLASS.$k$suffix";
		672
		673	push @{ $term->{perl_ext_3} }, $v->[0];
		674
		675	return 1 unless $isarg;
		676
		677	if ($v->[1] eq "boolean") {
		678	$term->put_option_db ($name, $flag ? "true" : "false");
		679	return 1;
		680	} else {
		681	$term->put_option_db ($name, $value);
		682	return 1 + 2;
		683	}
		684	}
		685	}
		686
		687	0
		688	}
		689
		690	sub usage {
		691	my ($term, $usage_type) = @_;
		692
		693	$term->scan_extensions;
		694
		695	my $r = $term->{meta}{resource};
		696
		697	for my $pattern (sort keys %$r) {
		698	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		699
		700	$desc .= " (-pe $ext)";
		701
		702	if ($usage_type == 1) {
		703	$pattern =~ y/./-/;
		704	$pattern =~ s/-$/-.../g;
		705
		706	if ($type eq "boolean") {
		707	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		708	} else {
		709	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		710	}
		711	} else {
		712	$pattern =~ s/\.$/.*/g;
		713	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		714	}
		715	}
		716	}
		717
829	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	718	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
830		719
831	sub verbose {	720	sub verbose {
832	my ($level, $msg) = @_;	721	my ($level, $msg) = @_;
833	warn "$msg\n" if $level <= $verbosity;	722	warn "$msg\n" if $level <= $verbosity;
834	}	723	}
…		…
845	$pkg =~ s/[^[:word:]]/_/g;	734	$pkg =~ s/[^[:word:]]/_/g;
846	$pkg = "urxvt::ext::$pkg";	735	$pkg = "urxvt::ext::$pkg";
847		736
848	verbose 3, "loading extension '$path' into package '$pkg'";	737	verbose 3, "loading extension '$path' into package '$pkg'";
849		738
		739	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		740
850	open my $fh, "<:raw", $path	741	open my $fh, "<:raw", $path
851	or die "$path: $!";	742	or die "$path: $!";
852		743
853	my $source =	744	my $source =
854	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	745	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
855	. "#line 1 \"$path\"\n{\n"	746	. "#line 1 \"$path\"\n{\n"
856	. (do { local $/; <$fh> })	747	. (do { local $/; <$fh> })
857	. "\n};\n1";	748	. "\n};\n1";
858		749
859	eval $source	750	eval $source
…		…
868	# called by the rxvt core	759	# called by the rxvt core
869	sub invoke {	760	sub invoke {
870	local $TERM = shift;	761	local $TERM = shift;
871	my $htype = shift;	762	my $htype = shift;
872		763
873	if ($htype == 0) { # INIT	764	if ($htype == HOOK_INIT) {
874	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	765	$TERM->scan_extensions;
875		766
876	my %ext_arg;	767	my %ext_arg;
877		768
878	{	769	{
879	my @init = @TERM_INIT;	770	my @init = @TERM_INIT;
880	@TERM_INIT = ();	771	@TERM_INIT = ();
…		…
882	my @pkg = @TERM_EXT;	773	my @pkg = @TERM_EXT;
883	@TERM_EXT = ();	774	@TERM_EXT = ();
884	$TERM->register_package ($_) for @pkg;	775	$TERM->register_package ($_) for @pkg;
885	}	776	}
886		777
		778	for (
		779	@{ delete $TERM->{perl_ext_3} },
887	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	780	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		781	) {
888	if ($_ eq "default") {	782	if ($_ eq "default") {
		783
		784	$ext_arg{$_} = []
889	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	785	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
		786
		787	for ($TERM->_keysym_resources) {
		788	next if /^(?:string|command|builtin|builtin-string|perl)/;
		789	next unless /^([A-Za-z0-9_\-]+):/;
		790
		791	my $ext = $1;
		792
		793	$ext_arg{$ext} = [];
		794	}
		795
890	} elsif (/^-(.*)$/) {	796	} elsif (/^-(.*)$/) { # remove from set
891	delete $ext_arg{$1};	797	delete $ext_arg{$1};
892	} elsif (/^([^<]+)<(.*)>$/) {	798
		799	} elsif (/^\/(.*)$/) { # prohibit loading
		800	undef $TERM->{ext_prohibit}{$1};
		801
		802	} elsif (/^([^<]+)(?:<(.*)>)?$/) { # add to set, clear prohibit status
		803	delete $TERM->{ext_prohibit}{$1};
893	push @{ $ext_arg{$1} }, $2;	804	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		805
894	} else {	806	} else {
895	$ext_arg{$_} ||= [];	807	verbose 2, "cannot parse extension specification '$_', ignoring.";
896	}	808	}
897	}	809	}
898		810
		811	$TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
		812	$TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
		813
899	for my $ext (sort keys %ext_arg) {	814	for my $ext (sort keys %ext_arg) {
900	my @files = grep -f $_, map "$_/$ext", @dirs;	815	my $path = $TERM->extension_path ($ext);
901		816
902	if (@files) {	817	if (defined $path) {
903	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});	818	$TERM->autoload_extension ($ext, $ext_arg{$ext});
904	} else {	819	} else {
905	warn "perl extension '$ext' not found in perl library search path\n";	820	verbose 2, "perl extension '$ext' not found in perl library search path";
906	}	821	}
907	}	822	}
908		823
909	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");	824	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
910	warn $@ if $@;	825	warn $@ if $@;
911	}	826	}
912		827
913	$retval = undef;	828	$retval = undef;
914		829
		830	if ($htype == HOOK_OSC_SEQ) {
		831	if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
		832	$TERM->autoload_extension ($_->[0]) for @$exts;
		833	}
		834	} elsif ($htype == HOOK_OSC_SEQ_PERL) {
		835	if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
		836	$TERM->autoload_extension ($_->[0]) for @$exts;
		837	}
		838	}
		839
915	if (my $cb = $TERM->{_hook}[$htype]) {	840	if (my $cb = $TERM->{_hook}[$htype]) {
916	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	841	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
917	if $verbosity >= 10;	842	if $verbosity >= 10;
918		843
		844	if ($htype == HOOK_ACTION) {
		845	# this hook is only sent to the extension with the name
		846	# matching the first arg
		847	my $pkg = shift;
		848	$pkg =~ y/-/_/;
		849	$pkg = "urxvt::ext::$pkg";
		850
		851	$cb = $cb->{$pkg}
		852	or return undef; #TODO: maybe warn user?
		853
		854	$cb = { $pkg => $cb };
		855	}
		856
919	for my $pkg (keys %$cb) {	857	for my $pkg (keys %$cb) {
920	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	858	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
921	$retval ||= $retval_;	859	$retval ||= $retval_;
922		860
923	if ($@) {	861	if ($@) {
924	$TERM->ungrab; # better to lose the grab than the session	862	$TERM->ungrab; # better to lose the grab than the session
925	warn $@;	863	warn $@;
…		…
928		866
929	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	867	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
930	if $verbosity >= 11;	868	if $verbosity >= 11;
931	}	869	}
932		870
933	if ($htype == 1) { # DESTROY	871	if ($htype == HOOK_DESTROY) {
934	# clear package objects	872	# clear package objects
935	%$_ = () for values %{ $TERM->{_pkg} };	873	%$_ = () for values %{ $TERM->{_pkg} };
936		874
937	# clear package	875	# clear package
938	%$TERM = ();	876	%$TERM = ();
…		…
943		881
944	sub SET_COLOR($$$) {	882	sub SET_COLOR($$$) {
945	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	883	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
946	}	884	}
947		885
948	# urxvt::term::extension	886	sub rend2mask {
		887	no strict 'refs';
		888	my ($str, $mask) = (@_, 0);
		889	my %color = ( fg => undef, bg => undef );
		890	my @failed;
		891	for my $spec ( split /\s+/, $str ) {
		892	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		893	$color{lc($1)} = $2;
		894	} else {
		895	my $neg = $spec =~ s/^[-^]//;
		896	unless ( exists &{"RS_$spec"} ) {
		897	push @failed, $spec;
		898	next;
		899	}
		900	my $cur = &{"RS_$spec"};
		901	if ( $neg ) {
		902	$mask &= ~$cur;
		903	} else {
		904	$mask |= $cur;
		905	}
		906	}
		907	}
		908	($mask, @color{qw(fg bg)}, \@failed)
		909	}
949		910
950	package urxvt::term::extension;	911	package urxvt::term::extension;
951		912
952	sub enable {	913	=head2 The C<urxvt::term::extension> class
953	my ($self, %hook) = @_;
954	my $pkg = $self->{_pkg};
955		914
956	while (my ($name, $cb) = each %hook) {	915	Each extension attached to a terminal object is represented by
957	my $htype = $HOOKTYPE{uc $name};	916	a C<urxvt::term::extension> object.
958	defined $htype
959	or Carp::croak "unsupported hook type '$name'";
960		917
961	$self->set_should_invoke ($htype, +1)	918	You can use these objects, which are passed to all callbacks to store any
962	unless exists $self->{term}{_hook}[$htype]{$pkg};	919	state related to the terminal and extension instance.
963		920
964	$self->{term}{_hook}[$htype]{$pkg} = $cb;	921	The methods (And data members) documented below can be called on extension
965	}	922	objects, in addition to call methods documented for the <urxvt::term>
966	}	923	class.
967		924
968	sub disable {	925	=over
969	my ($self, @hook) = @_;
970	my $pkg = $self->{_pkg};
971		926
972	for my $name (@hook) {	927	=item $urxvt_term = $self->{term}
973	my $htype = $HOOKTYPE{uc $name};
974	defined $htype
975	or Carp::croak "unsupported hook type '$name'";
976		928
977	$self->set_should_invoke ($htype, -1)	929	Returns the C<urxvt::term> object associated with this instance of the
978	if delete $self->{term}{_hook}[$htype]{$pkg};	930	extension. This member I<must not> be changed in any way.
979	}	931
980	}	932	=cut
981		933
982	our $AUTOLOAD;	934	our $AUTOLOAD;
983		935
984	sub AUTOLOAD {	936	sub AUTOLOAD {
985	$AUTOLOAD =~ /:([^:]+)$/	937	$AUTOLOAD =~ /:([^:]+)$/
…		…
998		950
999	sub DESTROY {	951	sub DESTROY {
1000	# nop	952	# nop
1001	}	953	}
1002		954
1003	# urxvt::destroy_hook	955	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1004		956
1005	sub urxvt::destroy_hook::DESTROY {	957	sub urxvt::destroy_hook::DESTROY {
1006	${$_[0]}->();	958	${$_[0]}->();
1007	}	959	}
1008		960
1009	sub urxvt::destroy_hook(&) {	961	sub urxvt::destroy_hook(&) {
1010	bless \shift, urxvt::destroy_hook::	962	bless \shift, urxvt::destroy_hook::
1011	}	963	}
		964
		965	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		966
		967	Dynamically enable the given hooks (named without the C<on_> prefix) for
		968	this extension, replacing any hook previously installed via C<enable> in
		969	this extension.
		970
		971	This is useful when you want to overwrite time-critical hooks only
		972	temporarily.
		973
		974	To install additional callbacks for the same hook, you can use the C<on>
		975	method of the C<urxvt::term> class.
		976
		977	=item $self->disable ($hook_name[, $hook_name..])
		978
		979	Dynamically disable the given hooks.
		980
		981	=cut
		982
		983	sub enable {
		984	my ($self, %hook) = @_;
		985	my $pkg = $self->{_pkg};
		986
		987	while (my ($name, $cb) = each %hook) {
		988	my $htype = $HOOKTYPE{uc $name};
		989	defined $htype
		990	or Carp::croak "unsupported hook type '$name'";
		991
		992	$self->set_should_invoke ($htype, +1)
		993	unless exists $self->{term}{_hook}[$htype]{$pkg};
		994
		995	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		996	}
		997	}
		998
		999	sub disable {
		1000	my ($self, @hook) = @_;
		1001	my $pkg = $self->{_pkg};
		1002
		1003	for my $name (@hook) {
		1004	my $htype = $HOOKTYPE{uc $name};
		1005	defined $htype
		1006	or Carp::croak "unsupported hook type '$name'";
		1007
		1008	$self->set_should_invoke ($htype, -1)
		1009	if delete $self->{term}{_hook}[$htype]{$pkg};
		1010	}
		1011	}
		1012
		1013	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		1014
		1015	Similar to the C<enable> enable, but installs additional callbacks for
		1016	the given hook(s) (that is, it doesn't replace existing callbacks), and
		1017	returns a guard object. When the guard object is destroyed the callbacks
		1018	are disabled again.
		1019
		1020	=cut
		1021
		1022	sub urxvt::extension::on_disable::DESTROY {
		1023	my $disable = shift;
		1024
		1025	my $term = delete $disable->{""};
		1026
		1027	while (my ($htype, $id) = each %$disable) {
		1028	delete $term->{_hook}[$htype]{$id};
		1029	$term->set_should_invoke ($htype, -1);
		1030	}
		1031	}
		1032
		1033	sub on {
		1034	my ($self, %hook) = @_;
		1035
		1036	my $term = $self->{term};
		1037
		1038	my %disable = ( "" => $term );
		1039
		1040	while (my ($name, $cb) = each %hook) {
		1041	my $htype = $HOOKTYPE{uc $name};
		1042	defined $htype
		1043	or Carp::croak "unsupported hook type '$name'";
		1044
		1045	$term->set_should_invoke ($htype, +1);
		1046	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		1047	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		1048	}
		1049
		1050	bless \%disable, "urxvt::extension::on_disable"
		1051	}
		1052
		1053	=item $self->bind_action ($hotkey, $action)
		1054
		1055	=item $self->x_resource ($pattern)
		1056
		1057	=item $self->x_resource_boolean ($pattern)
		1058
		1059	These methods support an additional C<%> prefix for C<$action> or
		1060	C<$pattern> when called on an extension object, compared to the
		1061	C<urxvt::term> methods of the same name - see the description of these
		1062	methods in the C<urxvt::term> class for details.
		1063
		1064	=cut
		1065
		1066	sub bind_action {
		1067	my ($self, $hotkey, $action) = @_;
		1068	$action =~ s/^%:/$_[0]{_name}:/;
		1069	$self->{term}->bind_action ($hotkey, $action)
		1070	}
		1071
		1072	sub x_resource {
		1073	my ($self, $name) = @_;
		1074	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1075	$self->{term}->x_resource ($name)
		1076	}
		1077
		1078	sub x_resource_boolean {
		1079	my ($self, $name) = @_;
		1080	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1081	$self->{term}->x_resource_boolean ($name)
		1082	}
		1083
		1084	=back
		1085
		1086	=cut
1012		1087
1013	package urxvt::anyevent;	1088	package urxvt::anyevent;
1014		1089
1015	=head2 The C<urxvt::anyevent> Class	1090	=head2 The C<urxvt::anyevent> Class
1016		1091
1017	The sole purpose of this class is to deliver an interface to the	1092	The sole purpose of this class is to deliver an interface to the
1018	C<AnyEvent> module - any module using it will work inside urxvt without	1093	C<AnyEvent> module - any module using it will work inside urxvt without
1019	further programming. The only exception is that you cannot wait on	1094	further programming. The only exception is that you cannot wait on
1020	condition variables, but non-blocking condvar use is ok. What this means	1095	condition variables, but non-blocking condvar use is ok.
1021	is that you cannot use blocking APIs, but the non-blocking variant should
1022	work.
1023		1096
1024	=cut	1097	In practical terms this means is that you cannot use blocking APIs, but
		1098	the non-blocking variant should work.
1025		1099
		1100	=cut
		1101
1026	our $VERSION = 1;	1102	our $VERSION = '5.23';
1027		1103
1028	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1104	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1029	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1105	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1030		1106
1031	sub timer {	1107	sub timer {
…		…
1033		1109
1034	my $cb = $arg{cb};	1110	my $cb = $arg{cb};
1035		1111
1036	urxvt::timer	1112	urxvt::timer
1037	->new	1113	->new
1038	->start (urxvt::NOW + $arg{after})	1114	->after ($arg{after}, $arg{interval})
1039	->cb (sub {	1115	->cb ($arg{interval} ? $cb : sub {
1040	$_[0]->stop; # need to cancel manually	1116	$_[0]->stop; # need to cancel manually
1041	$cb->();	1117	$cb->();
1042	})	1118	})
1043	}	1119	}
1044		1120
1045	sub io {	1121	sub io {
1046	my ($class, %arg) = @_;	1122	my ($class, %arg) = @_;
1047		1123
1048	my $cb = $arg{cb};	1124	my $cb = $arg{cb};
		1125	my $fd = fileno $arg{fh};
		1126	defined $fd or $fd = $arg{fh};
1049		1127
1050	bless [$arg{fh}, urxvt::iow	1128	bless [$arg{fh}, urxvt::iow
1051	->new	1129	->new
1052	->fd (fileno $arg{fh})	1130	->fd ($fd)
1053	->events (($arg{poll} =~ /r/ ? 1 : 0)	1131	->events (($arg{poll} =~ /r/ ? 1 : 0)
1054	| ($arg{poll} =~ /w/ ? 2 : 0))	1132	| ($arg{poll} =~ /w/ ? 2 : 0))
1055	->start	1133	->start
1056	->cb (sub {	1134	->cb ($cb)
1057	$cb->(($_[1] & 1 ? 'r' : '')
1058	. ($_[1] & 2 ? 'w' : ''));
1059	})],
1060	urxvt::anyevent::	1135	], urxvt::anyevent::
		1136	}
		1137
		1138	sub idle {
		1139	my ($class, %arg) = @_;
		1140
		1141	my $cb = $arg{cb};
		1142
		1143	urxvt::iw
		1144	->new
		1145	->start
		1146	->cb ($cb)
		1147	}
		1148
		1149	sub child {
		1150	my ($class, %arg) = @_;
		1151
		1152	my $cb = $arg{cb};
		1153
		1154	urxvt::pw
		1155	->new
		1156	->start ($arg{pid})
		1157	->cb (sub {
		1158	$_[0]->stop; # need to cancel manually
		1159	$cb->($_[0]->rpid, $_[0]->rstatus);
		1160	})
1061	}	1161	}
1062		1162
1063	sub DESTROY {	1163	sub DESTROY {
1064	$_[0][1]->stop;	1164	$_[0][1]->stop;
1065	}	1165	}
1066		1166
1067	sub condvar {	1167	# only needed for AnyEvent < 6 compatibility
1068	bless \my $flag, urxvt::anyevent::condvar::	1168	sub one_event {
1069	}
1070
1071	sub urxvt::anyevent::condvar::broadcast {
1072	${$_[0]}++;
1073	}
1074
1075	sub urxvt::anyevent::condvar::wait {
1076	unless (${$_[0]}) {
1077	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1169	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1078	}
1079	}	1170	}
1080		1171
1081	package urxvt::term;	1172	package urxvt::term;
1082		1173
1083	=head2 The C<urxvt::term> Class	1174	=head2 The C<urxvt::term> Class
1084		1175
1085	=over 4	1176	=over
1086		1177
1087	=cut	1178	=cut
1088		1179
1089	# find on_xxx subs in the package and register them	1180	# find on_xxx subs in the package and register them
1090	# as hooks	1181	# as hooks
…		…
1096	urxvt::verbose 6, "register package $pkg to $self";	1187	urxvt::verbose 6, "register package $pkg to $self";
1097		1188
1098	@{"$pkg\::ISA"} = urxvt::term::extension::;	1189	@{"$pkg\::ISA"} = urxvt::term::extension::;
1099		1190
1100	my $proxy = bless {	1191	my $proxy = bless {
1101	_pkg => $pkg,	1192	_pkg => $pkg,
		1193	_name => ${"$pkg\::_NAME"}, # hackish
1102	argv => $argv,	1194	argv => $argv,
1103	}, $pkg;	1195	}, $pkg;
1104	Scalar::Util::weaken ($proxy->{term} = $self);	1196	Scalar::Util::weaken ($proxy->{term} = $self);
1105		1197
1106	$self->{_pkg}{$pkg} = $proxy;	1198	$self->{_pkg}{$pkg} = $proxy;
1107		1199
…		…
1110	$proxy->enable ($name => $ref);	1202	$proxy->enable ($name => $ref);
1111	}	1203	}
1112	}	1204	}
1113	}	1205	}
1114		1206
		1207	# map extension name to filesystem path
		1208	sub extension_path {
		1209	(grep -f $_, map "$_/$_[1]", $_[0]->perl_libdirs)[0]
		1210	}
		1211
		1212	# load an extension by name
		1213	sub load_extension_file {
		1214	my ($self, $path, $argv) = @_;
		1215
		1216	$self->register_package (urxvt::extension_package $path, $argv);
		1217	}
		1218
		1219	# autoload an extension unless loading it is prohibited
		1220	sub autoload_extension {
		1221	my ($self, $name, $argv) = @_;
		1222
		1223	return if exists $self->{ext_prohibit}{$name};
		1224
		1225	my $path = $self->extension_path ($name)
		1226	// return urxvt::verbose 2, "perl extension '$name' not found in perl library search path (during autoload)";
		1227
		1228	$self->load_extension_file ($path, $argv);
		1229	}
		1230
		1231	sub perl_libdirs {
		1232	map { split /:/ }
		1233	$_[0]->resource ("perl_lib"),
		1234	$ENV{URXVT_PERL_LIB},
		1235	"$ENV{HOME}/.urxvt/ext",
		1236	"$LIBDIR/perl"
		1237	}
		1238
		1239	# scan for available extensions and collect their metadata
		1240	sub scan_extensions {
		1241	my ($self) = @_;
		1242
		1243	return if exists $self->{meta};
		1244
		1245	my @urxvtdirs = perl_libdirs $self;
		1246	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1247
		1248	$self->{meta} = \my %allmeta;
		1249
		1250	# first gather extensions
		1251
		1252	my $gather = sub {
		1253	my ($dir, $core) = @_;
		1254
		1255	opendir my $fh, $dir
		1256	or return;
		1257
		1258	for my $ext (readdir $fh) {
		1259	$ext !~ /^\./
		1260	or next;
		1261
		1262	open my $fh, "<", "$dir/$ext"
		1263	or next;
		1264
		1265	-f $fh
		1266	or next;
		1267
		1268	$ext =~ s/\.uext$// or $core
		1269	or next;
		1270
		1271	my %meta = (dir => $dir);
		1272
		1273	while (<$fh>) {
		1274	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1275	my ($pattern, $type, $desc) = split /:/, $1;
		1276	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1277	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1278	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1279	} else {
		1280	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1281	}
		1282
		1283	} elsif (/^#:META:OSC:([0-9]+):(.*)/) {
		1284	push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
		1285
		1286	} elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
		1287	push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
		1288
		1289	} elsif (/^\s*(?:#|$)/) {
		1290	# skip other comments and empty lines
		1291
		1292	} else {
		1293	last; # stop parsing on first non-empty non-comment line
		1294	}
		1295	}
		1296
		1297	$allmeta{ext}{$ext} = \%meta;
		1298	}
		1299	};
		1300
		1301	# $gather->($_, 0) for @cpandirs;
		1302	$gather->($_, 1) for @urxvtdirs;
		1303
		1304	# and now merge resources
		1305
		1306	$allmeta{resource} = \my %resource;
		1307
		1308	while (my ($k, $v) = each %{ $allmeta{ext} }) {
		1309	#TODO: should check for extensions overriding each other
		1310	%resource = (%resource, %{ $v->{resource} });
		1311	}
		1312	}
		1313
1115	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1314	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1116		1315
1117	Creates a new terminal, very similar as if you had started it with system	1316	Creates a new terminal, very similar as if you had started it with system
1118	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1317	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1119	hash which defines the environment of the new terminal.	1318	hash which defines the environment of the new terminal.
…		…
1136	}	1335	}
1137		1336
1138	=item $term->destroy	1337	=item $term->destroy
1139		1338
1140	Destroy the terminal object (close the window, free resources	1339	Destroy the terminal object (close the window, free resources
1141	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1340	etc.). Please note that urxvt will not exit as long as any event
1142	watchers (timers, io watchers) are still active.	1341	watchers (timers, io watchers) are still active.
1143		1342
1144	=item $term->exec_async ($cmd[, @args])	1343	=item $term->exec_async ($cmd[, @args])
1145		1344
1146	Works like the combination of the C<fork>/C<exec> builtins, which executes	1345	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1170		1369
1171	Returns true if the option specified by C<$optval> is enabled, and	1370	Returns true if the option specified by C<$optval> is enabled, and
1172	optionally change it. All option values are stored by name in the hash	1371	optionally change it. All option values are stored by name in the hash
1173	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1372	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1174		1373
1175	Here is a a likely non-exhaustive list of option names, please see the	1374	Here is a likely non-exhaustive list of option names, please see the
1176	source file F</src/optinc.h> to see the actual list:	1375	source file F</src/optinc.h> to see the actual list:
1177		1376
1178	borderLess console cursorBlink cursorUnderline hold iconic insecure	1377	borderLess buffered console cursorBlink cursorUnderline hold iconic
1179	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1378	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1180	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1379	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1181	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1380	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1182	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1381	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1183	transparent tripleclickwords utmpInhibit visualBell	1382	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1383	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1184		1384
1185	=item $value = $term->resource ($name[, $newval])	1385	=item $value = $term->resource ($name[, $newval])
1186		1386
1187	Returns the current resource value associated with a given name and	1387	Returns the current resource value associated with a given name and
1188	optionally sets a new value. Setting values is most useful in the C<init>	1388	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1197	likely change).	1397	likely change).
1198		1398
1199	Please note that resource strings will currently only be freed when the	1399	Please note that resource strings will currently only be freed when the
1200	terminal is destroyed, so changing options frequently will eat memory.	1400	terminal is destroyed, so changing options frequently will eat memory.
1201		1401
1202	Here is a a likely non-exhaustive list of resource names, not all of which	1402	Here is a likely non-exhaustive list of resource names, not all of which
1203	are supported in every build, please see the source file F</src/rsinc.h>	1403	are supported in every build, please see the source file F</src/rsinc.h>
1204	to see the actual list:	1404	to see the actual list:
1205		1405
1206	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1406	answerbackstring backgroundPixmap backspace_key blurradius
1207	borderLess color cursorBlink cursorUnderline cutchars delete_key	1407	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1208	display_name embed ext_bwidth fade font geometry hold iconName	1408	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1209	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1409	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1410	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1210	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1411	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1211	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1412	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1212	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1413	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1213	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1414	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1214	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1415	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1215	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1416	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1216	secondaryScreen secondaryScroll selectstyle shade term_name title	1417	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1217	transient_for transparent transparent_all tripleclickwords utmpInhibit	1418	term_name title transient_for transparent tripleclickwords urgentOnBell
1218	visualBell	1419	utmpInhibit visualBell rewrapMode disablePasteBrackets
1219		1420
1220	=cut	1421	=cut
1221		1422
1222	sub resource($$;$) {	1423	sub resource($$;$) {
1223	my ($self, $name) = (shift, shift);	1424	my ($self, $name) = (shift, shift);
1224	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1425	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1225	&urxvt::term::_resource	1426	goto &urxvt::term::_resource
1226	}	1427	}
1227		1428
1228	=item $value = $term->x_resource ($pattern)	1429	=item $value = $term->x_resource ($pattern)
1229		1430
1230	Returns the X-Resource for the given pattern, excluding the program or	1431	Returns the X-Resource for the given pattern, excluding the program or
1231	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1432	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1232	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1433	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1233	resource with that pattern exists.	1434	resource with that pattern exists.
1234		1435
		1436	Extensions that define extra resources also need to call this method
		1437	to access their values.
		1438
		1439	If the method is called on an extension object (basically, from an
		1440	extension), then the special prefix C<%.> will be replaced by the name of
		1441	the extension and a dot, and the lone string C<%> will be replaced by the
		1442	extension name itself. This makes it possible to code extensions so you
		1443	can rename them and get a new set of resources without having to change
		1444	the actual code.
		1445
1235	This method should only be called during the C<on_start> hook, as there is	1446	This method should only be called during the C<on_start> hook, as there is
1236	only one resource database per display, and later invocations might return	1447	only one resource database per display, and later invocations might return
1237	the wrong resources.	1448	the wrong resources.
1238		1449
1239	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1450	=item $value = $term->x_resource_boolean ($pattern)
1240		1451
		1452	Like C<x_resource>, above, but interprets the string value as a boolean
		1453	and returns C<1> for true values, C<0> for false values and C<undef> if
		1454	the resource or option isn't specified.
		1455
		1456	You should always use this method to parse boolean resources.
		1457
		1458	=cut
		1459
		1460	sub x_resource_boolean {
		1461	my $res = &x_resource;
		1462
		1463	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1464	}
		1465
		1466	=item $action = $term->lookup_keysym ($keysym, $state)
		1467
		1468	Returns the action bound to key combination C<($keysym, $state)>,
		1469	if a binding for it exists, and C<undef> otherwise.
		1470
		1471	=item $success = $term->bind_action ($key, $action)
		1472
1241	Adds a keymap translation exactly as specified via a resource. See the	1473	Adds a key binding exactly as specified via a C<keysym> resource. See the
1242	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1474	C<keysym> resource in the urxvt(1) manpage.
		1475
		1476	To add default bindings for actions, an extension should call C<<
		1477	->bind_action >> in its C<init> hook for every such binding. Doing it
		1478	in the C<init> hook allows users to override or remove the binding
		1479	again.
		1480
		1481	Example: the C<searchable-scrollback> by default binds itself
		1482	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1483	$term->bind_action >>.
		1484
		1485	sub init {
		1486	my ($self) = @_;
		1487
		1488	$self->bind_action ("M-s" => "%:start");
		1489	}
1243		1490
1244	=item $rend = $term->rstyle ([$new_rstyle])	1491	=item $rend = $term->rstyle ([$new_rstyle])
1245		1492
1246	Return and optionally change the current rendition. Text that is output by	1493	Return and optionally change the current rendition. Text that is output by
1247	the terminal application will use this style.	1494	the terminal application will use this style.
…		…
1255		1502
1256	=item ($row, $col) = $term->selection_beg ([$row, $col])	1503	=item ($row, $col) = $term->selection_beg ([$row, $col])
1257		1504
1258	=item ($row, $col) = $term->selection_end ([$row, $col])	1505	=item ($row, $col) = $term->selection_end ([$row, $col])
1259		1506
1260	Return the current values of the selection mark, begin or end positions,	1507	Return the current values of the selection mark, begin or end positions.
1261	and optionally set them to new values.	1508
		1509	When arguments are given, then the selection coordinates are set to
		1510	C<$row> and C<$col>, and the selection screen is set to the current
		1511	screen.
		1512
		1513	=item $screen = $term->selection_screen ([$screen])
		1514
		1515	Returns the current selection screen, and then optionally sets it.
1262		1516
1263	=item $term->selection_make ($eventtime[, $rectangular])	1517	=item $term->selection_make ($eventtime[, $rectangular])
1264		1518
1265	Tries to make a selection as set by C<selection_beg> and	1519	Tries to make a selection as set by C<selection_beg> and
1266	C<selection_end>. If C<$rectangular> is true (default: false), a	1520	C<selection_end>. If C<$rectangular> is true (default: false), a
1267	rectangular selection will be made. This is the prefered function to make	1521	rectangular selection will be made. This is the preferred function to make
1268	a selection.	1522	a selection.
1269		1523
1270	=item $success = $term->selection_grab ($eventtime)	1524	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1271		1525
1272	Try to request the primary selection text from the server (for example, as	1526	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1527	true) selection from the server. The corresponding text can be set
1273	set by the next method). No visual feedback will be given. This function	1528	with the next method. No visual feedback will be given. This function
1274	is mostly useful from within C<on_sel_grab> hooks.	1529	is mostly useful from within C<on_sel_grab> hooks.
1275		1530
1276	=item $oldtext = $term->selection ([$newtext])	1531	=item $oldtext = $term->selection ([$newtext, $clipboard])
1277		1532
1278	Return the current selection text and optionally replace it by C<$newtext>.	1533	Return the current selection (clipboard if C<$clipboard> is true) text
		1534	and optionally replace it by C<$newtext>.
		1535
		1536	=item $term->selection_clear ([$clipboard])
		1537
		1538	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1279		1539
1280	=item $term->overlay_simple ($x, $y, $text)	1540	=item $term->overlay_simple ($x, $y, $text)
1281		1541
1282	Create a simple multi-line overlay box. See the next method for details.	1542	Create a simple multi-line overlay box. See the next method for details.
1283		1543
…		…
1311	This method returns an urxvt::overlay object. The overlay will be visible	1571	This method returns an urxvt::overlay object. The overlay will be visible
1312	as long as the perl object is referenced.	1572	as long as the perl object is referenced.
1313		1573
1314	The methods currently supported on C<urxvt::overlay> objects are:	1574	The methods currently supported on C<urxvt::overlay> objects are:
1315		1575
1316	=over 4	1576	=over
1317		1577
1318	=item $overlay->set ($x, $y, $text, $rend)	1578	=item $overlay->set ($x, $y, $text[, $rend])
1319		1579
1320	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1580	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1321	text in rxvt-unicode's special encoding and an array of rendition values	1581	text in rxvt-unicode's special encoding and an array of rendition values
1322	at a specific position inside the overlay.	1582	at a specific position inside the overlay.
		1583
		1584	If C<$rend> is missing, then the rendition will not be changed.
1323		1585
1324	=item $overlay->hide	1586	=item $overlay->hide
1325		1587
1326	If visible, hide the overlay, but do not destroy it.	1588	If visible, hide the overlay, but do not destroy it.
1327		1589
…		…
1390		1652
1391	=item $term->scr_add_lines ($string)	1653	=item $term->scr_add_lines ($string)
1392		1654
1393	Write the given text string to the screen, as if output by the application	1655	Write the given text string to the screen, as if output by the application
1394	running inside the terminal. It may not contain command sequences (escape	1656	running inside the terminal. It may not contain command sequences (escape
1395	codes), but is free to use line feeds, carriage returns and tabs. The	1657	codes - see C<cmd_parse> for that), but is free to use line feeds,
1396	string is a normal text string, not in locale-dependent encoding.	1658	carriage returns and tabs. The string is a normal text string, not in
		1659	locale-dependent encoding.
1397		1660
1398	Normally its not a good idea to use this function, as programs might be	1661	Normally its not a good idea to use this function, as programs might be
1399	confused by changes in cursor position or scrolling. Its useful inside a	1662	confused by changes in cursor position or scrolling. Its useful inside a
1400	C<on_add_lines> hook, though.	1663	C<on_add_lines> hook, though.
1401		1664
…		…
1409	locale-specific encoding of the terminal and can contain command sequences	1672	locale-specific encoding of the terminal and can contain command sequences
1410	(escape codes) that will be interpreted.	1673	(escape codes) that will be interpreted.
1411		1674
1412	=item $term->tt_write ($octets)	1675	=item $term->tt_write ($octets)
1413		1676
1414	Write the octets given in C<$data> to the tty (i.e. as program input). To	1677	Write the octets given in C<$octets> to the tty (i.e. as user input
		1678	to the program, see C<cmd_parse> for the opposite direction). To pass
1415	pass characters instead of octets, you should convert your strings first	1679	characters instead of octets, you should convert your strings first to the
1416	to the locale-specific encoding using C<< $term->locale_encode >>.	1680	locale-specific encoding using C<< $term->locale_encode >>.
		1681
		1682	=item $term->tt_write_user_input ($octets)
		1683
		1684	Like C<tt_write>, but should be used when writing strings in response to
		1685	the user pressing a key, to invoke the additional actions requested by
		1686	the user for that case (C<tt_write> doesn't do that).
		1687
		1688	The typical use case would be inside C<on_action> hooks.
		1689
		1690	=item $term->tt_paste ($octets)
		1691
		1692	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1693	CR and bracketing the data with control sequences if bracketed paste mode
		1694	is set.
1417		1695
1418	=item $old_events = $term->pty_ev_events ([$new_events])	1696	=item $old_events = $term->pty_ev_events ([$new_events])
1419		1697
1420	Replaces the event mask of the pty watcher by the given event mask. Can	1698	Replaces the event mask of the pty watcher by the given event mask. Can
1421	be used to suppress input and output handling to the pty/tty. See the	1699	be used to suppress input and output handling to the pty/tty. See the
…		…
1440	Adds the specified events to the vt event mask. Useful e.g. when you want	1718	Adds the specified events to the vt event mask. Useful e.g. when you want
1441	to receive pointer events all the times:	1719	to receive pointer events all the times:
1442		1720
1443	$term->vt_emask_add (urxvt::PointerMotionMask);	1721	$term->vt_emask_add (urxvt::PointerMotionMask);
1444		1722
		1723	=item $term->set_urgency ($set)
		1724
		1725	Enable/disable the urgency hint on the toplevel window.
		1726
1445	=item $term->focus_in	1727	=item $term->focus_in
1446		1728
1447	=item $term->focus_out	1729	=item $term->focus_out
1448		1730
1449	=item $term->key_press ($state, $keycode[, $time])	1731	=item $term->key_press ($state, $keycode[, $time])
1450		1732
1451	=item $term->key_release ($state, $keycode[, $time])	1733	=item $term->key_release ($state, $keycode[, $time])
1452		1734
1453	Deliver various fake events to to terminal.	1735	Deliver various fake events to to terminal.
1454		1736
1455	=item $window_width = $term->width	1737	=item $window_width = $term->width ([$new_value])
1456		1738
1457	=item $window_height = $term->height	1739	=item $window_height = $term->height ([$new_value])
1458		1740
1459	=item $font_width = $term->fwidth	1741	=item $font_width = $term->fwidth ([$new_value])
1460		1742
1461	=item $font_height = $term->fheight	1743	=item $font_height = $term->fheight ([$new_value])
1462		1744
1463	=item $font_ascent = $term->fbase	1745	=item $font_ascent = $term->fbase ([$new_value])
1464		1746
1465	=item $terminal_rows = $term->nrow	1747	=item $terminal_rows = $term->nrow ([$new_value])
1466		1748
1467	=item $terminal_columns = $term->ncol	1749	=item $terminal_columns = $term->ncol ([$new_value])
1468		1750
1469	=item $has_focus = $term->focus	1751	=item $has_focus = $term->focus ([$new_value])
1470		1752
1471	=item $is_mapped = $term->mapped	1753	=item $is_mapped = $term->mapped ([$new_value])
1472		1754
1473	=item $max_scrollback = $term->saveLines	1755	=item $max_scrollback = $term->saveLines ([$new_value])
1474		1756
1475	=item $nrow_plus_saveLines = $term->total_rows	1757	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1476		1758
1477	=item $topmost_scrollback_row = $term->top_row	1759	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1478		1760
1479	Return various integers describing terminal characteristics.	1761	Return various integers describing terminal characteristics. If an
		1762	argument is given, changes the value and returns the previous one.
1480		1763
1481	=item $x_display = $term->display_id	1764	=item $x_display = $term->display_id
1482		1765
1483	Return the DISPLAY used by rxvt-unicode.	1766	Return the DISPLAY used by rxvt-unicode.
1484		1767
…		…
1519		1802
1520	Returns the currently displayed screen (0 primary, 1 secondary).	1803	Returns the currently displayed screen (0 primary, 1 secondary).
1521		1804
1522	=item $cursor_is_hidden = $term->hidden_cursor	1805	=item $cursor_is_hidden = $term->hidden_cursor
1523		1806
1524	Returns wether the cursor is currently hidden or not.	1807	Returns whether the cursor is currently hidden or not.
		1808
		1809	=item $priv_modes = $term->priv_modes
		1810
		1811	Returns a bitset with the state of DEC private modes.
		1812
		1813	Example:
		1814
		1815	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1816	# mouse reporting is turned on
		1817	}
1525		1818
1526	=item $view_start = $term->view_start ([$newvalue])	1819	=item $view_start = $term->view_start ([$newvalue])
1527		1820
1528	Returns the row number of the topmost displayed line. Maximum value is	1821	Returns the row number of the topmost displayed line and changes it,
1529	C<0>, which displays the normal terminal contents. Lower values scroll	1822	if an argument is given. Values greater than or equal to C<0> display
1530	this many lines into the scrollback buffer.	1823	the terminal contents. Lower values scroll this many lines into the
		1824	scrollback buffer.
1531		1825
1532	=item $term->want_refresh	1826	=item $term->want_refresh
1533		1827
1534	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1828	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1535	compare the on-screen display with its stored representation. If they	1829	compare the on-screen display with its stored representation. If they
1536	differ, it redraws the differences.	1830	differ, it redraws the differences.
1537		1831
1538	Used after changing terminal contents to display them.	1832	Used after changing terminal contents to display them.
1539		1833
		1834	=item $term->refresh_check
		1835
		1836	Checks if a refresh has been requested and, if so, schedules one.
		1837
1540	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1838	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1541		1839
1542	Returns the text of the entire row with number C<$row_number>. Row C<0>	1840	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1543	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1841	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1544	terminal line. The scrollback buffer starts at line C<-1> and extends to
1545	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1842	terminal line. Nothing will be returned if a nonexistent line
1546	is requested.	1843	is requested.
1547		1844
1548	If C<$new_text> is specified, it will replace characters in the current	1845	If C<$new_text> is specified, it will replace characters in the current
1549	line, starting at column C<$start_col> (default C<0>), which is useful	1846	line, starting at column C<$start_col> (default C<0>), which is useful
1550	to replace only parts of a line. The font index in the rendition will	1847	to replace only parts of a line. The font index in the rendition will
1551	automatically be updated.	1848	automatically be updated.
1552		1849
1553	C<$text> is in a special encoding: tabs and wide characters that use more	1850	C<$text> is in a special encoding: tabs and wide characters that use more
1554	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1851	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1555	characters. Characters with combining characters and other characters that	1852	characters. Characters with combining characters and other characters that
1556	do not fit into the normal tetx encoding will be replaced with characters	1853	do not fit into the normal text encoding will be replaced with characters
1557	in the private use area.	1854	in the private use area.
1558		1855
1559	You have to obey this encoding when changing text. The advantage is	1856	You have to obey this encoding when changing text. The advantage is
1560	that C<substr> and similar functions work on screen cells and not on	1857	that C<substr> and similar functions work on screen cells and not on
1561	characters.	1858	characters.
…		…
1590		1887
1591	Create and return a new C<urxvt::line> object that stores information	1888	Create and return a new C<urxvt::line> object that stores information
1592	about the logical line that row C<$row_number> is part of. It supports the	1889	about the logical line that row C<$row_number> is part of. It supports the
1593	following methods:	1890	following methods:
1594		1891
1595	=over 4	1892	=over
1596		1893
1597	=item $text = $line->t ([$new_text])	1894	=item $text = $line->t ([$new_text])
1598		1895
1599	Returns or replaces the full text of the line, similar to C<ROW_t>	1896	Returns or replaces the full text of the line, similar to C<ROW_t>
1600		1897
…		…
1646	}	1943	}
1647		1944
1648	sub urxvt::line::t {	1945	sub urxvt::line::t {
1649	my ($self) = @_;	1946	my ($self) = @_;
1650		1947
1651	if (@_ > 1)	1948	if (@_ > 1) {
1652	{
1653	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1949	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1654	for $self->{beg} .. $self->{end};	1950	for $self->{beg} .. $self->{end};
1655	}	1951	}
1656		1952
1657	defined wantarray &&	1953	defined wantarray &&
1658	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1954	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1659	0, $self->{len}	1955	0, $self->{len}
1660	}	1956	}
1661		1957
1662	sub urxvt::line::r {	1958	sub urxvt::line::r {
1663	my ($self) = @_;	1959	my ($self) = @_;
1664		1960
1665	if (@_ > 1)	1961	if (@_ > 1) {
1666	{
1667	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1962	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1668	for $self->{beg} .. $self->{end};	1963	for $self->{beg} .. $self->{end};
1669	}	1964	}
1670		1965
1671	if (defined wantarray) {	1966	if (defined wantarray) {
1672	my $rend = [	1967	my $rend = [
1673	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1968	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1674	];	1969	];
…		…
1706	where one character corresponds to one screen cell. See	2001	where one character corresponds to one screen cell. See
1707	C<< $term->ROW_t >> for details.	2002	C<< $term->ROW_t >> for details.
1708		2003
1709	=item $string = $term->special_decode $text	2004	=item $string = $term->special_decode $text
1710		2005
1711	Converts rxvt-unicodes text reprsentation into a perl string. See	2006	Converts rxvt-unicode's text representation into a perl string. See
1712	C<< $term->ROW_t >> for details.	2007	C<< $term->ROW_t >> for details.
1713		2008
1714	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2009	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1715		2010
1716	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2011	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1719	manpage.	2014	manpage.
1720		2015
1721	=item $success = $term->grab ($eventtime[, $sync])	2016	=item $success = $term->grab ($eventtime[, $sync])
1722		2017
1723	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2018	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1724	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2019	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1725		2020
1726	=item $term->allow_events_async	2021	=item $term->allow_events_async
1727		2022
1728	Calls XAllowEvents with AsyncBoth for the most recent grab.	2023	Calls XAllowEvents with AsyncBoth for the most recent grab.
1729		2024
…		…
1736	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2031	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1737	recent grab.	2032	recent grab.
1738		2033
1739	=item $term->ungrab	2034	=item $term->ungrab
1740		2035
1741	Calls XUngrab for the most recent grab. Is called automatically on	2036	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1742	evaluation errors, as it is better to lose the grab in the error case as	2037	evaluation errors, as it is better to lose the grab in the error case as
1743	the session.	2038	the session.
1744		2039
1745	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2040	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1746		2041
…		…
1748		2043
1749	=item @atoms = $term->XListProperties ($window)	2044	=item @atoms = $term->XListProperties ($window)
1750		2045
1751	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2046	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1752		2047
1753	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2048	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1754		2049
1755	=item $term->XDeleteProperty ($window, $property)	2050	=item $term->XDeleteProperty ($window, $property)
1756		2051
1757	=item $window = $term->DefaultRootWindow	2052	=item $window = $term->DefaultRootWindow
1758		2053
…		…
1765	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2060	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1766		2061
1767	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2062	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1768		2063
1769	=item $term->XChangeInput ($window, $add_events[, $del_events])	2064	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2065
		2066	=item $keysym = $term->XStringToKeysym ($string)
		2067
		2068	=item $string = $term->XKeysymToString ($keysym)
1770		2069
1771	Various X or X-related functions. The C<$term> object only serves as	2070	Various X or X-related functions. The C<$term> object only serves as
1772	the source of the display, otherwise those functions map more-or-less	2071	the source of the display, otherwise those functions map more-or-less
1773	directory onto the X functions of the same name.	2072	directly onto the X functions of the same name.
1774		2073
1775	=back	2074	=back
1776		2075
1777	=cut	2076	=cut
1778		2077
1779	package urxvt::popup;	2078	package urxvt::popup;
1780		2079
1781	=head2 The C<urxvt::popup> Class	2080	=head2 The C<urxvt::popup> Class
1782		2081
1783	=over 4	2082	=over
1784		2083
1785	=cut	2084	=cut
1786		2085
1787	sub add_item {	2086	sub add_item {
1788	my ($self, $item) = @_;	2087	my ($self, $item) = @_;
…		…
1880	my $env = $self->{term}->env;	2179	my $env = $self->{term}->env;
1881	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2180	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1882	delete $env->{LC_ALL};	2181	delete $env->{LC_ALL};
1883	$env->{LC_CTYPE} = $self->{term}->locale;	2182	$env->{LC_CTYPE} = $self->{term}->locale;
1884		2183
1885	urxvt::term->new ($env, "popup",	2184	my $term = urxvt::term->new (
		2185	$env, "popup",
1886	"--perl-lib" => "", "--perl-ext-common" => "",	2186	"--perl-lib" => "", "--perl-ext-common" => "",
1887	"-pty-fd" => -1, "-sl" => 0,	2187	"-pty-fd" => -1, "-sl" => 0,
1888	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2188	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1889	"--transient-for" => $self->{term}->parent,	2189	"--transient-for" => $self->{term}->parent,
1890	"-display" => $self->{term}->display_id,	2190	"-display" => $self->{term}->display_id,
1891	"-pe" => "urxvt-popup")	2191	"-pe" => "urxvt-popup",
1892	or die "unable to create popup window\n";	2192	) or die "unable to create popup window\n";
		2193
		2194	unless (delete $term->{urxvt_popup_init_done}) {
		2195	$term->ungrab;
		2196	$term->destroy;
		2197	die "unable to initialise popup window\n";
		2198	}
1893	}	2199	}
1894		2200
1895	sub DESTROY {	2201	sub DESTROY {
1896	my ($self) = @_;	2202	my ($self) = @_;
1897		2203
…		…
1902	=back	2208	=back
1903		2209
1904	=cut	2210	=cut
1905		2211
1906	package urxvt::watcher;	2212	package urxvt::watcher;
1907
1908	@urxvt::timer::ISA = __PACKAGE__;
1909	@urxvt::iow::ISA = __PACKAGE__;
1910	@urxvt::pw::ISA = __PACKAGE__;
1911	@urxvt::iw::ISA = __PACKAGE__;
1912		2213
1913	=head2 The C<urxvt::timer> Class	2214	=head2 The C<urxvt::timer> Class
1914		2215
1915	This class implements timer watchers/events. Time is represented as a	2216	This class implements timer watchers/events. Time is represented as a
1916	fractional number of seconds since the epoch. Example:	2217	fractional number of seconds since the epoch. Example:
…		…
1920	->new	2221	->new
1921	->interval (1)	2222	->interval (1)
1922	->cb (sub {	2223	->cb (sub {
1923	$term->{overlay}->set (0, 0,	2224	$term->{overlay}->set (0, 0,
1924	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2225	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1925	});	2226	});
1926		2227
1927	=over 4	2228	=over
1928		2229
1929	=item $timer = new urxvt::timer	2230	=item $timer = new urxvt::timer
1930		2231
1931	Create a new timer object in started state. It is scheduled to fire	2232	Create a new timer object in started state. It is scheduled to fire
1932	immediately.	2233	immediately.
1933		2234
1934	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2235	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1935		2236
1936	Set the callback to be called when the timer triggers.	2237	Set the callback to be called when the timer triggers.
1937		2238
1938	=item $tstamp = $timer->at
1939
1940	Return the time this watcher will fire next.
1941
1942	=item $timer = $timer->set ($tstamp)	2239	=item $timer = $timer->set ($tstamp[, $interval])
1943		2240
1944	Set the time the event is generated to $tstamp.	2241	Set the time the event is generated to $tstamp (and optionally specifies a
		2242	new $interval).
1945		2243
1946	=item $timer = $timer->interval ($interval)	2244	=item $timer = $timer->interval ($interval)
1947		2245
1948	Normally (and when C<$interval> is C<0>), the timer will automatically	2246	By default (and when C<$interval> is C<0>), the timer will automatically
1949	stop after it has fired once. If C<$interval> is non-zero, then the timer	2247	stop after it has fired once. If C<$interval> is non-zero, then the timer
1950	is automatically rescheduled at the given intervals.	2248	is automatically rescheduled at the given intervals.
1951		2249
1952	=item $timer = $timer->start	2250	=item $timer = $timer->start
1953		2251
1954	Start the timer.	2252	Start the timer.
1955		2253
1956	=item $timer = $timer->start ($tstamp)	2254	=item $timer = $timer->start ($tstamp[, $interval])
1957		2255
1958	Set the event trigger time to C<$tstamp> and start the timer.	2256	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2257	also replaces the interval.
1959		2258
1960	=item $timer = $timer->after ($delay)	2259	=item $timer = $timer->after ($delay[, $interval])
1961		2260
1962	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2261	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1963		2262
1964	=item $timer = $timer->stop	2263	=item $timer = $timer->stop
1965		2264
…		…
1973		2272
1974	$term->{socket} = ...	2273	$term->{socket} = ...
1975	$term->{iow} = urxvt::iow	2274	$term->{iow} = urxvt::iow
1976	->new	2275	->new
1977	->fd (fileno $term->{socket})	2276	->fd (fileno $term->{socket})
1978	->events (urxvt::EVENT_READ)	2277	->events (urxvt::EV_READ)
1979	->start	2278	->start
1980	->cb (sub {	2279	->cb (sub {
1981	my ($iow, $revents) = @_;	2280	my ($iow, $revents) = @_;
1982	# $revents must be 1 here, no need to check	2281	# $revents must be 1 here, no need to check
1983	sysread $term->{socket}, my $buf, 8192	2282	sysread $term->{socket}, my $buf, 8192
1984	or end-of-file;	2283	or end-of-file;
1985	});	2284	});
1986		2285
1987		2286
1988	=over 4	2287	=over
1989		2288
1990	=item $iow = new urxvt::iow	2289	=item $iow = new urxvt::iow
1991		2290
1992	Create a new io watcher object in stopped state.	2291	Create a new io watcher object in stopped state.
1993		2292
…		…
1996	Set the callback to be called when io events are triggered. C<$reventmask>	2295	Set the callback to be called when io events are triggered. C<$reventmask>
1997	is a bitset as described in the C<events> method.	2296	is a bitset as described in the C<events> method.
1998		2297
1999	=item $iow = $iow->fd ($fd)	2298	=item $iow = $iow->fd ($fd)
2000		2299
2001	Set the filedescriptor (not handle) to watch.	2300	Set the file descriptor (not handle) to watch.
2002		2301
2003	=item $iow = $iow->events ($eventmask)	2302	=item $iow = $iow->events ($eventmask)
2004		2303
2005	Set the event mask to watch. The only allowed values are	2304	Set the event mask to watch. The only allowed values are
2006	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2305	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2007	together, or C<urxvt::EVENT_NONE>.	2306	together, or C<urxvt::EV_NONE>.
2008		2307
2009	=item $iow = $iow->start	2308	=item $iow = $iow->start
2010		2309
2011	Start watching for requested events on the given handle.	2310	Start watching for requested events on the given handle.
2012		2311
2013	=item $iow = $iow->stop	2312	=item $iow = $iow->stop
2014		2313
2015	Stop watching for events on the given filehandle.	2314	Stop watching for events on the given file handle.
2016		2315
2017	=back	2316	=back
2018		2317
2019	=head2 The C<urxvt::iw> Class	2318	=head2 The C<urxvt::iw> Class
2020		2319
2021	This class implements idle watchers, that get called automatically when	2320	This class implements idle watchers, that get called automatically when
2022	the process is idle. They should return as fast as possible, after doing	2321	the process is idle. They should return as fast as possible, after doing
2023	some useful work.	2322	some useful work.
2024		2323
2025	=over 4	2324	=over
2026		2325
2027	=item $iw = new urxvt::iw	2326	=item $iw = new urxvt::iw
2028		2327
2029	Create a new idle watcher object in stopped state.	2328	Create a new idle watcher object in stopped state.
2030		2329
…		…
2053	->new	2352	->new
2054	->start ($pid)	2353	->start ($pid)
2055	->cb (sub {	2354	->cb (sub {
2056	my ($pw, $exit_status) = @_;	2355	my ($pw, $exit_status) = @_;
2057	...	2356	...
2058	});	2357	});
2059		2358
2060	=over 4	2359	=over
2061		2360
2062	=item $pw = new urxvt::pw	2361	=item $pw = new urxvt::pw
2063		2362
2064	Create a new process watcher in stopped state.	2363	Create a new process watcher in stopped state.
2065		2364
…		…
2067		2366
2068	Set the callback to be called when the timer triggers.	2367	Set the callback to be called when the timer triggers.
2069		2368
2070	=item $pw = $timer->start ($pid)	2369	=item $pw = $timer->start ($pid)
2071		2370
2072	Tells the wqtcher to start watching for process C<$pid>.	2371	Tells the watcher to start watching for process C<$pid>.
2073		2372
2074	=item $pw = $pw->stop	2373	=item $pw = $pw->stop
2075		2374
2076	Stop the watcher.	2375	Stop the watcher.
2077		2376
…		…
2082	=head2 URXVT_PERL_VERBOSITY	2381	=head2 URXVT_PERL_VERBOSITY
2083		2382
2084	This variable controls the verbosity level of the perl extension. Higher	2383	This variable controls the verbosity level of the perl extension. Higher
2085	numbers indicate more verbose output.	2384	numbers indicate more verbose output.
2086		2385
2087	=over 4	2386	=over
2088		2387
2089	=item == 0 - fatal messages	2388	=item == 0 - fatal messages only
		2389
		2390	=item >= 2 - general warnings (default level)
2090		2391
2091	=item >= 3 - script loading and management	2392	=item >= 3 - script loading and management
2092		2393
2093	=item >=10 - all called hooks	2394	=item >=10 - all called hooks
2094		2395
2095	=item >=11 - hook reutrn values	2396	=item >=11 - hook return values
2096		2397
2097	=back	2398	=back
2098		2399
2099	=head1 AUTHOR	2400	=head1 AUTHOR
2100		2401
2101	Marc Lehmann <pcg@goof.com>	2402	Marc Lehmann <schmorp@schmorp.de>
2102	http://software.schmorp.de/pkg/rxvt-unicode	2403	http://software.schmorp.de/pkg/rxvt-unicode
2103		2404
2104	=cut	2405	=cut
2105		2406
2106	1	2407	1
		2408
		2409	# vim: sw=3:

Diff Legend

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