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.138 by root, Sat Mar 4 22:36:50 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	=item readline (enabled by default)
157
158	A support package that tries to make editing with readline easier. At
159	the moment, it reacts to clicking shift-left mouse button by trying to
160	move the text cursor to this position. It does so by generating as many
161	cursor-left or cursor-right keypresses as required (the this only works
162	for programs that correctly support wide characters).
163
164	To avoid too many false positives, this is only done when:
165
166	=over 4
167
168	=item - the tty is in ICANON state.
169
170	=item - the text cursor is visible.
171
172	=item - the primary screen is currently being displayed.
173
174	=item - the mouse is on the same (multi-row-) line as the text cursor.
175
176	=back
177
178	The normal selection mechanism isn't disabled, so quick successive clicks
179	might interfere with selection creation in harmless ways.
180
181	=item selection-autotransform
182
183	This selection allows you to do automatic transforms on a selection
184	whenever a selection is made.
185
186	It works by specifying perl snippets (most useful is a single C<s///>
187	operator) that modify C<$_> as resources:
188
189	URxvt.selection-autotransform.0: transform
190	URxvt.selection-autotransform.1: transform
191	...
192
193	For example, the following will transform selections of the form
194	C<filename:number>, often seen in compiler messages, into C<vi +$filename
195	$word>:
196
197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
198
199	And this example matches the same,but replaces it with vi-commands you can
200	paste directly into your (vi :) editor:
201
202	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
203
204	Of course, this can be modified to suit your needs and your editor :)
205
206	To expand the example above to typical perl error messages ("XXX at
207	FILENAME line YYY."), you need a slightly more elaborate solution:
208
209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
210	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
211
212	The first line tells the selection code to treat the unchanging part of
213	every error message as a selection pattern, and the second line transforms
214	the message into vi commands to load the file.
215
216	=item tabbed
217
218	This transforms the terminal into a tabbar with additional terminals, that
219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
220	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
221	button per tab.
222
223	Clicking a button will activate that tab. Pressing B<Shift-Left> and
224	B<Shift-Right> will switch to the tab left or right of the current one,
225	while B<Shift-Down> creates a new tab.
226
227	The tabbar itself can be configured similarly to a normal terminal, but
228	with a resource class of C<URxvt.tabbed>. In addition, it supports the
229	following four resources (shown with defaults):
230
231	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
232	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
233	URxvt.tabbed.tab-fg: <colour-index, default 0>
234	URxvt.tabbed.tab-bg: <colour-index, default 1>
235
236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
237	indices.
238
239	=item mark-urls
240
241	Uses per-line display filtering (C<on_line_update>) to underline urls and
242	make them clickable. When middle-clicked, the program specified in the
243	resource C<urlLauncher> (default C<x-www-browser>) will be started with
244	the URL as first argument.
245
246	=item xim-onthespot
247
248	This (experimental) perl extension implements OnTheSpot editing. It does
249	not work perfectly, and some input methods don't seem to work well with
250	OnTheSpot editing in general, but it seems to work at leats for SCIM and
251	kinput2.
252
253	You enable it by specifying this extension and a preedit style of
254	C<OnTheSpot>, i.e.:
255
256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257
258	=item automove-background
259
260	This is basically a one-line extension that dynamically changes the background pixmap offset
261	to the window position, in effect creating the same effect as pseudo transparency with
262	a custom pixmap. No scaling is supported in this mode. Exmaple:
263
264	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
265
266	=item block-graphics-to-ascii
267
268	A not very useful example of filtering all text output to the terminal,
269	by replacing all line-drawing characters (U+2500 .. U+259F) by a
270	similar-looking ascii character.
271
272	=item digital-clock
273
274	Displays a digital clock using the built-in overlay.
275
276	=item remote-clipboard
277
278	Somewhat of a misnomer, this extension adds two menu entries to the
279	selection popup that allows one ti run external commands to store the
280	selection somewhere and fetch it again.
281
282	We use it to implement a "distributed selection mechanism", which just
283	means that one command uploads the file to a remote server, and another
284	reads it.
285
286	The commands can be set using the C<URxvt.remote-selection.store> and
287	C<URxvt.remote-selection.fetch> resources. The first should read the
288	selection to store from STDIN (always in UTF-8), the second should provide
289	the selection data on STDOUT (also in UTF-8).
290
291	The defaults (which are likely useless to you) use rsh and cat:
292
293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
295
296	=item selection-pastebin
297
298	This is a little rarely useful extension that Uploads the selection as
299	textfile to a remote site (or does other things). (The implementation is
300	not currently secure for use in a multiuser environment as it writes to
301	F</tmp> directly.).
302
303	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
304	i.e.
305
306	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
307
308	Pressing this combination runs a command with C<%> replaced by the name of
309	the textfile. This command can be set via a resource:
310
311	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
312
313	And the default is likely not useful to anybody but the few people around
314	here :)
315
316	The name of the textfile is the hex encoded md5 sum of the selection, so
317	the same content should lead to the same filename.
318
319	After a successful upload the selection will be replaced by the text given
320	in the C<selection-pastebin-url> resource (again, the % is the placeholder
321	for the filename):
322
323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
324
325	=item example-refresh-hooks
326
327	Displays a very simple digital clock in the upper right corner of the
328	window. Illustrates overwriting the refresh callbacks to create your own
329	overlays or changes.
330
331	=back
332		56
333	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
334		58
335	=head2 General API Considerations	59	=head2 General API Considerations
336		60
…		…
346	terminal is destroyed.	70	terminal is destroyed.
347		71
348	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
349	hints on what they mean:	73	hints on what they mean:
350		74
351	=over 4	75	=over
352		76
353	=item $text	77	=item $text
354		78
355	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
356	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.
357		81
358	=item $string	82	=item $string
359		83
360	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
…		…
364	=item $octets	88	=item $octets
365		89
366	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
367	locale-specific way.	91	locale-specific way.
368		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
369	=back	99	=back
370		100
371	=head2 Extension Objects	101	=head2 Extension Objects
372		102
373	Very 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
374	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,
375	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
376	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
377	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
378	use.	109	internal use.
379		110
380	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
381	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
382		113
383	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.
384		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
385	=over 4	128	=over
386		129
387	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
388		131
389	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
390	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.
391		135
392	=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.
393		138
394	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
395	this extension, replacing any previous hook. This is useful when you want	140	comment:
396	to overwrite time-critical hooks only temporarily.
397		141
398	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
399		143
400	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
401		183
402	=back	184	=back
403		185
404	=head2 Hooks	186	=head2 Hooks
405		187
406	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
407	called whenever the relevant event happens.	189	called whenever the relevant event happens.
408		190
409	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
410	the in the C<Extension Objects> section.	192	the in the C<Extension Objects> section.
411		193
412	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
413	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
414	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
415		197
416	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
417		199
418	=over 4	200	=over
419		201
420	=item on_init $term	202	=item on_init $term
421		203
422	Called after a new terminal object has been initialized, but before	204	Called after a new terminal object has been initialized, but before
423	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
…		…
427	place.	209	place.
428		210
429	=item on_start $term	211	=item on_start $term
430		212
431	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
432	trying to map (display) the toplevel and returning to the mainloop.	214	trying to map (display) the toplevel and returning to the main loop.
433		215
434	=item on_destroy $term	216	=item on_destroy $term
435		217
436	Called whenever something tries to destroy terminal, when the terminal is	218	Called whenever something tries to destroy terminal, when the terminal is
437	still fully functional (not for long, though).	219	still fully functional (not for long, though).
…		…
464		246
465	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
466	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
467	by calling C<< $term->selection >>.	249	by calling C<< $term->selection >>.
468		250
469	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.
470		252
471	=item on_sel_extend $term	253	=item on_sel_extend $term
472		254
473	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
474	click) and is either supposed to return false (normal operation), or	256	click) and is either supposed to return false (normal operation), or
475	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
476	processing. This can happen multiple times, as long as the callback	258	processing. This can happen multiple times, as long as the callback
477	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
478	supposed to enlarge the selection more and more, if possible.	260	supposed to enlarge the selection more and more, if possible.
479		261
480	See the F<selection> example extension.	262	See the F<selection> example extension.
481		263
482	=item on_view_change $term, $offset	264	=item on_view_change $term, $offset
483		265
484	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
485	scrolls. Offset C<0> means display the normal terminal, positive values	267	scrolls. Offset C<0> means display the normal terminal, positive values
486	show this many lines of scrollback.	268	show this many lines of scrollback.
487		269
488	=item on_scroll_back $term, $lines, $saved	270	=item on_scroll_back $term, $lines, $saved
489		271
…		…
493		275
494	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,
495	$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
496	number of lines that will be in the scrollback buffer.	278	number of lines that will be in the scrollback buffer.
497		279
498	=item on_osc_seq $term, $op, $args	280	=item on_osc_seq $term, $op, $args, $resp
499		281
500	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
501	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
502	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
503	confused by recursive invocations when you output an osc sequence within	285	confused by recursive invocations when you output an OSC sequence within
504	this callback.	286	this callback.
505		287
506	C<on_osc_seq_perl> should be used for new behaviour.	288	C<on_osc_seq_perl> should be used for new behaviour.
507		289
508	=item on_osc_seq_perl $term, $string	290	=item on_osc_seq_perl $term, $args, $resp
509		291
510	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	292	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
511	operating system command) is processed. Cursor position and other state	293	(OSC = operating system command) is processed. Cursor position and other
512	information is up-to-date when this happens. For interoperability, the	294	state information is up-to-date when this happens. For interoperability,
513	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
514	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
515	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	}
516		308
517	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,
518	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
519	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.
520		315
521	=item on_add_lines $term, $string	316	=item on_add_lines $term, $string
522		317
523	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
524	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
…		…
529	=item on_tt_write $term, $octets	324	=item on_tt_write $term, $octets
530		325
531	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
532	suppress or filter tty input.	327	suppress or filter tty input.
533		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
534	=item on_line_update $term, $row	336	=item on_line_update $term, $row
535		337
536	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
537	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
538	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,
…		…
545	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
546	you cannot just toggle rendition bits, but only set them.	348	you cannot just toggle rendition bits, but only set them.
547		349
548	=item on_refresh_begin $term	350	=item on_refresh_begin $term
549		351
550	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
551	or similar effects by modify terminal contents in refresh_begin, and	353	similar effects by modifying the terminal contents in refresh_begin, and
552	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
553	code is run after this hook, and takes precedence.	355	code is run after this hook, and takes precedence.
554		356
555	=item on_refresh_end $term	357	=item on_refresh_end $term
556		358
557	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>.
558		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
559	=item on_user_command $term, $string	369	=item on_user_command $term, $string *DEPRECATED*
560		370
561	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
562	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>
563	resource in the @@RXVT_NAME@@(1) manpage).	373	resource in the urxvt(1) manpage).
564		374
565	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
566	slightly in the future.	376	preference to the C<on_action> hook.
567		377
568	=item on_resize_all_windows $tern, $new_width, $new_height	378	=item on_resize_all_windows $term, $new_width, $new_height
569		379
570	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
571	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
572	returns TRUE, setting of the window hints is being skipped.	382	returns a true value, setting of the window hints is being skipped.
573		383
574	=item on_x_event $term, $event	384	=item on_x_event $term, $event
575		385
576	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
577	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
578	members are not passed.	388	members are not passed.
579		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
580	=item on_focus_in $term	394	=item on_focus_in $term
581		395
582	Called whenever the window gets the keyboard focus, before rxvt-unicode	396	Called whenever the window gets the keyboard focus, before rxvt-unicode
583	does focus in processing.	397	does focus in processing.
584		398
585	=item on_focus_out $term	399	=item on_focus_out $term
586		400
587	Called wheneever the window loses keyboard focus, before rxvt-unicode does	401	Called whenever the window loses keyboard focus, before rxvt-unicode does
588	focus out processing.	402	focus out processing.
589		403
590	=item on_configure_notify $term, $event	404	=item on_configure_notify $term, $event
591		405
592	=item on_property_notify $term, $event	406	=item on_property_notify $term, $event
…		…
603		417
604	=item on_map_notify $term, $event	418	=item on_map_notify $term, $event
605		419
606	=item on_unmap_notify $term, $event	420	=item on_unmap_notify $term, $event
607		421
608	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
609	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.
610		424
611	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
612	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
613	(real, not screen-based) row and column under the mouse cursor.	427	(real, not screen-based) row and column under the mouse cursor.
614		428
615	C<on_key_press> additionally receives the string rxvt-unicode would	429	C<on_key_press> additionally receives the string rxvt-unicode would
616	output, if any, in locale-specific encoding.	430	output, if any, in locale-specific encoding.
617		431
618	subwindow.
619
620	=item on_client_message $term, $event	432	=item on_client_message $term, $event
621		433
622	=item on_wm_protocols $term, $event	434	=item on_wm_protocols $term, $event
623		435
624	=item on_wm_delete_window $term, $event	436	=item on_wm_delete_window $term, $event
625		437
626	Called when various types of ClientMessage events are received (all with	438	Called when various types of ClientMessage events are received (all with
627	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	439	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
628		440
		441	=item on_bell $term
		442
		443	Called on receipt of a bell character.
		444
629	=back	445	=back
630		446
631	=cut	447	=cut
632		448
633	package urxvt;	449	package urxvt;
634		450
635	use utf8;	451	use utf8;
636	use strict;	452	use strict qw(vars subs);
637	use Carp ();	453	use Carp ();
638	use Scalar::Util ();	454	use Scalar::Util ();
639	use List::Util ();	455	use List::Util ();
640		456
641	our $VERSION = 1;	457	our $VERSION = 1;
642	our $TERM;	458	our $TERM;
643	our @TERM_INIT;	459	our @TERM_INIT; # should go, prevents async I/O etc.
644	our @TERM_EXT;	460	our @TERM_EXT; # should go, prevents async I/O etc.
645	our @HOOKNAME;	461	our @HOOKNAME;
646	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	462	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
647	our %OPTION;	463	our %OPTION;
648		464
649	our $LIBDIR;	465	our $LIBDIR;
…		…
653		469
654	our $NOCHAR = chr 0xffff;	470	our $NOCHAR = chr 0xffff;
655		471
656	=head2 Variables in the C<urxvt> Package	472	=head2 Variables in the C<urxvt> Package
657		473
658	=over 4	474	=over
659		475
660	=item $urxvt::LIBDIR	476	=item $urxvt::LIBDIR
661		477
662	The rxvt-unicode library directory, where, among other things, the perl	478	The rxvt-unicode library directory, where, among other things, the perl
663	modules and scripts are stored.	479	modules and scripts are stored.
…		…
675	The current terminal. This variable stores the current C<urxvt::term>	491	The current terminal. This variable stores the current C<urxvt::term>
676	object, whenever a callback/hook is executing.	492	object, whenever a callback/hook is executing.
677		493
678	=item @urxvt::TERM_INIT	494	=item @urxvt::TERM_INIT
679		495
680	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
681	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
682	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,
683	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.
684		500
685	This complements to the perl-eval commandline option, but gets executed	501	This complements to the perl-eval command line option, but gets executed
686	first.	502	first.
687		503
688	=item @urxvt::TERM_EXT	504	=item @urxvt::TERM_EXT
689		505
690	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
…		…
693		509
694	=back	510	=back
695		511
696	=head2 Functions in the C<urxvt> Package	512	=head2 Functions in the C<urxvt> Package
697		513
698	=over 4	514	=over
699		515
700	=item urxvt::fatal $errormessage	516	=item urxvt::fatal $errormessage
701		517
702	Fatally aborts execution with the given error message. Avoid at all	518	Fatally aborts execution with the given error message (which should
703	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
704	starts up.	520	is acceptable (and useful) is in the init hook, where it prevents the
		521	terminal from starting up.
705		522
706	=item urxvt::warn $string	523	=item urxvt::warn $string
707		524
708	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
709	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
710	that calls this function.	527	that calls this function.
711		528
712	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
713	correct place, e.g. on stderr of the connecting urxvtc client.	530	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
715	Messages have a size limit of 1023 bytes currently.	532	Messages have a size limit of 1023 bytes currently.
716		533
717	=item @terms = urxvt::termlist	534	=item @terms = urxvt::termlist
718		535
719	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
720	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
721	objects that have perl extensions attached will be returned (because there	538	objects that have perl extensions attached will be returned (because there
722	is no urxvt::term objet associated with others).	539	is no urxvt::term object associated with others).
723		540
724	=item $time = urxvt::NOW	541	=item $time = urxvt::NOW
725		542
726	Returns the "current time" (as per the event loop).	543	Returns the "current time" (as per the event loop).
727		544
…		…
747	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	564	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
748	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	565	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
749		566
750	Various constants for use in X calls and event processing.	567	Various constants for use in X calls and event processing.
751		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
752	=back	581	=back
753		582
754	=head2 RENDITION	583	=head2 RENDITION
755		584
756	Rendition bitsets contain information about colour, font, font styles and	585	Rendition bitsets contain information about colour, font, font styles and
…		…
759	The following "macros" deal with changes in rendition sets. You should	588	The following "macros" deal with changes in rendition sets. You should
760	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,
761	as they contain important information required for correct operation of	590	as they contain important information required for correct operation of
762	rxvt-unicode.	591	rxvt-unicode.
763		592
764	=over 4	593	=over
765		594
766	=item $rend = urxvt::DEFAULT_RSTYLE	595	=item $rend = urxvt::DEFAULT_RSTYLE
767		596
768	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
769	being reset. Useful as a base to start when creating renditions.	598	being reset. Useful as a base to start when creating renditions.
770		599
771	=item $rend = urxvt::OVERLAY_RSTYLE	600	=item $rend = urxvt::OVERLAY_RSTYLE
772		601
773	Return the rendition mask used for overlays by default.	602	Return the rendition mask used for overlays by default.
774		603
775	=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
776		606
777	Return the bit that enabled bold, italic, blink, reverse-video and	607	Return the bit that enabled bold, italic, blink, reverse-video and
778	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
779	the bitset.	609	the bitset.
780		610
…		…
817	};	647	};
818	}	648	}
819		649
820	no warnings 'utf8';	650	no warnings 'utf8';
821		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
822	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	718	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
823		719
824	sub verbose {	720	sub verbose {
825	my ($level, $msg) = @_;	721	my ($level, $msg) = @_;
826	warn "$msg\n" if $level <= $verbosity;	722	warn "$msg\n" if $level <= $verbosity;
827	}	723	}
…		…
838	$pkg =~ s/[^[:word:]]/_/g;	734	$pkg =~ s/[^[:word:]]/_/g;
839	$pkg = "urxvt::ext::$pkg";	735	$pkg = "urxvt::ext::$pkg";
840		736
841	verbose 3, "loading extension '$path' into package '$pkg'";	737	verbose 3, "loading extension '$path' into package '$pkg'";
842		738
		739	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		740
843	open my $fh, "<:raw", $path	741	open my $fh, "<:raw", $path
844	or die "$path: $!";	742	or die "$path: $!";
845		743
846	my $source =	744	my $source =
847	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	745	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
848	. "#line 1 \"$path\"\n{\n"	746	. "#line 1 \"$path\"\n{\n"
849	. (do { local $/; <$fh> })	747	. (do { local $/; <$fh> })
850	. "\n};\n1";	748	. "\n};\n1";
851		749
852	eval $source	750	eval $source
…		…
861	# called by the rxvt core	759	# called by the rxvt core
862	sub invoke {	760	sub invoke {
863	local $TERM = shift;	761	local $TERM = shift;
864	my $htype = shift;	762	my $htype = shift;
865		763
866	if ($htype == 0) { # INIT	764	if ($htype == HOOK_INIT) {
867	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	765	$TERM->scan_extensions;
868		766
869	my %ext_arg;	767	my %ext_arg;
870		768
871	{	769	{
872	my @init = @TERM_INIT;	770	my @init = @TERM_INIT;
873	@TERM_INIT = ();	771	@TERM_INIT = ();
…		…
875	my @pkg = @TERM_EXT;	773	my @pkg = @TERM_EXT;
876	@TERM_EXT = ();	774	@TERM_EXT = ();
877	$TERM->register_package ($_) for @pkg;	775	$TERM->register_package ($_) for @pkg;
878	}	776	}
879		777
		778	for (
		779	@{ delete $TERM->{perl_ext_3} },
880	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	780	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		781	) {
881	if ($_ eq "default") {	782	if ($_ eq "default") {
		783
		784	$ext_arg{$_} = []
882	$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
883	} elsif (/^-(.*)$/) {	796	} elsif (/^-(.*)$/) { # remove from set
884	delete $ext_arg{$1};	797	delete $ext_arg{$1};
885	} 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};
886	push @{ $ext_arg{$1} }, $2;	804	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		805
887	} else {	806	} else {
888	$ext_arg{$_} ||= [];	807	verbose 2, "cannot parse extension specification '$_', ignoring.";
889	}	808	}
890	}	809	}
891		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
892	for my $ext (sort keys %ext_arg) {	814	for my $ext (sort keys %ext_arg) {
893	my @files = grep -f $_, map "$_/$ext", @dirs;	815	my $path = $TERM->extension_path ($ext);
894		816
895	if (@files) {	817	if (defined $path) {
896	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});	818	$TERM->autoload_extension ($ext, $ext_arg{$ext});
897	} else {	819	} else {
898	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";
899	}	821	}
900	}	822	}
901		823
902	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");
903	warn $@ if $@;	825	warn $@ if $@;
904	}	826	}
905		827
906	$retval = undef;	828	$retval = undef;
907		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
908	if (my $cb = $TERM->{_hook}[$htype]) {	840	if (my $cb = $TERM->{_hook}[$htype]) {
909	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	841	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
910	if $verbosity >= 10;	842	if $verbosity >= 10;
911		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
912	for my $pkg (keys %$cb) {	857	for my $pkg (keys %$cb) {
913	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	858	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
914	$retval ||= $retval_;	859	$retval ||= $retval_;
915		860
916	if ($@) {	861	if ($@) {
917	$TERM->ungrab; # better to lose the grab than the session	862	$TERM->ungrab; # better to lose the grab than the session
918	warn $@;	863	warn $@;
…		…
921		866
922	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	867	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
923	if $verbosity >= 11;	868	if $verbosity >= 11;
924	}	869	}
925		870
926	if ($htype == 1) { # DESTROY	871	if ($htype == HOOK_DESTROY) {
927	# clear package objects	872	# clear package objects
928	%$_ = () for values %{ $TERM->{_pkg} };	873	%$_ = () for values %{ $TERM->{_pkg} };
929		874
930	# clear package	875	# clear package
931	%$TERM = ();	876	%$TERM = ();
…		…
936		881
937	sub SET_COLOR($$$) {	882	sub SET_COLOR($$$) {
938	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	883	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
939	}	884	}
940		885
941	# 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	}
942		910
943	package urxvt::term::extension;	911	package urxvt::term::extension;
944		912
945	sub enable {	913	=head2 The C<urxvt::term::extension> class
946	my ($self, %hook) = @_;
947	my $pkg = $self->{_pkg};
948		914
949	while (my ($name, $cb) = each %hook) {	915	Each extension attached to a terminal object is represented by
950	my $htype = $HOOKTYPE{uc $name};	916	a C<urxvt::term::extension> object.
951	defined $htype
952	or Carp::croak "unsupported hook type '$name'";
953		917
954	$self->set_should_invoke ($htype, +1)	918	You can use these objects, which are passed to all callbacks to store any
955	unless exists $self->{term}{_hook}[$htype]{$pkg};	919	state related to the terminal and extension instance.
956		920
957	$self->{term}{_hook}[$htype]{$pkg} = $cb;	921	The methods (And data members) documented below can be called on extension
958	}	922	objects, in addition to call methods documented for the <urxvt::term>
959	}	923	class.
960		924
961	sub disable {	925	=over
962	my ($self, @hook) = @_;
963	my $pkg = $self->{_pkg};
964		926
965	for my $name (@hook) {	927	=item $urxvt_term = $self->{term}
966	my $htype = $HOOKTYPE{uc $name};
967	defined $htype
968	or Carp::croak "unsupported hook type '$name'";
969		928
970	$self->set_should_invoke ($htype, -1)	929	Returns the C<urxvt::term> object associated with this instance of the
971	if delete $self->{term}{_hook}[$htype]{$pkg};	930	extension. This member I<must not> be changed in any way.
972	}	931
973	}	932	=cut
974		933
975	our $AUTOLOAD;	934	our $AUTOLOAD;
976		935
977	sub AUTOLOAD {	936	sub AUTOLOAD {
978	$AUTOLOAD =~ /:([^:]+)$/	937	$AUTOLOAD =~ /:([^:]+)$/
…		…
991		950
992	sub DESTROY {	951	sub DESTROY {
993	# nop	952	# nop
994	}	953	}
995		954
996	# urxvt::destroy_hook	955	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
997		956
998	sub urxvt::destroy_hook::DESTROY {	957	sub urxvt::destroy_hook::DESTROY {
999	${$_[0]}->();	958	${$_[0]}->();
1000	}	959	}
1001		960
1002	sub urxvt::destroy_hook(&) {	961	sub urxvt::destroy_hook(&) {
1003	bless \shift, urxvt::destroy_hook::	962	bless \shift, urxvt::destroy_hook::
1004	}	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
1005		1087
1006	package urxvt::anyevent;	1088	package urxvt::anyevent;
1007		1089
1008	=head2 The C<urxvt::anyevent> Class	1090	=head2 The C<urxvt::anyevent> Class
1009		1091
1010	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
1011	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
1012	further programming. The only exception is that you cannot wait on	1094	further programming. The only exception is that you cannot wait on
1013	condition variables, but non-blocking condvar use is ok. What this means	1095	condition variables, but non-blocking condvar use is ok.
1014	is that you cannot use blocking APIs, but the non-blocking variant should
1015	work.
1016		1096
1017	=cut	1097	In practical terms this means is that you cannot use blocking APIs, but
		1098	the non-blocking variant should work.
1018		1099
		1100	=cut
		1101
1019	our $VERSION = 1;	1102	our $VERSION = '5.23';
1020		1103
1021	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1104	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1022	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1105	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1023		1106
1024	sub timer {	1107	sub timer {
…		…
1026		1109
1027	my $cb = $arg{cb};	1110	my $cb = $arg{cb};
1028		1111
1029	urxvt::timer	1112	urxvt::timer
1030	->new	1113	->new
1031	->start (urxvt::NOW + $arg{after})	1114	->after ($arg{after}, $arg{interval})
1032	->cb (sub {	1115	->cb ($arg{interval} ? $cb : sub {
1033	$_[0]->stop; # need to cancel manually	1116	$_[0]->stop; # need to cancel manually
1034	$cb->();	1117	$cb->();
1035	})	1118	})
1036	}	1119	}
1037		1120
1038	sub io {	1121	sub io {
1039	my ($class, %arg) = @_;	1122	my ($class, %arg) = @_;
1040		1123
1041	my $cb = $arg{cb};	1124	my $cb = $arg{cb};
		1125	my $fd = fileno $arg{fh};
		1126	defined $fd or $fd = $arg{fh};
1042		1127
1043	bless [$arg{fh}, urxvt::iow	1128	bless [$arg{fh}, urxvt::iow
1044	->new	1129	->new
1045	->fd (fileno $arg{fh})	1130	->fd ($fd)
1046	->events (($arg{poll} =~ /r/ ? 1 : 0)	1131	->events (($arg{poll} =~ /r/ ? 1 : 0)
1047	| ($arg{poll} =~ /w/ ? 2 : 0))	1132	| ($arg{poll} =~ /w/ ? 2 : 0))
1048	->start	1133	->start
1049	->cb (sub {	1134	->cb ($cb)
1050	$cb->(($_[1] & 1 ? 'r' : '')
1051	. ($_[1] & 2 ? 'w' : ''));
1052	})],
1053	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	})
1054	}	1161	}
1055		1162
1056	sub DESTROY {	1163	sub DESTROY {
1057	$_[0][1]->stop;	1164	$_[0][1]->stop;
1058	}	1165	}
1059		1166
1060	sub condvar {	1167	# only needed for AnyEvent < 6 compatibility
1061	bless \my $flag, urxvt::anyevent::condvar::	1168	sub one_event {
1062	}
1063
1064	sub urxvt::anyevent::condvar::broadcast {
1065	${$_[0]}++;
1066	}
1067
1068	sub urxvt::anyevent::condvar::wait {
1069	unless (${$_[0]}) {
1070	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";
1071	}
1072	}	1170	}
1073		1171
1074	package urxvt::term;	1172	package urxvt::term;
1075		1173
1076	=head2 The C<urxvt::term> Class	1174	=head2 The C<urxvt::term> Class
1077		1175
1078	=over 4	1176	=over
1079		1177
1080	=cut	1178	=cut
1081		1179
1082	# find on_xxx subs in the package and register them	1180	# find on_xxx subs in the package and register them
1083	# as hooks	1181	# as hooks
…		…
1089	urxvt::verbose 6, "register package $pkg to $self";	1187	urxvt::verbose 6, "register package $pkg to $self";
1090		1188
1091	@{"$pkg\::ISA"} = urxvt::term::extension::;	1189	@{"$pkg\::ISA"} = urxvt::term::extension::;
1092		1190
1093	my $proxy = bless {	1191	my $proxy = bless {
1094	_pkg => $pkg,	1192	_pkg => $pkg,
		1193	_name => ${"$pkg\::_NAME"}, # hackish
1095	argv => $argv,	1194	argv => $argv,
1096	}, $pkg;	1195	}, $pkg;
1097	Scalar::Util::weaken ($proxy->{term} = $self);	1196	Scalar::Util::weaken ($proxy->{term} = $self);
1098		1197
1099	$self->{_pkg}{$pkg} = $proxy;	1198	$self->{_pkg}{$pkg} = $proxy;
1100		1199
…		…
1103	$proxy->enable ($name => $ref);	1202	$proxy->enable ($name => $ref);
1104	}	1203	}
1105	}	1204	}
1106	}	1205	}
1107		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
1108	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1314	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1109		1315
1110	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
1111	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
1112	hash which defines the environment of the new terminal.	1318	hash which defines the environment of the new terminal.
…		…
1129	}	1335	}
1130		1336
1131	=item $term->destroy	1337	=item $term->destroy
1132		1338
1133	Destroy the terminal object (close the window, free resources	1339	Destroy the terminal object (close the window, free resources
1134	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
1135	watchers (timers, io watchers) are still active.	1341	watchers (timers, io watchers) are still active.
1136		1342
1137	=item $term->exec_async ($cmd[, @args])	1343	=item $term->exec_async ($cmd[, @args])
1138		1344
1139	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
…		…
1163		1369
1164	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
1165	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
1166	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.
1167		1373
1168	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
1169	source file F</src/optinc.h> to see the actual list:	1375	source file F</src/optinc.h> to see the actual list:
1170		1376
1171	borderLess console cursorBlink cursorUnderline hold iconic insecure	1377	borderLess buffered console cursorBlink cursorUnderline hold iconic
1172	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1378	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1173	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1379	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1174	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1380	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1175	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1381	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1176	transparent tripleclickwords utmpInhibit visualBell	1382	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1383	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1177		1384
1178	=item $value = $term->resource ($name[, $newval])	1385	=item $value = $term->resource ($name[, $newval])
1179		1386
1180	Returns the current resource value associated with a given name and	1387	Returns the current resource value associated with a given name and
1181	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>
…		…
1190	likely change).	1397	likely change).
1191		1398
1192	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
1193	terminal is destroyed, so changing options frequently will eat memory.	1400	terminal is destroyed, so changing options frequently will eat memory.
1194		1401
1195	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
1196	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>
1197	to see the actual list:	1404	to see the actual list:
1198		1405
1199	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1406	answerbackstring backgroundPixmap backspace_key blurradius
1200	borderLess color cursorBlink cursorUnderline cutchars delete_key	1407	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1201	display_name embed ext_bwidth fade font geometry hold iconName	1408	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1202	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
1203	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1411	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1204	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1412	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1205	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1413	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1206	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1414	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1207	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1415	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1208	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1416	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1209	secondaryScreen secondaryScroll selectstyle shade term_name title	1417	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1210	transient_for transparent transparent_all tripleclickwords utmpInhibit	1418	term_name title transient_for transparent tripleclickwords urgentOnBell
1211	visualBell	1419	utmpInhibit visualBell rewrapMode disablePasteBrackets
1212		1420
1213	=cut	1421	=cut
1214		1422
1215	sub resource($$;$) {	1423	sub resource($$;$) {
1216	my ($self, $name) = (shift, shift);	1424	my ($self, $name) = (shift, shift);
1217	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1425	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1218	&urxvt::term::_resource	1426	goto &urxvt::term::_resource
1219	}	1427	}
1220		1428
1221	=item $value = $term->x_resource ($pattern)	1429	=item $value = $term->x_resource ($pattern)
1222		1430
1223	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
1224	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
1225	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
1226	resource with that pattern exists.	1434	resource with that pattern exists.
1227		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
1228	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
1229	only one resource database per display, and later invocations might return	1447	only one resource database per display, and later invocations might return
1230	the wrong resources.	1448	the wrong resources.
1231		1449
1232	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1450	=item $value = $term->x_resource_boolean ($pattern)
1233		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
1234	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
1235	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	}
1236		1490
1237	=item $rend = $term->rstyle ([$new_rstyle])	1491	=item $rend = $term->rstyle ([$new_rstyle])
1238		1492
1239	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
1240	the terminal application will use this style.	1494	the terminal application will use this style.
…		…
1248		1502
1249	=item ($row, $col) = $term->selection_beg ([$row, $col])	1503	=item ($row, $col) = $term->selection_beg ([$row, $col])
1250		1504
1251	=item ($row, $col) = $term->selection_end ([$row, $col])	1505	=item ($row, $col) = $term->selection_end ([$row, $col])
1252		1506
1253	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.
1254	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.
1255		1516
1256	=item $term->selection_make ($eventtime[, $rectangular])	1517	=item $term->selection_make ($eventtime[, $rectangular])
1257		1518
1258	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
1259	C<selection_end>. If C<$rectangular> is true (default: false), a	1520	C<selection_end>. If C<$rectangular> is true (default: false), a
1260	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
1261	a selection.	1522	a selection.
1262		1523
1263	=item $success = $term->selection_grab ($eventtime)	1524	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1264		1525
1265	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
1266	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
1267	is mostly useful from within C<on_sel_grab> hooks.	1529	is mostly useful from within C<on_sel_grab> hooks.
1268		1530
1269	=item $oldtext = $term->selection ([$newtext])	1531	=item $oldtext = $term->selection ([$newtext, $clipboard])
1270		1532
1271	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.
1272		1539
1273	=item $term->overlay_simple ($x, $y, $text)	1540	=item $term->overlay_simple ($x, $y, $text)
1274		1541
1275	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.
1276		1543
…		…
1304	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
1305	as long as the perl object is referenced.	1572	as long as the perl object is referenced.
1306		1573
1307	The methods currently supported on C<urxvt::overlay> objects are:	1574	The methods currently supported on C<urxvt::overlay> objects are:
1308		1575
1309	=over 4	1576	=over
1310		1577
1311	=item $overlay->set ($x, $y, $text, $rend)	1578	=item $overlay->set ($x, $y, $text[, $rend])
1312		1579
1313	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
1314	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
1315	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.
1316		1585
1317	=item $overlay->hide	1586	=item $overlay->hide
1318		1587
1319	If visible, hide the overlay, but do not destroy it.	1588	If visible, hide the overlay, but do not destroy it.
1320		1589
…		…
1383		1652
1384	=item $term->scr_add_lines ($string)	1653	=item $term->scr_add_lines ($string)
1385		1654
1386	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
1387	running inside the terminal. It may not contain command sequences (escape	1656	running inside the terminal. It may not contain command sequences (escape
1388	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,
1389	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.
1390		1660
1391	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
1392	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
1393	C<on_add_lines> hook, though.	1663	C<on_add_lines> hook, though.
1394		1664
…		…
1402	locale-specific encoding of the terminal and can contain command sequences	1672	locale-specific encoding of the terminal and can contain command sequences
1403	(escape codes) that will be interpreted.	1673	(escape codes) that will be interpreted.
1404		1674
1405	=item $term->tt_write ($octets)	1675	=item $term->tt_write ($octets)
1406		1676
1407	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
1408	pass characters instead of octets, you should convert your strings first	1679	characters instead of octets, you should convert your strings first to the
1409	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.
1410		1695
1411	=item $old_events = $term->pty_ev_events ([$new_events])	1696	=item $old_events = $term->pty_ev_events ([$new_events])
1412		1697
1413	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
1414	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
…		…
1433	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
1434	to receive pointer events all the times:	1719	to receive pointer events all the times:
1435		1720
1436	$term->vt_emask_add (urxvt::PointerMotionMask);	1721	$term->vt_emask_add (urxvt::PointerMotionMask);
1437		1722
		1723	=item $term->set_urgency ($set)
		1724
		1725	Enable/disable the urgency hint on the toplevel window.
		1726
1438	=item $term->focus_in	1727	=item $term->focus_in
1439		1728
1440	=item $term->focus_out	1729	=item $term->focus_out
1441		1730
1442	=item $term->key_press ($state, $keycode[, $time])	1731	=item $term->key_press ($state, $keycode[, $time])
1443		1732
1444	=item $term->key_release ($state, $keycode[, $time])	1733	=item $term->key_release ($state, $keycode[, $time])
1445		1734
1446	Deliver various fake events to to terminal.	1735	Deliver various fake events to to terminal.
1447		1736
1448	=item $window_width = $term->width	1737	=item $window_width = $term->width ([$new_value])
1449		1738
1450	=item $window_height = $term->height	1739	=item $window_height = $term->height ([$new_value])
1451		1740
1452	=item $font_width = $term->fwidth	1741	=item $font_width = $term->fwidth ([$new_value])
1453		1742
1454	=item $font_height = $term->fheight	1743	=item $font_height = $term->fheight ([$new_value])
1455		1744
1456	=item $font_ascent = $term->fbase	1745	=item $font_ascent = $term->fbase ([$new_value])
1457		1746
1458	=item $terminal_rows = $term->nrow	1747	=item $terminal_rows = $term->nrow ([$new_value])
1459		1748
1460	=item $terminal_columns = $term->ncol	1749	=item $terminal_columns = $term->ncol ([$new_value])
1461		1750
1462	=item $has_focus = $term->focus	1751	=item $has_focus = $term->focus ([$new_value])
1463		1752
1464	=item $is_mapped = $term->mapped	1753	=item $is_mapped = $term->mapped ([$new_value])
1465		1754
1466	=item $max_scrollback = $term->saveLines	1755	=item $max_scrollback = $term->saveLines ([$new_value])
1467		1756
1468	=item $nrow_plus_saveLines = $term->total_rows	1757	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1469		1758
1470	=item $topmost_scrollback_row = $term->top_row	1759	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1471		1760
1472	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.
1473		1763
1474	=item $x_display = $term->display_id	1764	=item $x_display = $term->display_id
1475		1765
1476	Return the DISPLAY used by rxvt-unicode.	1766	Return the DISPLAY used by rxvt-unicode.
1477		1767
…		…
1512		1802
1513	Returns the currently displayed screen (0 primary, 1 secondary).	1803	Returns the currently displayed screen (0 primary, 1 secondary).
1514		1804
1515	=item $cursor_is_hidden = $term->hidden_cursor	1805	=item $cursor_is_hidden = $term->hidden_cursor
1516		1806
1517	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	}
1518		1818
1519	=item $view_start = $term->view_start ([$newvalue])	1819	=item $view_start = $term->view_start ([$newvalue])
1520		1820
1521	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,
1522	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
1523	this many lines into the scrollback buffer.	1823	the terminal contents. Lower values scroll this many lines into the
		1824	scrollback buffer.
1524		1825
1525	=item $term->want_refresh	1826	=item $term->want_refresh
1526		1827
1527	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1828	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1528	compare the on-screen display with its stored representation. If they	1829	compare the on-screen display with its stored representation. If they
1529	differ, it redraws the differences.	1830	differ, it redraws the differences.
1530		1831
1531	Used after changing terminal contents to display them.	1832	Used after changing terminal contents to display them.
1532		1833
		1834	=item $term->refresh_check
		1835
		1836	Checks if a refresh has been requested and, if so, schedules one.
		1837
1533	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1838	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1534		1839
1535	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 >>
1536	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
1537	terminal line. The scrollback buffer starts at line C<-1> and extends to
1538	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1842	terminal line. Nothing will be returned if a nonexistent line
1539	is requested.	1843	is requested.
1540		1844
1541	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
1542	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
1543	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
1544	automatically be updated.	1848	automatically be updated.
1545		1849
1546	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
1547	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)
1548	characters. Characters with combining characters and other characters that	1852	characters. Characters with combining characters and other characters that
1549	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
1550	in the private use area.	1854	in the private use area.
1551		1855
1552	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
1553	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
1554	characters.	1858	characters.
…		…
1583		1887
1584	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
1585	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
1586	following methods:	1890	following methods:
1587		1891
1588	=over 4	1892	=over
1589		1893
1590	=item $text = $line->t ([$new_text])	1894	=item $text = $line->t ([$new_text])
1591		1895
1592	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>
1593		1897
…		…
1639	}	1943	}
1640		1944
1641	sub urxvt::line::t {	1945	sub urxvt::line::t {
1642	my ($self) = @_;	1946	my ($self) = @_;
1643		1947
1644	if (@_ > 1)	1948	if (@_ > 1) {
1645	{
1646	$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})
1647	for $self->{beg} .. $self->{end};	1950	for $self->{beg} .. $self->{end};
1648	}	1951	}
1649		1952
1650	defined wantarray &&	1953	defined wantarray &&
1651	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1954	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1652	0, $self->{len}	1955	0, $self->{len}
1653	}	1956	}
1654		1957
1655	sub urxvt::line::r {	1958	sub urxvt::line::r {
1656	my ($self) = @_;	1959	my ($self) = @_;
1657		1960
1658	if (@_ > 1)	1961	if (@_ > 1) {
1659	{
1660	$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})
1661	for $self->{beg} .. $self->{end};	1963	for $self->{beg} .. $self->{end};
1662	}	1964	}
1663		1965
1664	if (defined wantarray) {	1966	if (defined wantarray) {
1665	my $rend = [	1967	my $rend = [
1666	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1968	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1667	];	1969	];
…		…
1699	where one character corresponds to one screen cell. See	2001	where one character corresponds to one screen cell. See
1700	C<< $term->ROW_t >> for details.	2002	C<< $term->ROW_t >> for details.
1701		2003
1702	=item $string = $term->special_decode $text	2004	=item $string = $term->special_decode $text
1703		2005
1704	Converts rxvt-unicodes text reprsentation into a perl string. See	2006	Converts rxvt-unicode's text representation into a perl string. See
1705	C<< $term->ROW_t >> for details.	2007	C<< $term->ROW_t >> for details.
1706		2008
1707	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2009	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1708		2010
1709	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2011	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1712	manpage.	2014	manpage.
1713		2015
1714	=item $success = $term->grab ($eventtime[, $sync])	2016	=item $success = $term->grab ($eventtime[, $sync])
1715		2017
1716	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2018	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1717	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2019	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1718		2020
1719	=item $term->allow_events_async	2021	=item $term->allow_events_async
1720		2022
1721	Calls XAllowEvents with AsyncBoth for the most recent grab.	2023	Calls XAllowEvents with AsyncBoth for the most recent grab.
1722		2024
…		…
1729	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2031	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1730	recent grab.	2032	recent grab.
1731		2033
1732	=item $term->ungrab	2034	=item $term->ungrab
1733		2035
1734	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
1735	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
1736	the session.	2038	the session.
1737		2039
1738	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2040	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1739		2041
…		…
1741		2043
1742	=item @atoms = $term->XListProperties ($window)	2044	=item @atoms = $term->XListProperties ($window)
1743		2045
1744	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2046	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1745		2047
1746	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2048	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1747		2049
1748	=item $term->XDeleteProperty ($window, $property)	2050	=item $term->XDeleteProperty ($window, $property)
1749		2051
1750	=item $window = $term->DefaultRootWindow	2052	=item $window = $term->DefaultRootWindow
1751		2053
…		…
1758	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2060	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1759		2061
1760	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2062	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1761		2063
1762	=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)
1763		2069
1764	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
1765	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
1766	directory onto the X functions of the same name.	2072	directly onto the X functions of the same name.
1767		2073
1768	=back	2074	=back
1769		2075
1770	=cut	2076	=cut
1771		2077
1772	package urxvt::popup;	2078	package urxvt::popup;
1773		2079
1774	=head2 The C<urxvt::popup> Class	2080	=head2 The C<urxvt::popup> Class
1775		2081
1776	=over 4	2082	=over
1777		2083
1778	=cut	2084	=cut
1779		2085
1780	sub add_item {	2086	sub add_item {
1781	my ($self, $item) = @_;	2087	my ($self, $item) = @_;
…		…
1873	my $env = $self->{term}->env;	2179	my $env = $self->{term}->env;
1874	# 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.
1875	delete $env->{LC_ALL};	2181	delete $env->{LC_ALL};
1876	$env->{LC_CTYPE} = $self->{term}->locale;	2182	$env->{LC_CTYPE} = $self->{term}->locale;
1877		2183
1878	urxvt::term->new ($env, "popup",	2184	my $term = urxvt::term->new (
		2185	$env, "popup",
1879	"--perl-lib" => "", "--perl-ext-common" => "",	2186	"--perl-lib" => "", "--perl-ext-common" => "",
1880	"-pty-fd" => -1, "-sl" => 0,	2187	"-pty-fd" => -1, "-sl" => 0,
1881	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2188	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1882	"--transient-for" => $self->{term}->parent,	2189	"--transient-for" => $self->{term}->parent,
1883	"-display" => $self->{term}->display_id,	2190	"-display" => $self->{term}->display_id,
1884	"-pe" => "urxvt-popup")	2191	"-pe" => "urxvt-popup",
1885	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	}
1886	}	2199	}
1887		2200
1888	sub DESTROY {	2201	sub DESTROY {
1889	my ($self) = @_;	2202	my ($self) = @_;
1890		2203
…		…
1895	=back	2208	=back
1896		2209
1897	=cut	2210	=cut
1898		2211
1899	package urxvt::watcher;	2212	package urxvt::watcher;
1900
1901	@urxvt::timer::ISA = __PACKAGE__;
1902	@urxvt::iow::ISA = __PACKAGE__;
1903	@urxvt::pw::ISA = __PACKAGE__;
1904	@urxvt::iw::ISA = __PACKAGE__;
1905		2213
1906	=head2 The C<urxvt::timer> Class	2214	=head2 The C<urxvt::timer> Class
1907		2215
1908	This class implements timer watchers/events. Time is represented as a	2216	This class implements timer watchers/events. Time is represented as a
1909	fractional number of seconds since the epoch. Example:	2217	fractional number of seconds since the epoch. Example:
…		…
1913	->new	2221	->new
1914	->interval (1)	2222	->interval (1)
1915	->cb (sub {	2223	->cb (sub {
1916	$term->{overlay}->set (0, 0,	2224	$term->{overlay}->set (0, 0,
1917	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2225	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1918	});	2226	});
1919		2227
1920	=over 4	2228	=over
1921		2229
1922	=item $timer = new urxvt::timer	2230	=item $timer = new urxvt::timer
1923		2231
1924	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
1925	immediately.	2233	immediately.
1926		2234
1927	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2235	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1928		2236
1929	Set the callback to be called when the timer triggers.	2237	Set the callback to be called when the timer triggers.
1930		2238
1931	=item $tstamp = $timer->at
1932
1933	Return the time this watcher will fire next.
1934
1935	=item $timer = $timer->set ($tstamp)	2239	=item $timer = $timer->set ($tstamp[, $interval])
1936		2240
1937	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).
1938		2243
1939	=item $timer = $timer->interval ($interval)	2244	=item $timer = $timer->interval ($interval)
1940		2245
1941	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
1942	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
1943	is automatically rescheduled at the given intervals.	2248	is automatically rescheduled at the given intervals.
1944		2249
1945	=item $timer = $timer->start	2250	=item $timer = $timer->start
1946		2251
1947	Start the timer.	2252	Start the timer.
1948		2253
1949	=item $timer = $timer->start ($tstamp)	2254	=item $timer = $timer->start ($tstamp[, $interval])
1950		2255
1951	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.
1952		2258
1953	=item $timer = $timer->after ($delay)	2259	=item $timer = $timer->after ($delay[, $interval])
1954		2260
1955	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>.
1956		2262
1957	=item $timer = $timer->stop	2263	=item $timer = $timer->stop
1958		2264
…		…
1966		2272
1967	$term->{socket} = ...	2273	$term->{socket} = ...
1968	$term->{iow} = urxvt::iow	2274	$term->{iow} = urxvt::iow
1969	->new	2275	->new
1970	->fd (fileno $term->{socket})	2276	->fd (fileno $term->{socket})
1971	->events (urxvt::EVENT_READ)	2277	->events (urxvt::EV_READ)
1972	->start	2278	->start
1973	->cb (sub {	2279	->cb (sub {
1974	my ($iow, $revents) = @_;	2280	my ($iow, $revents) = @_;
1975	# $revents must be 1 here, no need to check	2281	# $revents must be 1 here, no need to check
1976	sysread $term->{socket}, my $buf, 8192	2282	sysread $term->{socket}, my $buf, 8192
1977	or end-of-file;	2283	or end-of-file;
1978	});	2284	});
1979		2285
1980		2286
1981	=over 4	2287	=over
1982		2288
1983	=item $iow = new urxvt::iow	2289	=item $iow = new urxvt::iow
1984		2290
1985	Create a new io watcher object in stopped state.	2291	Create a new io watcher object in stopped state.
1986		2292
…		…
1989	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>
1990	is a bitset as described in the C<events> method.	2296	is a bitset as described in the C<events> method.
1991		2297
1992	=item $iow = $iow->fd ($fd)	2298	=item $iow = $iow->fd ($fd)
1993		2299
1994	Set the filedescriptor (not handle) to watch.	2300	Set the file descriptor (not handle) to watch.
1995		2301
1996	=item $iow = $iow->events ($eventmask)	2302	=item $iow = $iow->events ($eventmask)
1997		2303
1998	Set the event mask to watch. The only allowed values are	2304	Set the event mask to watch. The only allowed values are
1999	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
2000	together, or C<urxvt::EVENT_NONE>.	2306	together, or C<urxvt::EV_NONE>.
2001		2307
2002	=item $iow = $iow->start	2308	=item $iow = $iow->start
2003		2309
2004	Start watching for requested events on the given handle.	2310	Start watching for requested events on the given handle.
2005		2311
2006	=item $iow = $iow->stop	2312	=item $iow = $iow->stop
2007		2313
2008	Stop watching for events on the given filehandle.	2314	Stop watching for events on the given file handle.
2009		2315
2010	=back	2316	=back
2011		2317
2012	=head2 The C<urxvt::iw> Class	2318	=head2 The C<urxvt::iw> Class
2013		2319
2014	This class implements idle watchers, that get called automatically when	2320	This class implements idle watchers, that get called automatically when
2015	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
2016	some useful work.	2322	some useful work.
2017		2323
2018	=over 4	2324	=over
2019		2325
2020	=item $iw = new urxvt::iw	2326	=item $iw = new urxvt::iw
2021		2327
2022	Create a new idle watcher object in stopped state.	2328	Create a new idle watcher object in stopped state.
2023		2329
…		…
2046	->new	2352	->new
2047	->start ($pid)	2353	->start ($pid)
2048	->cb (sub {	2354	->cb (sub {
2049	my ($pw, $exit_status) = @_;	2355	my ($pw, $exit_status) = @_;
2050	...	2356	...
2051	});	2357	});
2052		2358
2053	=over 4	2359	=over
2054		2360
2055	=item $pw = new urxvt::pw	2361	=item $pw = new urxvt::pw
2056		2362
2057	Create a new process watcher in stopped state.	2363	Create a new process watcher in stopped state.
2058		2364
…		…
2060		2366
2061	Set the callback to be called when the timer triggers.	2367	Set the callback to be called when the timer triggers.
2062		2368
2063	=item $pw = $timer->start ($pid)	2369	=item $pw = $timer->start ($pid)
2064		2370
2065	Tells the wqtcher to start watching for process C<$pid>.	2371	Tells the watcher to start watching for process C<$pid>.
2066		2372
2067	=item $pw = $pw->stop	2373	=item $pw = $pw->stop
2068		2374
2069	Stop the watcher.	2375	Stop the watcher.
2070		2376
…		…
2075	=head2 URXVT_PERL_VERBOSITY	2381	=head2 URXVT_PERL_VERBOSITY
2076		2382
2077	This variable controls the verbosity level of the perl extension. Higher	2383	This variable controls the verbosity level of the perl extension. Higher
2078	numbers indicate more verbose output.	2384	numbers indicate more verbose output.
2079		2385
2080	=over 4	2386	=over
2081		2387
2082	=item == 0 - fatal messages	2388	=item == 0 - fatal messages only
		2389
		2390	=item >= 2 - general warnings (default level)
2083		2391
2084	=item >= 3 - script loading and management	2392	=item >= 3 - script loading and management
2085		2393
2086	=item >=10 - all called hooks	2394	=item >=10 - all called hooks
2087		2395
2088	=item >=11 - hook reutrn values	2396	=item >=11 - hook return values
2089		2397
2090	=back	2398	=back
2091		2399
2092	=head1 AUTHOR	2400	=head1 AUTHOR
2093		2401
2094	Marc Lehmann <pcg@goof.com>	2402	Marc Lehmann <schmorp@schmorp.de>
2095	http://software.schmorp.de/pkg/rxvt-unicode	2403	http://software.schmorp.de/pkg/rxvt-unicode
2096		2404
2097	=cut	2405	=cut
2098		2406
2099	1	2407	1
		2408
		2409	# vim: sw=3:

Diff Legend

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