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.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.266 by root, Sat Jul 24 11:58:27 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	=head2 Prepackaged Extensions	31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
32		33
33	This section describes the extensiosn delivered with this version. You can	34	=head1 PREPACKAGED EXTENSIONS
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	35
		36	A number of extensions are delivered with this release. You can find them
		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	=over 4	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	=item selection (enabled by default)	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	Intelligent selection. This extension tries to be more intelligent when	48	Extensions may add additional resources and C<actions>, i.e., methods
45	the user extends selections (double-click). Right now, it tries to select	49	which can be bound to a key and invoked by the user. An extension can
46	urls and complete shell-quoted arguments, which is very convenient, too,	50	define the resources it support using so called META comments,
47	if your F<ls> supports C<--quoting-style=shell>.	51	described below. Similarly to builtin resources, extension resources
		52	can also be specified on the command line as long options (with C<.>
		53	replaced by C<->), in which case the corresponding extension is loaded
		54	automatically. For this to work the extension B<must> define META
		55	comments for its resources.
48		56
49	It also offers the following bindable event:	57	=head1 API DOCUMENTATION
50
51	=over 4
52
53	=item rot13
54
55	Rot-13 the selection when activated. Used via keyboard trigger:
56
57	URxvt.keysym.C-M-r: perl:selection:rot13
58
59	=back
60
61	=item option-popup (enabled by default)
62
63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.
65
66	=item selection-popup (enabled by default)
67
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.
70
71	=item searchable-scrollback (enabled by default)
72
73	Adds regex search functionality to the scrollback buffer, triggered by a
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is
75	suspended, C</> starts an incremental regex search, C<n> searches further,
76	C<p> jumps to the previous match. C<enter> leaves search mode at the
77	current position and C<escape> returns to the original position.
78
79	=item digital-clock
80
81	Displays a digital clock using the built-in overlay.
82
83	=item mark-urls
84
85	Uses per-line display filtering (C<on_line_update>) to underline urls.
86
87	=item block-graphics-to-ascii
88
89	A not very useful example of filtering all text output to the terminal,
90	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.
92
93	=item example-refresh-hooks
94
95	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.
98
99	=back
100		58
101	=head2 General API Considerations	59	=head2 General API Considerations
102		60
103	All objects (such as terminals, time watchers etc.) are typical	61	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	62	reference-to-hash objects. The hash can be used to store anything you
…		…
112	terminal is destroyed.	70	terminal is destroyed.
113		71
114	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
115	hints on what they mean:	73	hints on what they mean:
116		74
117	=over 4	75	=over
118		76
119	=item $text	77	=item $text
120		78
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
122	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.
123		81
124	=item $string	82	=item $string
125		83
126	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
127	characters and is to be distinguished with text encoded in a specific	85	characters and is to be distinguished with text encoded in a specific
…		…
130	=item $octets	88	=item $octets
131		89
132	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
133	locale-specific way.	91	locale-specific way.
134		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
135	=back	99	=back
136		100
137	=head2 Extension Objects	101	=head2 Extension Objects
138		102
139	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
140	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,
141	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
142	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
143	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
144	use.	109	internal use.
145		110
146	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
147	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
148		113
149	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.
150		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 cololns (C<:>), and shoudl not contain colons themselves -
		126	there is also currently no escaping mechanism provided for this.
		127
151	=over 4	128	=over
152		129
153	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
154		131
155	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
156	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.
157		135
158	=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.
159		138
160	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> ressource by having this
161	this extension, replacing any previous hook. This is useful when you want	140	comment:
162	to overwrite time-critical hooks only temporarily.
163		141
164	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
165		143
166	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 cnanot 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
167		183
168	=back	184	=back
169		185
170	=head2 Hooks	186	=head2 Hooks
171		187
172	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
173	called whenever the relevant event happens.	189	called whenever the relevant event happens.
174		190
175	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
176	the in the C<Extension Objects> section.	192	the in the C<Extension Objects> section.
177		193
178	B<All> of these hooks must return a boolean value. If it is true, then the	194	B<All> of these hooks must return a boolean value. If any of the called
179	event counts as being I<consumed>, and the invocation of other hooks is	195	hooks returns true, then the event counts as being I<consumed>, and the
180	skipped, and the relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
181		197
182	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
183		199
184	=over 4	200	=over
185		201
186	=item on_init $term	202	=item on_init $term
187		203
188	Called after a new terminal object has been initialized, but before	204	Called after a new terminal object has been initialized, but before
189	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
190	call or deliver senseless data, as terminal size and other characteristics	206	call or deliver senseless data, as terminal size and other characteristics
191	have not yet been determined. You can safely query and change resources,	207	have not yet been determined. You can safely query and change resources
192	though.	208	and options, though. For many purposes the C<on_start> hook is a better
		209	place.
		210
		211	=item on_start $term
		212
		213	Called at the very end of initialisation of a new terminal, just before
		214	trying to map (display) the toplevel and returning to the main loop.
		215
		216	=item on_destroy $term
		217
		218	Called whenever something tries to destroy terminal, when the terminal is
		219	still fully functional (not for long, though).
193		220
194	=item on_reset $term	221	=item on_reset $term
195		222
196	Called after the screen is "reset" for any reason, such as resizing or	223	Called after the screen is "reset" for any reason, such as resizing or
197	control sequences. Here is where you can react on changes to size-related	224	control sequences. Here is where you can react on changes to size-related
198	variables.	225	variables.
199		226
200	=item on_start $term	227	=item on_child_start $term, $pid
201		228
202	Called at the very end of initialisation of a new terminal, just before	229	Called just after the child process has been C<fork>ed.
203	returning to the mainloop.	230
		231	=item on_child_exit $term, $status
		232
		233	Called just after the child process has exited. C<$status> is the status
		234	from C<waitpid>.
204		235
205	=item on_sel_make $term, $eventtime	236	=item on_sel_make $term, $eventtime
206		237
207	Called whenever a selection has been made by the user, but before the	238	Called whenever a selection has been made by the user, but before the
208	selection text is copied, so changes to the beginning, end or type of the	239	selection text is copied, so changes to the beginning, end or type of the
…		…
215		246
216	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
217	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
218	by calling C<< $term->selection >>.	249	by calling C<< $term->selection >>.
219		250
220	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.
221		252
222	=item on_sel_extend $term	253	=item on_sel_extend $term
223		254
224	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
225	click) and is either supposed to return false (normal operation), or	256	click) and is either supposed to return false (normal operation), or
226	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
227	processing.	258	processing. This can happen multiple times, as long as the callback
		259	returns true, it will be called on every further click by the user and is
		260	supposed to enlarge the selection more and more, if possible.
228		261
229	See the F<selection> example extension.	262	See the F<selection> example extension.
230		263
231	=item on_view_change $term, $offset	264	=item on_view_change $term, $offset
232		265
233	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
234	scrolls. Offset C<0> means display the normal terminal, positive values	267	scrolls. Offset C<0> means display the normal terminal, positive values
235	show this many lines of scrollback.	268	show this many lines of scrollback.
236		269
237	=item on_scroll_back $term, $lines, $saved	270	=item on_scroll_back $term, $lines, $saved
238		271
…		…
242		275
243	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,
244	$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
245	number of lines that will be in the scrollback buffer.	278	number of lines that will be in the scrollback buffer.
246		279
247	=item on_osc_seq $term, $string	280	=item on_osc_seq $term, $op, $args, $resp
248		281
		282	Called on every OSC sequence and can be used to suppress it or modify its
		283	behaviour. The default should be to return an empty list. A true value
		284	suppresses execution of the request completely. Make sure you don't get
		285	confused by recursive invocations when you output an OSC sequence within
		286	this callback.
		287
		288	C<on_osc_seq_perl> should be used for new behaviour.
		289
		290	=item on_osc_seq_perl $term, $args, $resp
		291
249	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	292	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
250	operating system command) is processed. Cursor position and other state	293	(OSC = operating system command) is processed. Cursor position and other
251	information is up-to-date when this happens. For interoperability, the	294	state information is up-to-date when this happens. For interoperability,
252	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
253	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
254	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	}
255		308
256	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,
257	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
258	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.
259		315
260	=item on_add_lines $term, $string	316	=item on_add_lines $term, $string
261		317
262	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
263	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
…		…
268	=item on_tt_write $term, $octets	324	=item on_tt_write $term, $octets
269		325
270	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
271	suppress or filter tty input.	327	suppress or filter tty input.
272		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
273	=item on_line_update $term, $row	336	=item on_line_update $term, $row
274		337
275	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
276	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
277	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,
…		…
284	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
285	you cannot just toggle rendition bits, but only set them.	348	you cannot just toggle rendition bits, but only set them.
286		349
287	=item on_refresh_begin $term	350	=item on_refresh_begin $term
288		351
289	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
290	or similar effects by modify terminal contents in refresh_begin, and	353	similar effects by modifying the terminal contents in refresh_begin, and
291	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
292	code is run after this hook, and takes precedence.	355	code is run after this hook, and takes precedence.
293		356
294	=item on_refresh_end $term	357	=item on_refresh_end $term
295		358
296	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>.
297		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
298	=item on_keyboard_command $term, $string	369	=item on_user_command $term, $string *DEPRECATED*
299		370
300	Called whenever the user presses a key combination that has a	371	Called whenever a user-configured event is being activated (e.g. via
301	C<perl:string> action bound to it (see description of the B<keysym>	372	a C<perl:string> action bound to a key, see description of the B<keysym>
302	resource in the @@RXVT_NAME@@(1) manpage).	373	resource in the urxvt(1) manpage).
		374
		375	The event is simply the action string. This interface is going away in
		376	preference to the C<on_action> hook.
		377
		378	=item on_resize_all_windows $term, $new_width, $new_height
		379
		380	Called just after the new window size has been calculated, but before
		381	windows are actually being resized or hints are being set. If this hook
		382	returns a true value, setting of the window hints is being skipped.
		383
		384	=item on_x_event $term, $event
		385
		386	Called on every X event received on the vt window (and possibly other
		387	windows). Should only be used as a last resort. Most event structure
		388	members are not passed.
		389
		390	=item on_root_event $term, $event
		391
		392	Like C<on_x_event>, but is called for events on the root window.
303		393
304	=item on_focus_in $term	394	=item on_focus_in $term
305		395
306	Called whenever the window gets the keyboard focus, before rxvt-unicode	396	Called whenever the window gets the keyboard focus, before rxvt-unicode
307	does focus in processing.	397	does focus in processing.
308		398
309	=item on_focus_out $term	399	=item on_focus_out $term
310		400
311	Called wheneever the window loses keyboard focus, before rxvt-unicode does	401	Called whenever the window loses keyboard focus, before rxvt-unicode does
312	focus out processing.	402	focus out processing.
313		403
		404	=item on_configure_notify $term, $event
		405
		406	=item on_property_notify $term, $event
		407
314	=item on_key_press $term, $event, $keysym, $octets	408	=item on_key_press $term, $event, $keysym, $octets
315		409
316	=item on_key_release $term, $event, $keysym	410	=item on_key_release $term, $event, $keysym
317		411
318	=item on_button_press $term, $event	412	=item on_button_press $term, $event
…		…
323		417
324	=item on_map_notify $term, $event	418	=item on_map_notify $term, $event
325		419
326	=item on_unmap_notify $term, $event	420	=item on_unmap_notify $term, $event
327		421
328	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
329	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.
330		424
331	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
332	manpage), with the additional members C<row> and C<col>, which are the row	426	manpage), with the additional members C<row> and C<col>, which are the
333	and column under the mouse cursor.	427	(real, not screen-based) row and column under the mouse cursor.
334		428
335	C<on_key_press> additionally receives the string rxvt-unicode would	429	C<on_key_press> additionally receives the string rxvt-unicode would
336	output, if any, in locale-specific encoding.	430	output, if any, in locale-specific encoding.
337		431
338	subwindow.	432	=item on_client_message $term, $event
		433
		434	=item on_wm_protocols $term, $event
		435
		436	=item on_wm_delete_window $term, $event
		437
		438	Called when various types of ClientMessage events are received (all with
		439	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		440
		441	=item on_bell $term
		442
		443	Called on receipt of a bell character.
339		444
340	=back	445	=back
341		446
		447	=cut
		448
		449	package urxvt;
		450
		451	use utf8;
		452	use strict qw(vars subs);
		453	use Carp ();
		454	use Scalar::Util ();
		455	use List::Util ();
		456
		457	our $VERSION = 1;
		458	our $TERM;
		459	our @TERM_INIT; # should go, prevents async I/O etc.
		460	our @TERM_EXT; # should go, prevents async I/O etc.
		461	our @HOOKNAME;
		462	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		463	our %OPTION;
		464
		465	our $LIBDIR;
		466	our $RESNAME;
		467	our $RESCLASS;
		468	our $RXVTNAME;
		469
		470	our $NOCHAR = chr 0xffff;
		471
342	=head2 Variables in the C<urxvt> Package	472	=head2 Variables in the C<urxvt> Package
343		473
344	=over 4	474	=over
		475
		476	=item $urxvt::LIBDIR
		477
		478	The rxvt-unicode library directory, where, among other things, the perl
		479	modules and scripts are stored.
		480
		481	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		482
		483	The resource class and name rxvt-unicode uses to look up X resources.
		484
		485	=item $urxvt::RXVTNAME
		486
		487	The basename of the installed binaries, usually C<urxvt>.
345		488
346	=item $urxvt::TERM	489	=item $urxvt::TERM
347		490
348	The current terminal. This variable stores the current C<urxvt::term>	491	The current terminal. This variable stores the current C<urxvt::term>
349	object, whenever a callback/hook is executing.	492	object, whenever a callback/hook is executing.
350		493
		494	=item @urxvt::TERM_INIT
		495
		496	All code references in this array will be called as methods of the next newly
		497	created C<urxvt::term> object (during the C<on_init> phase). The array
		498	gets cleared before the code references that were in it are being executed,
		499	so references can push themselves onto it again if they so desire.
		500
		501	This complements to the perl-eval command line option, but gets executed
		502	first.
		503
		504	=item @urxvt::TERM_EXT
		505
		506	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		507	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		508	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		509
351	=back	510	=back
352		511
353	=head2 Functions in the C<urxvt> Package	512	=head2 Functions in the C<urxvt> Package
354		513
355	=over 4	514	=over
356
357	=item $term = new urxvt [arg...]
358
359	Creates a new terminal, very similar as if you had started it with
360	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361	if the new instance couldn't be created. Returns C<undef> if the new
362	instance didn't initialise perl, and the terminal object otherwise. The
363	C<init> and C<start> hooks will be called during the call.
364		515
365	=item urxvt::fatal $errormessage	516	=item urxvt::fatal $errormessage
366		517
367	Fatally aborts execution with the given error message. Avoid at all	518	Fatally aborts execution with the given error message (which should
368	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
369	starts up.	520	is acceptable (and useful) is in the init hook, where it prevents the
		521	terminal from starting up.
370		522
371	=item urxvt::warn $string	523	=item urxvt::warn $string
372		524
373	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
374	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
375	that calls this function.	527	that calls this function.
376		528
377	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
378	correct place, e.g. on stderr of the connecting urxvtc client.	530	correct place, e.g. on stderr of the connecting urxvtc client.
379		531
380	=item $is_safe = urxvt::safe	532	Messages have a size limit of 1023 bytes currently.
381		533
382	Returns true when it is safe to do potentially unsafe things, such as	534	=item @terms = urxvt::termlist
383	evaluating perl code specified by the user. This is true when urxvt was	535
384	started setuid or setgid.	536	Returns all urxvt::term objects that exist in this process, regardless of
		537	whether they are started, being destroyed etc., so be careful. Only term
		538	objects that have perl extensions attached will be returned (because there
		539	is no urxvt::term object associated with others).
385		540
386	=item $time = urxvt::NOW	541	=item $time = urxvt::NOW
387		542
388	Returns the "current time" (as per the event loop).	543	Returns the "current time" (as per the event loop).
389		544
…		…
391		546
392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	547	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	548	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394	Button4Mask, Button5Mask, AnyModifier	549	Button4Mask, Button5Mask, AnyModifier
395		550
		551	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		552	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		553	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		554	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		555	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		556	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		557	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		558
		559	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		560	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		561	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		562	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		563	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		564	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		565	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		566
396	Various constants for use in X calls and event processing.	567	Various constants for use in X calls and event processing.
		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.
397		580
398	=back	581	=back
399		582
400	=head2 RENDITION	583	=head2 RENDITION
401		584
…		…
405	The following "macros" deal with changes in rendition sets. You should	588	The following "macros" deal with changes in rendition sets. You should
406	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,
407	as they contain important information required for correct operation of	590	as they contain important information required for correct operation of
408	rxvt-unicode.	591	rxvt-unicode.
409		592
410	=over 4	593	=over
411		594
412	=item $rend = urxvt::DEFAULT_RSTYLE	595	=item $rend = urxvt::DEFAULT_RSTYLE
413		596
414	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
415	being reset. Useful as a base to start when creating renditions.	598	being reset. Useful as a base to start when creating renditions.
416		599
417	=item $rend = urxvt::OVERLAY_RSTYLE	600	=item $rend = urxvt::OVERLAY_RSTYLE
418		601
419	Return the rendition mask used for overlays by default.	602	Return the rendition mask used for overlays by default.
420		603
421	=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
422		606
423	Return the bit that enabled bold, italic, blink, reverse-video and	607	Return the bit that enabled bold, italic, blink, reverse-video and
424	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
425	the bitset.	609	the bitset.
426		610
…		…
428		612
429	=item $background = urxvt::GET_BASEBG $rend	613	=item $background = urxvt::GET_BASEBG $rend
430		614
431	Return the foreground/background colour index, respectively.	615	Return the foreground/background colour index, respectively.
432		616
433	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	617	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
434		618
435	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	619	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		620
		621	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
436		622
437	Replace the foreground/background colour in the rendition mask with the	623	Replace the foreground/background colour in the rendition mask with the
438	specified one.	624	specified one.
439		625
440	=item $value = urxvt::GET_CUSTOM ($rend)	626	=item $value = urxvt::GET_CUSTOM $rend
441		627
442	Return the "custom" value: Every rendition has 5 bits for use by	628	Return the "custom" value: Every rendition has 5 bits for use by
443	extensions. They can be set and changed as you like and are initially	629	extensions. They can be set and changed as you like and are initially
444	zero.	630	zero.
445		631
446	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	632	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
447		633
448	Change the custom value.	634	Change the custom value.
449		635
450	=back	636	=back
451		637
452	=cut	638	=cut
453		639
454	package urxvt;
455
456	use utf8;
457	use strict;
458	use Carp ();
459	use Scalar::Util ();
460	use List::Util ();
461
462	our $VERSION = 1;
463	our $TERM;
464	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;
467	our $LIBDIR;
468
469	BEGIN {	640	BEGIN {
470	urxvt->bootstrap;
471
472	# overwrite perl's warn	641	# overwrite perl's warn
473	*CORE::GLOBAL::warn = sub {	642	*CORE::GLOBAL::warn = sub {
474	my $msg = join "", @_;	643	my $msg = join "", @_;
475	$msg .= "\n"	644	$msg .= "\n"
476	unless $msg =~ /\n$/;	645	unless $msg =~ /\n$/;
477	urxvt::warn ($msg);	646	urxvt::warn ($msg);
478	};	647	};
479
480	delete $ENV{IFS};
481	delete $ENV{CDPATH};
482	delete $ENV{BASH_ENV};
483	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
484	}	648	}
485		649
486	my @hook_count;	650	no warnings 'utf8';
		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
487	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	718	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
488		719
489	sub verbose {	720	sub verbose {
490	my ($level, $msg) = @_;	721	my ($level, $msg) = @_;
491	warn "$msg\n" if $level <= $verbosity;	722	warn "$msg\n" if $level <= $verbosity;
492	}	723	}
493		724
494	my $extension_pkg = "extension0000";
495	my %extension_pkg;	725	my %extension_pkg;
496		726
497	# load a single script into its own package, once only	727	# load a single script into its own package, once only
498	sub extension_package($) {	728	sub extension_package($) {
499	my ($path) = @_;	729	my ($path) = @_;
500		730
501	$extension_pkg{$path} ||= do {	731	$extension_pkg{$path} ||= do {
502	my $pkg = "urxvt::" . ($extension_pkg++);	732	$path =~ /([^\/\\]+)$/;
		733	my $pkg = $1;
		734	$pkg =~ s/[^[:word:]]/_/g;
		735	$pkg = "urxvt::ext::$pkg";
503		736
504	verbose 3, "loading extension '$path' into package '$pkg'";	737	verbose 3, "loading extension '$path' into package '$pkg'";
		738
		739	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
505		740
506	open my $fh, "<:raw", $path	741	open my $fh, "<:raw", $path
507	or die "$path: $!";	742	or die "$path: $!";
508		743
509	my $source = untaint	744	my $source =
510	"package $pkg; use strict; use utf8;\n"	745	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
511	. "use base urxvt::term::extension::;\n"
512	. "#line 1 \"$path\"\n{\n"	746	. "#line 1 \"$path\"\n{\n"
513	. (do { local $/; <$fh> })	747	. (do { local $/; <$fh> })
514	. "\n};\n1";	748	. "\n};\n1";
515		749
516	eval $source	750	eval $source
…		…
525	# called by the rxvt core	759	# called by the rxvt core
526	sub invoke {	760	sub invoke {
527	local $TERM = shift;	761	local $TERM = shift;
528	my $htype = shift;	762	my $htype = shift;
529		763
530	if ($htype == 0) { # INIT	764	if ($htype == HOOK_INIT) {
531	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	765	$TERM->scan_extensions;
532		766
533	my %ext_arg;	767	my %ext_arg;
534		768
		769	{
		770	my @init = @TERM_INIT;
		771	@TERM_INIT = ();
		772	$_->($TERM) for @init;
		773	my @pkg = @TERM_EXT;
		774	@TERM_EXT = ();
		775	$TERM->register_package ($_) for @pkg;
		776	}
		777
		778	for (
		779	@{ delete $TERM->{perl_ext_3} },
535	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	780	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		781	) {
536	if ($_ eq "default") {	782	if ($_ eq "default") {
		783
		784	$ext_arg{$_} = []
537	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	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
538	} elsif (/^-(.*)$/) {	796	} elsif (/^-(.*)$/) { # remove from set
539	delete $ext_arg{$1};	797	delete $ext_arg{$1};
540	} 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};
541	push @{ $ext_arg{$1} }, $2;	804	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		805
542	} else {	806	} else {
543	$ext_arg{$_} ||= [];	807	verbose 2, "cannot parse extension specification '$_', ignoring.";
544	}	808	}
545	}	809	}
546		810
547	while (my ($ext, $argv) = each %ext_arg) {	811	$TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
548	my @files = grep -f $_, map "$_/$ext", @dirs;	812	$TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
549		813
550	if (@files) {	814	for my $ext (sort keys %ext_arg) {
551	$TERM->register_package (extension_package $files[0], $argv);	815	my $path = $TERM->extension_path ($ext);
		816
		817	if (defined $path) {
		818	$TERM->autoload_extension ($ext, $ext_arg{$ext});
552	} else {	819	} else {
553	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";
554	}	821	}
555	}	822	}
556		823
557	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");
558	warn $@ if $@;	825	warn $@ if $@;
559	}	826	}
560		827
561	$retval = undef;	828	$retval = undef;
562		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
563	if (my $cb = $TERM->{_hook}[$htype]) {	840	if (my $cb = $TERM->{_hook}[$htype]) {
564	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	841	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
565	if $verbosity >= 10;	842	if $verbosity >= 10;
566		843
567	keys %$cb;	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";
568		850
569	while (my ($pkg, $cb) = each %$cb) {	851	$cb = $cb->{$pkg}
		852	or return undef; #TODO: maybe warn user?
		853
		854	$cb = { $pkg => $cb };
		855	}
		856
		857	for my $pkg (keys %$cb) {
570	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	858	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
571	and last;	859	$retval ||= $retval_;
572		860
573	if ($@) {	861	if ($@) {
574	$TERM->ungrab; # better to lose the grab than the session	862	$TERM->ungrab; # better to lose the grab than the session
575	warn $@;	863	warn $@;
576	}	864	}
577	}	865	}
		866
		867	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		868	if $verbosity >= 11;
578	}	869	}
579		870
580	if ($htype == 1) { # DESTROY	871	if ($htype == HOOK_DESTROY) {
581	if (my $hook = delete $TERM->{_hook}) {
582	for my $htype (0..$#$hook) {
583	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
584	or set_should_invoke $htype, 0;
585	}
586	}
587
588	# clear package objects	872	# clear package objects
589	%$_ = () for values %{ $TERM->{_pkg} };	873	%$_ = () for values %{ $TERM->{_pkg} };
590		874
591	# clear package	875	# clear package
592	%$TERM = ();	876	%$TERM = ();
593	}	877	}
594		878
595	$retval	879	$retval
596	}	880	}
597		881
598	# urxvt::term::extension	882	sub SET_COLOR($$$) {
		883	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		884	}
599		885
600	package urxvt::term::extension;	886	sub rend2mask {
601		887	no strict 'refs';
602	sub enable {	888	my ($str, $mask) = (@_, 0);
603	my ($self, %hook) = @_;	889	my %color = ( fg => undef, bg => undef );
604	my $pkg = $self->{_pkg};	890	my @failed;
605		891	for my $spec ( split /\s+/, $str ) {
606	while (my ($name, $cb) = each %hook) {	892	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
607	my $htype = $HOOKTYPE{uc $name};	893	$color{lc($1)} = $2;
608	defined $htype	894	} else {
609	or Carp::croak "unsupported hook type '$name'";	895	my $neg = $spec =~ s/^[-^]//;
610		896	unless ( exists &{"RS_$spec"} ) {
611	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	897	push @failed, $spec;
612	$hook_count[$htype]++	898	next;
613	or urxvt::set_should_invoke $htype, 1;
614	}	899	}
615		900	my $cur = &{"RS_$spec"};
616	$self->{term}{_hook}[$htype]{$pkg} = $cb;	901	if ( $neg ) {
617	}	902	$mask &= ~$cur;
618	}	903	} else {
619		904	$mask |= $cur;
620	sub disable {	905	}
621	my ($self, @hook) = @_;
622	my $pkg = $self->{_pkg};
623
624	for my $name (@hook) {
625	my $htype = $HOOKTYPE{uc $name};
626	defined $htype
627	or Carp::croak "unsupported hook type '$name'";
628
629	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
630	--$hook_count[$htype]
631	or urxvt::set_should_invoke $htype, 0;
632	}	906	}
633	}	907	}
		908	($mask, @color{qw(fg bg)}, \@failed)
634	}	909	}
		910
		911	package urxvt::term::extension;
		912
		913	=head2 The C<urxvt::term::extension> class
		914
		915	Each extension attached to a terminal object is represented by
		916	a C<urxvt::term::extension> object.
		917
		918	You can use these objects, which are passed to all callbacks to store any
		919	state related to the terminal and extension instance.
		920
		921	The methods (And data members) documented below can be called on extension
		922	objects, in addition to call methods documented for the <urxvt::term>
		923	class.
		924
		925	=over
		926
		927	=item $urxvt_term = $self->{term}
		928
		929	Returns the C<urxvt::term> object associated with this instance of the
		930	extension. This member I<must not> be changed in any way.
		931
		932	=cut
635		933
636	our $AUTOLOAD;	934	our $AUTOLOAD;
637		935
638	sub AUTOLOAD {	936	sub AUTOLOAD {
639	$AUTOLOAD =~ /:([^:]+)$/	937	$AUTOLOAD =~ /:([^:]+)$/
…		…
652		950
653	sub DESTROY {	951	sub DESTROY {
654	# nop	952	# nop
655	}	953	}
656		954
657	# urxvt::destroy_hook	955	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
658		956
659	sub urxvt::destroy_hook::DESTROY {	957	sub urxvt::destroy_hook::DESTROY {
660	${$_[0]}->();	958	${$_[0]}->();
661	}	959	}
662		960
663	sub urxvt::destroy_hook(&) {	961	sub urxvt::destroy_hook(&) {
664	bless \shift, urxvt::destroy_hook::	962	bless \shift, urxvt::destroy_hook::
665	}	963	}
666		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
		1087
667	package urxvt::anyevent;	1088	package urxvt::anyevent;
668		1089
669	=head2 The C<urxvt::anyevent> Class	1090	=head2 The C<urxvt::anyevent> Class
670		1091
671	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
672	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
673	further work. The only exception is that you cannot wait on condition	1094	further programming. The only exception is that you cannot wait on
674	variables, but non-blocking condvar use is ok. What this means is that you	1095	condition variables, but non-blocking condvar use is ok.
675	cannot use blocking APIs, but the non-blocking variant should work.
676		1096
677	=cut	1097	In practical terms this means is that you cannot use blocking APIs, but
		1098	the non-blocking variant should work.
678		1099
		1100	=cut
		1101
679	our $VERSION = 1;	1102	our $VERSION = '5.23';
680		1103
681	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1104	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
682	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1105	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
683		1106
684	sub timer {	1107	sub timer {
…		…
686		1109
687	my $cb = $arg{cb};	1110	my $cb = $arg{cb};
688		1111
689	urxvt::timer	1112	urxvt::timer
690	->new	1113	->new
691	->start (urxvt::NOW + $arg{after})	1114	->after ($arg{after}, $arg{interval})
692	->cb (sub {	1115	->cb ($arg{interval} ? $cb : sub {
693	$_[0]->stop; # need to cancel manually	1116	$_[0]->stop; # need to cancel manually
694	$cb->();	1117	$cb->();
695	})	1118	})
696	}	1119	}
697		1120
698	sub io {	1121	sub io {
699	my ($class, %arg) = @_;	1122	my ($class, %arg) = @_;
700		1123
701	my $cb = $arg{cb};	1124	my $cb = $arg{cb};
		1125	my $fd = fileno $arg{fh};
		1126	defined $fd or $fd = $arg{fh};
702		1127
703	bless [$arg{fh}, urxvt::iow	1128	bless [$arg{fh}, urxvt::iow
704	->new	1129	->new
705	->fd (fileno $arg{fh})	1130	->fd ($fd)
706	->events (($arg{poll} =~ /r/ ? 1 : 0)	1131	->events (($arg{poll} =~ /r/ ? 1 : 0)
707	| ($arg{poll} =~ /w/ ? 2 : 0))	1132	| ($arg{poll} =~ /w/ ? 2 : 0))
708	->start	1133	->start
709	->cb (sub {	1134	->cb ($cb)
710	$cb->(($_[1] & 1 ? 'r' : '')
711	. ($_[1] & 2 ? 'w' : ''));
712	})],
713	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	})
714	}	1161	}
715		1162
716	sub DESTROY {	1163	sub DESTROY {
717	$_[0][1]->stop;	1164	$_[0][1]->stop;
718	}	1165	}
719		1166
720	sub condvar {	1167	# only needed for AnyEvent < 6 compatibility
721	bless \my $flag, urxvt::anyevent::condvar::	1168	sub one_event {
722	}
723
724	sub urxvt::anyevent::condvar::broadcast {
725	${$_[0]}++;
726	}
727
728	sub urxvt::anyevent::condvar::wait {
729	unless (${$_[0]}) {
730	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";
731	}
732	}	1170	}
733		1171
734	package urxvt::term;	1172	package urxvt::term;
735		1173
736	=head2 The C<urxvt::term> Class	1174	=head2 The C<urxvt::term> Class
737		1175
738	=over 4	1176	=over
739		1177
740	=cut	1178	=cut
741		1179
742	# find on_xxx subs in the package and register them	1180	# find on_xxx subs in the package and register them
743	# as hooks	1181	# as hooks
744	sub register_package {	1182	sub register_package {
745	my ($self, $pkg, $argv) = @_;	1183	my ($self, $pkg, $argv) = @_;
746		1184
		1185	no strict 'refs';
		1186
		1187	urxvt::verbose 6, "register package $pkg to $self";
		1188
		1189	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1190
747	my $proxy = bless {	1191	my $proxy = bless {
748	_pkg => $pkg,	1192	_pkg => $pkg,
		1193	_name => ${"$pkg\::_NAME"}, # hackish
749	argv => $argv,	1194	argv => $argv,
750	}, $pkg;	1195	}, $pkg;
751	Scalar::Util::weaken ($proxy->{term} = $self);	1196	Scalar::Util::weaken ($proxy->{term} = $self);
752		1197
753	$self->{_pkg}{$pkg} = $proxy;	1198	$self->{_pkg}{$pkg} = $proxy;
754		1199
…		…
757	$proxy->enable ($name => $ref);	1202	$proxy->enable ($name => $ref);
758	}	1203	}
759	}	1204	}
760	}	1205	}
761		1206
		1207	# map extension name to filesyystem 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
		1314	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1315
		1316	Creates a new terminal, very similar as if you had started it with system
		1317	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1318	hash which defines the environment of the new terminal.
		1319
		1320	Croaks (and probably outputs an error message) if the new instance
		1321	couldn't be created. Returns C<undef> if the new instance didn't
		1322	initialise perl, and the terminal object otherwise. The C<init> and
		1323	C<start> hooks will be called before this call returns, and are free to
		1324	refer to global data (which is race free).
		1325
		1326	=cut
		1327
		1328	sub new {
		1329	my ($class, $env, @args) = @_;
		1330
		1331	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1332	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1333
		1334	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1335	}
		1336
762	=item $term->destroy	1337	=item $term->destroy
763		1338
764	Destroy the terminal object (close the window, free resources etc.).	1339	Destroy the terminal object (close the window, free resources
		1340	etc.). Please note that urxvt will not exit as long as any event
		1341	watchers (timers, io watchers) are still active.
		1342
		1343	=item $term->exec_async ($cmd[, @args])
		1344
		1345	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1346	("starts") programs in the background. This function takes care of setting
		1347	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1348	be preferred over explicit calls to C<exec> or C<system>.
		1349
		1350	Returns the pid of the subprocess or C<undef> on error.
		1351
		1352	=cut
		1353
		1354	sub exec_async {
		1355	my $self = shift;
		1356
		1357	my $pid = fork;
		1358
		1359	return $pid
		1360	if !defined $pid or $pid;
		1361
		1362	%ENV = %{ $self->env };
		1363
		1364	exec @_;
		1365	urxvt::_exit 255;
		1366	}
765		1367
766	=item $isset = $term->option ($optval[, $set])	1368	=item $isset = $term->option ($optval[, $set])
767		1369
768	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
769	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
770	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.
771		1373
772	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
773	source file F</src/optinc.h> to see the actual list:	1375	source file F</src/optinc.h> to see the actual list:
774		1376
775	borderLess console cursorBlink cursorUnderline hold iconic insecure	1377	borderLess buffered console cursorBlink cursorUnderline hold iconic
776	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1378	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1379	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
777	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1380	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
778	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1381	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
779	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1382	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
780	tripleclickwords utmpInhibit visualBell	1383	urgentOnBell utmpInhibit visualBell disablePasteBrackets
781		1384
782	=item $value = $term->resource ($name[, $newval])	1385	=item $value = $term->resource ($name[, $newval])
783		1386
784	Returns the current resource value associated with a given name and	1387	Returns the current resource value associated with a given name and
785	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>
…		…
794	likely change).	1397	likely change).
795		1398
796	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
797	terminal is destroyed, so changing options frequently will eat memory.	1400	terminal is destroyed, so changing options frequently will eat memory.
798		1401
799	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
800	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>
801	to see the actual list:	1404	to see the actual list:
802		1405
803	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1406	answerbackstring backgroundPixmap backspace_key blurradius
804	borderLess color cursorBlink cursorUnderline cutchars delete_key	1407	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
805	display_name embed ext_bwidth fade font geometry hold iconName	1408	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
806	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
807	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1411	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
808	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1412	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
809	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1413	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
810	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1414	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
811	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1415	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
812	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1416	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
813	shade term_name title transparent transparent_all tripleclickwords	1417	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
814	utmpInhibit visualBell	1418	term_name title transient_for transparent tripleclickwords urgentOnBell
		1419	utmpInhibit visualBell rewrapMode disablePasteBrackets
815		1420
816	=cut	1421	=cut
817		1422
818	sub resource($$;$) {	1423	sub resource($$;$) {
819	my ($self, $name) = (shift, shift);	1424	my ($self, $name) = (shift, shift);
820	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1425	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
821	&urxvt::term::_resource	1426	goto &urxvt::term::_resource
822	}	1427	}
823		1428
824	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1429	=item $value = $term->x_resource ($pattern)
825		1430
		1431	Returns the X-Resource for the given pattern, excluding the program or
		1432	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1433	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1434	resource with that pattern exists.
		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
		1446	This method should only be called during the C<on_start> hook, as there is
		1447	only one resource database per display, and later invocations might return
		1448	the wrong resources.
		1449
		1450	=item $value = $term->x_resource_boolean ($pattern)
		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
826	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
827	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	}
828		1490
829	=item $rend = $term->rstyle ([$new_rstyle])	1491	=item $rend = $term->rstyle ([$new_rstyle])
830		1492
831	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
832	the terminal application will use this style.	1494	the terminal application will use this style.
…		…
840		1502
841	=item ($row, $col) = $term->selection_beg ([$row, $col])	1503	=item ($row, $col) = $term->selection_beg ([$row, $col])
842		1504
843	=item ($row, $col) = $term->selection_end ([$row, $col])	1505	=item ($row, $col) = $term->selection_end ([$row, $col])
844		1506
845	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.
846	and optionally set them to new values.
847		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.
		1516
		1517	=item $term->selection_make ($eventtime[, $rectangular])
		1518
		1519	Tries to make a selection as set by C<selection_beg> and
		1520	C<selection_end>. If C<$rectangular> is true (default: false), a
		1521	rectangular selection will be made. This is the preferred function to make
		1522	a selection.
		1523
848	=item $success = $term->selection_grab ($eventtime)	1524	=item $success = $term->selection_grab ($eventtime[, $clipboard])
849		1525
850	Try to request the primary selection from the server (for example, as set	1526	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
851	by the next method).	1527	true) selection from the server. The corresponding text can be set
		1528	with the next method. No visual feedback will be given. This function
		1529	is mostly useful from within C<on_sel_grab> hooks.
852		1530
853	=item $oldtext = $term->selection ([$newtext])	1531	=item $oldtext = $term->selection ([$newtext, $clipboard])
854		1532
855	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.
856		1539
857	=item $term->overlay_simple ($x, $y, $text)	1540	=item $term->overlay_simple ($x, $y, $text)
858		1541
859	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.
860		1543
…		…
888	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
889	as long as the perl object is referenced.	1572	as long as the perl object is referenced.
890		1573
891	The methods currently supported on C<urxvt::overlay> objects are:	1574	The methods currently supported on C<urxvt::overlay> objects are:
892		1575
893	=over 4	1576	=over
894		1577
895	=item $overlay->set ($x, $y, $text, $rend)	1578	=item $overlay->set ($x, $y, $text[, $rend])
896		1579
897	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
898	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
899	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.
900		1585
901	=item $overlay->hide	1586	=item $overlay->hide
902		1587
903	If visible, hide the overlay, but do not destroy it.	1588	If visible, hide the overlay, but do not destroy it.
904		1589
…		…
949	Convert the given locale-encoded octets into a perl string.	1634	Convert the given locale-encoded octets into a perl string.
950		1635
951	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1636	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
952		1637
953	XORs the rendition values in the given span with the provided value	1638	XORs the rendition values in the given span with the provided value
954	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1639	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
955	to the selection.	1640	refresh hooks to provide effects similar to the selection.
956		1641
957	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1642	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
958		1643
959	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1644	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
960	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1645	whitespace will additionally be xored with the C<$rstyle2>, which defaults
961	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1646	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
962	it instead.	1647	it instead. Both styles I<MUST NOT> contain font styles.
963		1648
964	=item $term->scr_bell	1649	=item $term->scr_bell
965		1650
966	Ring the bell!	1651	Ring the bell!
967		1652
968	=item $term->scr_add_lines ($string)	1653	=item $term->scr_add_lines ($string)
969		1654
970	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
971	running inside the terminal. It may not contain command sequences (escape	1656	running inside the terminal. It may not contain command sequences (escape
972	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,
973	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.
974		1660
975	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
976	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
977	C<on_add_lines> hook, though.	1663	C<on_add_lines> hook, though.
978		1664
		1665	=item $term->scr_change_screen ($screen)
		1666
		1667	Switch to given screen - 0 primary, 1 secondary.
		1668
979	=item $term->cmd_parse ($octets)	1669	=item $term->cmd_parse ($octets)
980		1670
981	Similar to C<scr_add_lines>, but the argument must be in the	1671	Similar to C<scr_add_lines>, but the argument must be in the
982	locale-specific encoding of the terminal and can contain command sequences	1672	locale-specific encoding of the terminal and can contain command sequences
983	(escape codes) that will be interpreted.	1673	(escape codes) that will be interpreted.
984		1674
985	=item $term->tt_write ($octets)	1675	=item $term->tt_write ($octets)
986		1676
987	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
988	pass characters instead of octets, you should convert your strings first	1679	characters instead of octets, you should convert your strings first to the
989	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.
990		1695
991	=item $old_events = $term->pty_ev_events ([$new_events])	1696	=item $old_events = $term->pty_ev_events ([$new_events])
992		1697
993	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
994	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
995	description of C<< urxvt::timer->events >>. Make sure to always restore	1700	description of C<< urxvt::timer->events >>. Make sure to always restore
996	the previous value.	1701	the previous value.
997		1702
		1703	=item $fd = $term->pty_fd
		1704
		1705	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1706	is used.
		1707
998	=item $windowid = $term->parent	1708	=item $windowid = $term->parent
999		1709
1000	Return the window id of the toplevel window.	1710	Return the window id of the toplevel window.
1001		1711
1002	=item $windowid = $term->vt	1712	=item $windowid = $term->vt
1003		1713
1004	Return the window id of the terminal window.	1714	Return the window id of the terminal window.
1005		1715
		1716	=item $term->vt_emask_add ($x_event_mask)
		1717
		1718	Adds the specified events to the vt event mask. Useful e.g. when you want
		1719	to receive pointer events all the times:
		1720
		1721	$term->vt_emask_add (urxvt::PointerMotionMask);
		1722
		1723	=item $term->set_urgency ($set)
		1724
		1725	Enable/disable the urgency hint on the toplevel window.
		1726
		1727	=item $term->focus_in
		1728
		1729	=item $term->focus_out
		1730
		1731	=item $term->key_press ($state, $keycode[, $time])
		1732
		1733	=item $term->key_release ($state, $keycode[, $time])
		1734
		1735	Deliver various fake events to to terminal.
		1736
1006	=item $window_width = $term->width	1737	=item $window_width = $term->width ([$new_value])
1007		1738
1008	=item $window_height = $term->height	1739	=item $window_height = $term->height ([$new_value])
1009		1740
1010	=item $font_width = $term->fwidth	1741	=item $font_width = $term->fwidth ([$new_value])
1011		1742
1012	=item $font_height = $term->fheight	1743	=item $font_height = $term->fheight ([$new_value])
1013		1744
1014	=item $font_ascent = $term->fbase	1745	=item $font_ascent = $term->fbase ([$new_value])
1015		1746
1016	=item $terminal_rows = $term->nrow	1747	=item $terminal_rows = $term->nrow ([$new_value])
1017		1748
1018	=item $terminal_columns = $term->ncol	1749	=item $terminal_columns = $term->ncol ([$new_value])
1019		1750
1020	=item $has_focus = $term->focus	1751	=item $has_focus = $term->focus ([$new_value])
1021		1752
1022	=item $is_mapped = $term->mapped	1753	=item $is_mapped = $term->mapped ([$new_value])
1023		1754
1024	=item $max_scrollback = $term->saveLines	1755	=item $max_scrollback = $term->saveLines ([$new_value])
1025		1756
1026	=item $nrow_plus_saveLines = $term->total_rows	1757	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1027		1758
1028	=item $lines_in_scrollback = $term->nsaved	1759	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1029		1760
1030	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.
		1763
		1764	=item $x_display = $term->display_id
		1765
		1766	Return the DISPLAY used by rxvt-unicode.
1031		1767
1032	=item $lc_ctype = $term->locale	1768	=item $lc_ctype = $term->locale
1033		1769
1034	Returns the LC_CTYPE category string used by this rxvt-unicode.	1770	Returns the LC_CTYPE category string used by this rxvt-unicode.
1035		1771
1036	=item $x_display = $term->display_id	1772	=item $env = $term->env
1037		1773
1038	Return the DISPLAY used by rxvt-unicode.	1774	Returns a copy of the environment in effect for the terminal as a hashref
		1775	similar to C<\%ENV>.
		1776
		1777	=item @envv = $term->envv
		1778
		1779	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1780
		1781	=item @argv = $term->argv
		1782
		1783	Return the argument vector as this terminal, similar to @ARGV, but
		1784	includes the program name as first element.
		1785
		1786	=cut
		1787
		1788	sub env {
		1789	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1790	}
1039		1791
1040	=item $modifiermask = $term->ModLevel3Mask	1792	=item $modifiermask = $term->ModLevel3Mask
1041		1793
1042	=item $modifiermask = $term->ModMetaMask	1794	=item $modifiermask = $term->ModMetaMask
1043		1795
1044	=item $modifiermask = $term->ModNumLockMask	1796	=item $modifiermask = $term->ModNumLockMask
1045		1797
1046	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1798	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1047	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1799	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1048		1800
		1801	=item $screen = $term->current_screen
		1802
		1803	Returns the currently displayed screen (0 primary, 1 secondary).
		1804
		1805	=item $cursor_is_hidden = $term->hidden_cursor
		1806
		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	}
		1818
1049	=item $view_start = $term->view_start ([$newvalue])	1819	=item $view_start = $term->view_start ([$newvalue])
1050		1820
1051	Returns the negative row number of the topmost line. Minimum value is	1821	Returns the row number of the topmost displayed line and changes it,
1052	C<0>, which displays the normal terminal contents. Larger values scroll	1822	if an argument is given. Values greater than or equal to C<0> display
1053	this many lines into the scrollback buffer.	1823	the terminal contents. Lower values scroll this many lines into the
		1824	scrollback buffer.
1054		1825
1055	=item $term->want_refresh	1826	=item $term->want_refresh
1056		1827
1057	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1828	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1058	compare the on-screen display with its stored representation. If they	1829	compare the on-screen display with its stored representation. If they
1059	differ, it redraws the differences.	1830	differ, it redraws the differences.
1060		1831
1061	Used after changing terminal contents to display them.	1832	Used after changing terminal contents to display them.
1062		1833
		1834	=item $term->refresh_check
		1835
		1836	Checks if a refresh has been requested and, if so, schedules one.
		1837
1063	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1838	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1064		1839
1065	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 >>
1066	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
1067	terminal line. The scrollback buffer starts at line C<-1> and extends to
1068	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1842	terminal line. Nothing will be returned if a nonexistent line
1069	is requested.	1843	is requested.
1070		1844
1071	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
1072	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
1073	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
1074	automatically be updated.	1848	automatically be updated.
1075		1849
1076	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
1077	than one cell when displayed are padded with urxvt::NOCHAR characters	1851	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1078	(C<chr 65535>). Characters with combining characters and other characters	1852	characters. Characters with combining characters and other characters that
1079	that do not fit into the normal tetx encoding will be replaced with	1853	do not fit into the normal text encoding will be replaced with characters
1080	characters in the private use area.	1854	in the private use area.
1081		1855
1082	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
1083	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
1084	characters.	1858	characters.
1085		1859
…		…
1113		1887
1114	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
1115	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
1116	following methods:	1890	following methods:
1117		1891
1118	=over 4	1892	=over
1119		1893
1120	=item $text = $line->t ([$new_text])	1894	=item $text = $line->t ([$new_text])
1121		1895
1122	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>
1123		1897
…		…
1136	Return the row number of the first/last row of the line, respectively.	1910	Return the row number of the first/last row of the line, respectively.
1137		1911
1138	=item $offset = $line->offset_of ($row, $col)	1912	=item $offset = $line->offset_of ($row, $col)
1139		1913
1140	Returns the character offset of the given row|col pair within the logical	1914	Returns the character offset of the given row|col pair within the logical
1141	line.	1915	line. Works for rows outside the line, too, and returns corresponding
		1916	offsets outside the string.
1142		1917
1143	=item ($row, $col) = $line->coord_of ($offset)	1918	=item ($row, $col) = $line->coord_of ($offset)
1144		1919
1145	Translates a string offset into terminal coordinates again.	1920	Translates a string offset into terminal coordinates again.
1146		1921
…		…
1168	}	1943	}
1169		1944
1170	sub urxvt::line::t {	1945	sub urxvt::line::t {
1171	my ($self) = @_;	1946	my ($self) = @_;
1172		1947
1173	if (@_ > 1)	1948	if (@_ > 1) {
1174	{
1175	$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})
1176	for $self->{beg} .. $self->{end};	1950	for $self->{beg} .. $self->{end};
1177	}	1951	}
1178		1952
1179	defined wantarray &&	1953	defined wantarray &&
1180	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1954	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1181	0, $self->{len}	1955	0, $self->{len}
1182	}	1956	}
1183		1957
1184	sub urxvt::line::r {	1958	sub urxvt::line::r {
1185	my ($self) = @_;	1959	my ($self) = @_;
1186		1960
1187	if (@_ > 1)	1961	if (@_ > 1) {
1188	{
1189	$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})
1190	for $self->{beg} .. $self->{end};	1963	for $self->{beg} .. $self->{end};
1191	}	1964	}
1192		1965
1193	if (defined wantarray) {	1966	if (defined wantarray) {
1194	my $rend = [	1967	my $rend = [
1195	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1968	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1196	];	1969	];
…		…
1228	where one character corresponds to one screen cell. See	2001	where one character corresponds to one screen cell. See
1229	C<< $term->ROW_t >> for details.	2002	C<< $term->ROW_t >> for details.
1230		2003
1231	=item $string = $term->special_decode $text	2004	=item $string = $term->special_decode $text
1232		2005
1233	Converts rxvt-unicodes text reprsentation into a perl string. See	2006	Converts rxvt-unicodes text representation into a perl string. See
1234	C<< $term->ROW_t >> for details.	2007	C<< $term->ROW_t >> for details.
1235		2008
1236	=item $success = $term->grab_button ($button, $modifiermask)	2009	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1237		2010
		2011	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2012
1238	Registers a synchronous button grab. See the XGrabButton manpage.	2013	Register/unregister a synchronous button grab. See the XGrabButton
		2014	manpage.
1239		2015
1240	=item $success = $term->grab ($eventtime[, $sync])	2016	=item $success = $term->grab ($eventtime[, $sync])
1241		2017
1242	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2018	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1243	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2019	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1244		2020
1245	=item $term->allow_events_async	2021	=item $term->allow_events_async
1246		2022
1247	Calls XAllowEvents with AsyncBoth for the most recent grab.	2023	Calls XAllowEvents with AsyncBoth for the most recent grab.
1248		2024
…		…
1255	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2031	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1256	recent grab.	2032	recent grab.
1257		2033
1258	=item $term->ungrab	2034	=item $term->ungrab
1259		2035
1260	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
1261	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
1262	the session.	2038	the session.
1263		2039
		2040	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		2041
		2042	=item $atom_name = $term->XGetAtomName ($atom)
		2043
		2044	=item @atoms = $term->XListProperties ($window)
		2045
		2046	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		2047
		2048	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		2049
		2050	=item $term->XDeleteProperty ($window, $property)
		2051
		2052	=item $window = $term->DefaultRootWindow
		2053
		2054	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		2055
		2056	=item $term->XMapWindow ($window)
		2057
		2058	=item $term->XUnmapWindow ($window)
		2059
		2060	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		2061
		2062	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		2063
		2064	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2065
		2066	=item $keysym = $term->XStringToKeysym ($string)
		2067
		2068	=item $string = $term->XKeysymToString ($keysym)
		2069
		2070	Various X or X-related functions. The C<$term> object only serves as
		2071	the source of the display, otherwise those functions map more-or-less
		2072	directly onto the X functions of the same name.
		2073
1264	=back	2074	=back
1265		2075
1266	=cut	2076	=cut
1267		2077
1268	package urxvt::popup;	2078	package urxvt::popup;
1269		2079
1270	=head2 The C<urxvt::popup> Class	2080	=head2 The C<urxvt::popup> Class
1271		2081
1272	=over 4	2082	=over
1273		2083
1274	=cut	2084	=cut
1275		2085
1276	sub add_item {	2086	sub add_item {
1277	my ($self, $item) = @_;	2087	my ($self, $item) = @_;
…		…
1282		2092
1283	$item->{render} ||= sub { $_[0]{text} };	2093	$item->{render} ||= sub { $_[0]{text} };
1284		2094
1285	push @{ $self->{item} }, $item;	2095	push @{ $self->{item} }, $item;
1286	}	2096	}
		2097
		2098	=item $popup->add_title ($title)
		2099
		2100	Adds a non-clickable title to the popup.
		2101
		2102	=cut
		2103
		2104	sub add_title {
		2105	my ($self, $title) = @_;
		2106
		2107	$self->add_item ({
		2108	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		2109	text => $title,
		2110	activate => sub { },
		2111	});
		2112	}
		2113
		2114	=item $popup->add_separator ([$sepchr])
		2115
		2116	Creates a separator, optionally using the character given as C<$sepchr>.
		2117
		2118	=cut
1287		2119
1288	sub add_separator {	2120	sub add_separator {
1289	my ($self, $sep) = @_;	2121	my ($self, $sep) = @_;
1290		2122
1291	$sep ||= "=";	2123	$sep ||= "=";
…		…
1296	render => sub { $sep x $self->{term}->ncol },	2128	render => sub { $sep x $self->{term}->ncol },
1297	activate => sub { },	2129	activate => sub { },
1298	});	2130	});
1299	}	2131	}
1300		2132
1301	sub add_title {	2133	=item $popup->add_button ($text, $cb)
1302	my ($self, $title) = @_;
1303		2134
1304	$self->add_item ({	2135	Adds a clickable button to the popup. C<$cb> is called whenever it is
1305	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	2136	selected.
1306	text => $title,	2137
1307	activate => sub { },	2138	=cut
1308	});
1309	}
1310		2139
1311	sub add_button {	2140	sub add_button {
1312	my ($self, $text, $cb) = @_;	2141	my ($self, $text, $cb) = @_;
1313		2142
1314	$self->add_item ({ type => "button", text => $text, activate => $cb});	2143	$self->add_item ({ type => "button", text => $text, activate => $cb});
1315	}	2144	}
1316		2145
		2146	=item $popup->add_toggle ($text, $initial_value, $cb)
		2147
		2148	Adds a toggle/checkbox item to the popup. The callback gets called
		2149	whenever it gets toggled, with a boolean indicating its new value as its
		2150	first argument.
		2151
		2152	=cut
		2153
1317	sub add_toggle {	2154	sub add_toggle {
1318	my ($self, $text, $cb, $value) = @_;	2155	my ($self, $text, $value, $cb) = @_;
1319		2156
1320	my $item; $item = {	2157	my $item; $item = {
1321	type => "button",	2158	type => "button",
1322	text => " $text",	2159	text => " $text",
1323	value => $value,	2160	value => $value,
1324	render => sub { ($_[0]{value} ? "* " : " ") . $text },	2161	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1325	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	2162	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1326	};	2163	};
1327		2164
1328	$self->add_item ($item);	2165	$self->add_item ($item);
1329	}	2166	}
		2167
		2168	=item $popup->show
		2169
		2170	Displays the popup (which is initially hidden).
		2171
		2172	=cut
1330		2173
1331	sub show {	2174	sub show {
1332	my ($self) = @_;	2175	my ($self) = @_;
1333		2176
1334	local $urxvt::popup::self = $self;	2177	local $urxvt::popup::self = $self;
1335		2178
		2179	my $env = $self->{term}->env;
		2180	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		2181	delete $env->{LC_ALL};
1336	local $ENV{LC_ALL} = $self->{term}->locale;	2182	$env->{LC_CTYPE} = $self->{term}->locale;
1337		2183
1338	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2184	my $term = urxvt::term->new (
		2185	$env, "popup",
		2186	"--perl-lib" => "", "--perl-ext-common" => "",
		2187	"-pty-fd" => -1, "-sl" => 0,
		2188	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1339	"--transient-for" => $self->{term}->parent,	2189	"--transient-for" => $self->{term}->parent,
1340	"-display" => $self->{term}->display_id,	2190	"-display" => $self->{term}->display_id,
1341	"-pe" => "urxvt-popup")	2191	"-pe" => "urxvt-popup",
1342	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	}
1343	}	2199	}
1344		2200
1345	sub DESTROY {	2201	sub DESTROY {
1346	my ($self) = @_;	2202	my ($self) = @_;
1347		2203
1348	delete $self->{term}{_destroy}{$self};	2204	delete $self->{term}{_destroy}{$self};
1349	$self->{term}->ungrab;	2205	$self->{term}->ungrab;
1350	}	2206	}
		2207
		2208	=back
		2209
		2210	=cut
		2211
		2212	package urxvt::watcher;
1351		2213
1352	=head2 The C<urxvt::timer> Class	2214	=head2 The C<urxvt::timer> Class
1353		2215
1354	This class implements timer watchers/events. Time is represented as a	2216	This class implements timer watchers/events. Time is represented as a
1355	fractional number of seconds since the epoch. Example:	2217	fractional number of seconds since the epoch. Example:
…		…
1359	->new	2221	->new
1360	->interval (1)	2222	->interval (1)
1361	->cb (sub {	2223	->cb (sub {
1362	$term->{overlay}->set (0, 0,	2224	$term->{overlay}->set (0, 0,
1363	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2225	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1364	});	2226	});
1365		2227
1366	=over 4	2228	=over
1367		2229
1368	=item $timer = new urxvt::timer	2230	=item $timer = new urxvt::timer
1369		2231
1370	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
1371	immediately.	2233	immediately.
1372		2234
1373	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2235	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1374		2236
1375	Set the callback to be called when the timer triggers.	2237	Set the callback to be called when the timer triggers.
1376		2238
1377	=item $tstamp = $timer->at
1378
1379	Return the time this watcher will fire next.
1380
1381	=item $timer = $timer->set ($tstamp)	2239	=item $timer = $timer->set ($tstamp[, $interval])
1382		2240
1383	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).
1384		2243
1385	=item $timer = $timer->interval ($interval)	2244	=item $timer = $timer->interval ($interval)
1386		2245
1387	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
1388	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
1389	is automatically rescheduled at the given intervals.	2248	is automatically rescheduled at the given intervals.
1390		2249
1391	=item $timer = $timer->start	2250	=item $timer = $timer->start
1392		2251
1393	Start the timer.	2252	Start the timer.
1394		2253
1395	=item $timer = $timer->start ($tstamp)	2254	=item $timer = $timer->start ($tstamp[, $interval])
1396		2255
1397	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.
		2258
		2259	=item $timer = $timer->after ($delay[, $interval])
		2260
		2261	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1398		2262
1399	=item $timer = $timer->stop	2263	=item $timer = $timer->stop
1400		2264
1401	Stop the timer.	2265	Stop the timer.
1402		2266
…		…
1408		2272
1409	$term->{socket} = ...	2273	$term->{socket} = ...
1410	$term->{iow} = urxvt::iow	2274	$term->{iow} = urxvt::iow
1411	->new	2275	->new
1412	->fd (fileno $term->{socket})	2276	->fd (fileno $term->{socket})
1413	->events (urxvt::EVENT_READ)	2277	->events (urxvt::EV_READ)
1414	->start	2278	->start
1415	->cb (sub {	2279	->cb (sub {
1416	my ($iow, $revents) = @_;	2280	my ($iow, $revents) = @_;
1417	# $revents must be 1 here, no need to check	2281	# $revents must be 1 here, no need to check
1418	sysread $term->{socket}, my $buf, 8192	2282	sysread $term->{socket}, my $buf, 8192
1419	or end-of-file;	2283	or end-of-file;
1420	});	2284	});
1421		2285
1422		2286
1423	=over 4	2287	=over
1424		2288
1425	=item $iow = new urxvt::iow	2289	=item $iow = new urxvt::iow
1426		2290
1427	Create a new io watcher object in stopped state.	2291	Create a new io watcher object in stopped state.
1428		2292
…		…
1431	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>
1432	is a bitset as described in the C<events> method.	2296	is a bitset as described in the C<events> method.
1433		2297
1434	=item $iow = $iow->fd ($fd)	2298	=item $iow = $iow->fd ($fd)
1435		2299
1436	Set the filedescriptor (not handle) to watch.	2300	Set the file descriptor (not handle) to watch.
1437		2301
1438	=item $iow = $iow->events ($eventmask)	2302	=item $iow = $iow->events ($eventmask)
1439		2303
1440	Set the event mask to watch. The only allowed values are	2304	Set the event mask to watch. The only allowed values are
1441	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
1442	together, or C<urxvt::EVENT_NONE>.	2306	together, or C<urxvt::EV_NONE>.
1443		2307
1444	=item $iow = $iow->start	2308	=item $iow = $iow->start
1445		2309
1446	Start watching for requested events on the given handle.	2310	Start watching for requested events on the given handle.
1447		2311
1448	=item $iow = $iow->stop	2312	=item $iow = $iow->stop
1449		2313
1450	Stop watching for events on the given filehandle.	2314	Stop watching for events on the given file handle.
		2315
		2316	=back
		2317
		2318	=head2 The C<urxvt::iw> Class
		2319
		2320	This class implements idle watchers, that get called automatically when
		2321	the process is idle. They should return as fast as possible, after doing
		2322	some useful work.
		2323
		2324	=over
		2325
		2326	=item $iw = new urxvt::iw
		2327
		2328	Create a new idle watcher object in stopped state.
		2329
		2330	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2331
		2332	Set the callback to be called when the watcher triggers.
		2333
		2334	=item $timer = $timer->start
		2335
		2336	Start the watcher.
		2337
		2338	=item $timer = $timer->stop
		2339
		2340	Stop the watcher.
		2341
		2342	=back
		2343
		2344	=head2 The C<urxvt::pw> Class
		2345
		2346	This class implements process watchers. They create an event whenever a
		2347	process exits, after which they stop automatically.
		2348
		2349	my $pid = fork;
		2350	...
		2351	$term->{pw} = urxvt::pw
		2352	->new
		2353	->start ($pid)
		2354	->cb (sub {
		2355	my ($pw, $exit_status) = @_;
		2356	...
		2357	});
		2358
		2359	=over
		2360
		2361	=item $pw = new urxvt::pw
		2362
		2363	Create a new process watcher in stopped state.
		2364
		2365	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2366
		2367	Set the callback to be called when the timer triggers.
		2368
		2369	=item $pw = $timer->start ($pid)
		2370
		2371	Tells the watcher to start watching for process C<$pid>.
		2372
		2373	=item $pw = $pw->stop
		2374
		2375	Stop the watcher.
1451		2376
1452	=back	2377	=back
1453		2378
1454	=head1 ENVIRONMENT	2379	=head1 ENVIRONMENT
1455		2380
1456	=head2 URXVT_PERL_VERBOSITY	2381	=head2 URXVT_PERL_VERBOSITY
1457		2382
1458	This variable controls the verbosity level of the perl extension. Higher	2383	This variable controls the verbosity level of the perl extension. Higher
1459	numbers indicate more verbose output.	2384	numbers indicate more verbose output.
1460		2385
1461	=over 4	2386	=over
1462		2387
1463	=item == 0 - fatal messages	2388	=item == 0 - fatal messages only
		2389
		2390	=item >= 2 - general warnings (default level)
1464		2391
1465	=item >= 3 - script loading and management	2392	=item >= 3 - script loading and management
1466		2393
1467	=item >=10 - all events received	2394	=item >=10 - all called hooks
		2395
		2396	=item >=11 - hook return values
1468		2397
1469	=back	2398	=back
1470		2399
1471	=head1 AUTHOR	2400	=head1 AUTHOR
1472		2401
1473	Marc Lehmann <pcg@goof.com>	2402	Marc Lehmann <schmorp@schmorp.de>
1474	http://software.schmorp.de/pkg/rxvt-unicode	2403	http://software.schmorp.de/pkg/rxvt-unicode
1475		2404
1476	=cut	2405	=cut
1477		2406
1478	1	2407	1
		2408
		2409	# vim: sw=3:

Diff Legend

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