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.36 by root, Fri Jan 6 02:58:02 2006 UTC vs.
Revision 1.249 by root, Fri Dec 26 21:26:37 2014 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Every time a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=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	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 and also default bindings for one or
47	if your F<ls> supports C<--quoting-style=shell>.	51	more actions it provides using so called META comments, described
		52	below. Similarly to builtin resources, extension resources can also be
		53	specified on the command line as long options (with C<.> replaced by
		54	C<->), in which case the corresponding extension is loaded
		55	automatically. For this to work the extension B<must> define META
		56	comments for its resources.
48		57
49	It also offers the following bindable event:	58	=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 digital-clock
62
63	Displays a digital clock using the built-in overlay.
64
65	=item mark-urls
66
67	Uses per-line filtering (C<on_line_update>) to underline urls.
68
69	=item example-refresh-hooks
70
71	Displays a very simple digital clock in the upper right corner of the
72	window. Illustrates overwriting the refresh callbacks to create your own
73	overlays or changes.
74
75	=item example-filter-input
76
77	A not very useful example of filtering all text output to the terminal, by
78	underlining all urls that matches a certain regex (i.e. some urls :). It
79	is not very useful because urls that are output in multiple steps (e.g.
80	when typing them) do not get marked.
81
82	=back
83		59
84	=head2 General API Considerations	60	=head2 General API Considerations
85		61
86	All objects (such as terminals, time watchers etc.) are typical	62	All objects (such as terminals, time watchers etc.) are typical
87	reference-to-hash objects. The hash can be used to store anything you	63	reference-to-hash objects. The hash can be used to store anything you
…		…
99		75
100	=over 4	76	=over 4
101		77
102	=item $text	78	=item $text
103		79
104	Rxvt-unicodes special way of encoding text, where one "unicode" character	80	Rxvt-unicode's special way of encoding text, where one "unicode" character
105	always represents one screen cell. See L<row_t> for a discussion of this format.	81	always represents one screen cell. See L<ROW_t> for a discussion of this format.
106		82
107	=item $string	83	=item $string
108		84
109	A perl text string, with an emphasis on I<text>. It can store all unicode	85	A perl text string, with an emphasis on I<text>. It can store all unicode
110	characters and is to be distinguished with text encoded in a specific	86	characters and is to be distinguished with text encoded in a specific
…		…
113	=item $octets	89	=item $octets
114		90
115	Either binary data or - more common - a text string encoded in a	91	Either binary data or - more common - a text string encoded in a
116	locale-specific way.	92	locale-specific way.
117		93
		94	=item $keysym
		95
		96	an integer that is a valid X11 keysym code. You can convert a string
		97	into a keysym and viceversa by using C<XStringToKeysym> and
		98	C<XKeysymToString>.
		99
118	=back	100	=back
119		101
		102	=head2 Extension Objects
		103
		104	Every perl extension is a perl class. A separate perl object is created
		105	for each terminal, and each terminal has its own set of extension objects,
		106	which are passed as the first parameter to hooks. So extensions can use
		107	their C<$self> object without having to think about clashes with other
		108	extensions or other terminals, with the exception of methods and members
		109	that begin with an underscore character C<_>: these are reserved for
		110	internal use.
		111
		112	Although it isn't a C<urxvt::term> object, you can call all methods of the
		113	C<urxvt::term> class on this object.
		114
		115	Additional methods only supported for extension objects are described in
		116	the C<urxvt::extension> section below.
		117
		118	=head2 META comments
		119
		120	Rxvt-unicode recognizes special meta comments in extensions that define
		121	different types of metadata.
		122
		123	Currently, it recxognises only one such comment:
		124
		125	=over 4
		126
		127	=item #:META:RESOURCE:name:type:desc
		128
		129	The RESOURCE comment defines a resource used by the extension, where
		130	C<name> is the resource name, C<type> is the resource type, C<boolean>
		131	or C<string>, and C<desc> is the resource description.
		132
		133	=back
		134
120	=head2 Hooks	135	=head2 Hooks
121		136
122	The following subroutines can be declared in loaded scripts, and will be	137	The following subroutines can be declared in extension files, and will be
123	called whenever the relevant event happens.	138	called whenever the relevant event happens.
124		139
125	The first argument passed to them is an object private to each terminal	140	The first argument passed to them is an extension object as described in
126	and extension package. You can call all C<urxvt::term> methods on it, but	141	the in the C<Extension Objects> section.
127	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
128	object that is shared between all packages is stored in the C<term>
129	member.
130		142
131	All of them must return a boolean value. If it is true, then the event	143	B<All> of these hooks must return a boolean value. If any of the called
132	counts as being I<consumed>, and the invocation of other hooks is skipped,	144	hooks returns true, then the event counts as being I<consumed>, and the
133	and the relevant action might not be carried out by the C++ code.	145	relevant action might not be carried out by the C++ code.
134		146
135	When in doubt, return a false value (preferably C<()>).	147	I<< When in doubt, return a false value (preferably C<()>). >>
136		148
137	=over 4	149	=over 4
138		150
139	=item on_init $term	151	=item on_init $term
140		152
141	Called after a new terminal object has been initialized, but before	153	Called after a new terminal object has been initialized, but before
142	windows are created or the command gets run. Most methods are unsafe to	154	windows are created or the command gets run. Most methods are unsafe to
143	call or deliver senseless data, as terminal size and other characteristics	155	call or deliver senseless data, as terminal size and other characteristics
144	have not yet been determined. You can safely query and change resources,	156	have not yet been determined. You can safely query and change resources
145	though.	157	and options, though. For many purposes the C<on_start> hook is a better
		158	place.
		159
		160	=item on_start $term
		161
		162	Called at the very end of initialisation of a new terminal, just before
		163	trying to map (display) the toplevel and returning to the main loop.
		164
		165	=item on_destroy $term
		166
		167	Called whenever something tries to destroy terminal, when the terminal is
		168	still fully functional (not for long, though).
146		169
147	=item on_reset $term	170	=item on_reset $term
148		171
149	Called after the screen is "reset" for any reason, such as resizing or	172	Called after the screen is "reset" for any reason, such as resizing or
150	control sequences. Here is where you can react on changes to size-related	173	control sequences. Here is where you can react on changes to size-related
151	variables.	174	variables.
152		175
153	=item on_start $term	176	=item on_child_start $term, $pid
154		177
155	Called at the very end of initialisation of a new terminal, just before	178	Called just after the child process has been C<fork>ed.
156	returning to the mainloop.	179
		180	=item on_child_exit $term, $status
		181
		182	Called just after the child process has exited. C<$status> is the status
		183	from C<waitpid>.
157		184
158	=item on_sel_make $term, $eventtime	185	=item on_sel_make $term, $eventtime
159		186
160	Called whenever a selection has been made by the user, but before the	187	Called whenever a selection has been made by the user, but before the
161	selection text is copied, so changes to the beginning, end or type of the	188	selection text is copied, so changes to the beginning, end or type of the
…		…
168		195
169	Called whenever a selection has been copied, but before the selection is	196	Called whenever a selection has been copied, but before the selection is
170	requested from the server. The selection text can be queried and changed	197	requested from the server. The selection text can be queried and changed
171	by calling C<< $term->selection >>.	198	by calling C<< $term->selection >>.
172		199
173	Returning a true value aborts selection grabbing. It will still be hilighted.	200	Returning a true value aborts selection grabbing. It will still be highlighted.
174		201
175	=item on_sel_extend $term	202	=item on_sel_extend $term
176		203
177	Called whenever the user tries to extend the selection (e.g. with a double	204	Called whenever the user tries to extend the selection (e.g. with a double
178	click) and is either supposed to return false (normal operation), or	205	click) and is either supposed to return false (normal operation), or
179	should extend the selection itelf and return true to suppress the built-in	206	should extend the selection itself and return true to suppress the built-in
180	processing.	207	processing. This can happen multiple times, as long as the callback
		208	returns true, it will be called on every further click by the user and is
		209	supposed to enlarge the selection more and more, if possible.
181		210
182	See the F<selection> example extension.	211	See the F<selection> example extension.
183		212
184	=item on_focus_in $term
185
186	Called whenever the window gets the keyboard focus, before urxvt does
187	focus in processing.
188
189	=item on_focus_out $term
190
191	Called wheneever the window loses keyboard focus, before urxvt does focus
192	out processing.
193
194	=item on_view_change $term, $offset	213	=item on_view_change $term, $offset
195		214
196	Called whenever the view offset changes, i..e the user or program	215	Called whenever the view offset changes, i.e. the user or program
197	scrolls. Offset C<0> means display the normal terminal, positive values	216	scrolls. Offset C<0> means display the normal terminal, positive values
198	show this many lines of scrollback.	217	show this many lines of scrollback.
199		218
200	=item on_scroll_back $term, $lines, $saved	219	=item on_scroll_back $term, $lines, $saved
201		220
…		…
205		224
206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	225	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
207	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	226	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
208	number of lines that will be in the scrollback buffer.	227	number of lines that will be in the scrollback buffer.
209		228
210	=item on_tty_activity $term *NYI*
211
212	Called whenever the program(s) running in the urxvt window send output.
213
214	=item on_osc_seq $term, $string	229	=item on_osc_seq $term, $op, $args, $resp
		230
		231	Called on every OSC sequence and can be used to suppress it or modify its
		232	behaviour. The default should be to return an empty list. A true value
		233	suppresses execution of the request completely. Make sure you don't get
		234	confused by recursive invocations when you output an OSC sequence within
		235	this callback.
		236
		237	C<on_osc_seq_perl> should be used for new behaviour.
		238
		239	=item on_osc_seq_perl $term, $args, $resp
215		240
216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	241	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217	operating system command) is processed. Cursor position and other state	242	operating system command) is processed. Cursor position and other state
218	information is up-to-date when this happens. For interoperability, the	243	information is up-to-date when this happens. For interoperability, the
219	string should start with the extension name and a colon, to distinguish	244	string should start with the extension name (sans -osc) and a semicolon,
220	it from commands for other extensions, and this might be enforced in the	245	to distinguish it from commands for other extensions, and this might be
221	future.	246	enforced in the future.
		247
		248	For example, C<overlay-osc> uses this:
		249
		250	sub on_osc_seq_perl {
		251	my ($self, $osc, $resp) = @_;
		252
		253	return unless $osc =~ s/^overlay;//;
		254
		255	... process remaining $osc string
		256	}
222		257
223	Be careful not ever to trust (in a security sense) the data you receive,	258	Be careful not ever to trust (in a security sense) the data you receive,
224	as its source can not easily be controleld (e-mail content, messages from	259	as its source can not easily be controlled (e-mail content, messages from
225	other users on the same system etc.).	260	other users on the same system etc.).
		261
		262	For responses, C<$resp> contains the end-of-args separator used by the
		263	sender.
226		264
227	=item on_add_lines $term, $string	265	=item on_add_lines $term, $string
228		266
229	Called whenever text is about to be output, with the text as argument. You	267	Called whenever text is about to be output, with the text as argument. You
230	can filter/change and output the text yourself by returning a true value	268	can filter/change and output the text yourself by returning a true value
231	and calling C<< $term->scr_add_lines >> yourself. Please note that this	269	and calling C<< $term->scr_add_lines >> yourself. Please note that this
232	might be very slow, however, as your hook is called for B<all> text being	270	might be very slow, however, as your hook is called for B<all> text being
233	output.	271	output.
234		272
		273	=item on_tt_write $term, $octets
		274
		275	Called whenever some data is written to the tty/pty and can be used to
		276	suppress or filter tty input.
		277
		278	=item on_tt_paste $term, $octets
		279
		280	Called whenever text is about to be pasted, with the text as argument. You
		281	can filter/change and paste the text yourself by returning a true value
		282	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		283	locale-encoded.
		284
235	=item on_line_update $term, $row	285	=item on_line_update $term, $row
236		286
237	Called whenever a line was updated or changed. Can be used to filter	287	Called whenever a line was updated or changed. Can be used to filter
238	screen output (e.g. underline urls or other useless stuff). Only lines	288	screen output (e.g. underline urls or other useless stuff). Only lines
239	that are being shown will be filtered, and, due to performance reasons,	289	that are being shown will be filtered, and, due to performance reasons,
…		…
246	later with the already-modified line (e.g. if unrelated parts change), so	296	later with the already-modified line (e.g. if unrelated parts change), so
247	you cannot just toggle rendition bits, but only set them.	297	you cannot just toggle rendition bits, but only set them.
248		298
249	=item on_refresh_begin $term	299	=item on_refresh_begin $term
250		300
251	Called just before the screen gets redrawn. Can be used for overlay	301	Called just before the screen gets redrawn. Can be used for overlay or
252	or similar effects by modify terminal contents in refresh_begin, and	302	similar effects by modifying the terminal contents in refresh_begin, and
253	restoring them in refresh_end. The built-in overlay and selection display	303	restoring them in refresh_end. The built-in overlay and selection display
254	code is run after this hook, and takes precedence.	304	code is run after this hook, and takes precedence.
255		305
256	=item on_refresh_end $term	306	=item on_refresh_end $term
257		307
258	Called just after the screen gets redrawn. See C<on_refresh_begin>.	308	Called just after the screen gets redrawn. See C<on_refresh_begin>.
259		309
		310	=item on_action $term, $string
		311
		312	Called whenever an action is invoked for the corresponding extension
		313	(e.g. via a C<extension:string> builtin action bound to a key, see
		314	description of the B<keysym> resource in the urxvt(1) manpage). The
		315	event is simply the action string. Note that an action event is always
		316	associated to a single extension.
		317
260	=item on_keyboard_command $term, $string	318	=item on_user_command $term, $string *DEPRECATED*
261		319
262	Called whenever the user presses a key combination that has a	320	Called whenever a user-configured event is being activated (e.g. via
263	C<perl:string> action bound to it (see description of the B<keysym>	321	a C<perl:string> action bound to a key, see description of the B<keysym>
264	resource in the @@RXVT_NAME@@(1) manpage).	322	resource in the urxvt(1) manpage).
		323
		324	The event is simply the action string. This interface is going away in
		325	preference to the C<on_action> hook.
		326
		327	=item on_resize_all_windows $term, $new_width, $new_height
		328
		329	Called just after the new window size has been calculated, but before
		330	windows are actually being resized or hints are being set. If this hook
		331	returns a true value, setting of the window hints is being skipped.
		332
		333	=item on_x_event $term, $event
		334
		335	Called on every X event received on the vt window (and possibly other
		336	windows). Should only be used as a last resort. Most event structure
		337	members are not passed.
		338
		339	=item on_root_event $term, $event
		340
		341	Like C<on_x_event>, but is called for events on the root window.
		342
		343	=item on_focus_in $term
		344
		345	Called whenever the window gets the keyboard focus, before rxvt-unicode
		346	does focus in processing.
		347
		348	=item on_focus_out $term
		349
		350	Called whenever the window loses keyboard focus, before rxvt-unicode does
		351	focus out processing.
		352
		353	=item on_configure_notify $term, $event
		354
		355	=item on_property_notify $term, $event
		356
		357	=item on_key_press $term, $event, $keysym, $octets
		358
		359	=item on_key_release $term, $event, $keysym
		360
		361	=item on_button_press $term, $event
		362
		363	=item on_button_release $term, $event
		364
		365	=item on_motion_notify $term, $event
		366
		367	=item on_map_notify $term, $event
		368
		369	=item on_unmap_notify $term, $event
		370
		371	Called whenever the corresponding X event is received for the terminal. If
		372	the hook returns true, then the event will be ignored by rxvt-unicode.
		373
		374	The event is a hash with most values as named by Xlib (see the XEvent
		375	manpage), with the additional members C<row> and C<col>, which are the
		376	(real, not screen-based) row and column under the mouse cursor.
		377
		378	C<on_key_press> additionally receives the string rxvt-unicode would
		379	output, if any, in locale-specific encoding.
		380
		381	=item on_client_message $term, $event
		382
		383	=item on_wm_protocols $term, $event
		384
		385	=item on_wm_delete_window $term, $event
		386
		387	Called when various types of ClientMessage events are received (all with
		388	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		389
		390	=item on_bell $term
		391
		392	Called on receipt of a bell character.
265		393
266	=back	394	=back
267		395
		396	=cut
		397
		398	package urxvt;
		399
		400	use utf8;
		401	use strict 'vars';
		402	use Carp ();
		403	use Scalar::Util ();
		404	use List::Util ();
		405
		406	our $VERSION = 1;
		407	our $TERM;
		408	our @TERM_INIT; # should go, prevents async I/O etc.
		409	our @TERM_EXT; # should go, prevents async I/O etc.
		410	our @HOOKNAME;
		411	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		412	our %OPTION;
		413
		414	our $LIBDIR;
		415	our $RESNAME;
		416	our $RESCLASS;
		417	our $RXVTNAME;
		418
		419	our $NOCHAR = chr 0xffff;
		420
268	=head2 Variables in the C<urxvt> Package	421	=head2 Variables in the C<urxvt> Package
269		422
270	=over 4	423	=over 4
271		424
		425	=item $urxvt::LIBDIR
		426
		427	The rxvt-unicode library directory, where, among other things, the perl
		428	modules and scripts are stored.
		429
		430	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		431
		432	The resource class and name rxvt-unicode uses to look up X resources.
		433
		434	=item $urxvt::RXVTNAME
		435
		436	The basename of the installed binaries, usually C<urxvt>.
		437
272	=item $urxvt::TERM	438	=item $urxvt::TERM
273		439
274	The current terminal. Whenever a callback/Hook is bein executed, this	440	The current terminal. This variable stores the current C<urxvt::term>
275	variable stores the current C<urxvt::term> object.	441	object, whenever a callback/hook is executing.
		442
		443	=item @urxvt::TERM_INIT
		444
		445	All code references in this array will be called as methods of the next newly
		446	created C<urxvt::term> object (during the C<on_init> phase). The array
		447	gets cleared before the code references that were in it are being executed,
		448	so references can push themselves onto it again if they so desire.
		449
		450	This complements to the perl-eval command line option, but gets executed
		451	first.
		452
		453	=item @urxvt::TERM_EXT
		454
		455	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		456	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		457	but before other extensions. Gets cleared just like C<@TERM_INIT>.
276		458
277	=back	459	=back
278		460
279	=head2 Functions in the C<urxvt> Package	461	=head2 Functions in the C<urxvt> Package
280		462
281	=over 4	463	=over 4
282		464
283	=item $term = new urxvt [arg...]
284
285	Creates a new terminal, very similar as if you had started it with
286	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
287	if the new instance couldn't be created. Returns C<undef> if the new
288	instance didn't initialise perl, and the terminal object otherwise. The
289	C<init> and C<start> hooks will be called during the call.
290
291	=item urxvt::fatal $errormessage	465	=item urxvt::fatal $errormessage
292		466
293	Fatally aborts execution with the given error message. Avoid at all	467	Fatally aborts execution with the given error message (which should
294	costs! The only time this is acceptable is when the terminal process	468	include a trailing newline). Avoid at all costs! The only time this
295	starts up.	469	is acceptable (and useful) is in the init hook, where it prevents the
		470	terminal from starting up.
296		471
297	=item urxvt::warn $string	472	=item urxvt::warn $string
298		473
299	Calls C<rxvt_warn> with the given string which should not include a	474	Calls C<rxvt_warn> with the given string which should include a trailing
300	newline. The module also overwrites the C<warn> builtin with a function	475	newline. The module also overwrites the C<warn> builtin with a function
301	that calls this function.	476	that calls this function.
302		477
303	Using this function has the advantage that its output ends up in the	478	Using this function has the advantage that its output ends up in the
304	correct place, e.g. on stderr of the connecting urxvtc client.	479	correct place, e.g. on stderr of the connecting urxvtc client.
305		480
		481	Messages have a size limit of 1023 bytes currently.
		482
		483	=item @terms = urxvt::termlist
		484
		485	Returns all urxvt::term objects that exist in this process, regardless of
		486	whether they are started, being destroyed etc., so be careful. Only term
		487	objects that have perl extensions attached will be returned (because there
		488	is no urxvt::term object associated with others).
		489
306	=item $time = urxvt::NOW	490	=item $time = urxvt::NOW
307		491
308	Returns the "current time" (as per the event loop).	492	Returns the "current time" (as per the event loop).
		493
		494	=item urxvt::CurrentTime
		495
		496	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		497	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		498	Button4Mask, Button5Mask, AnyModifier
		499
		500	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		501	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		502	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		503	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		504	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		505	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		506	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		507
		508	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		509	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		510	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		511	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		512	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		513	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		514	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		515
		516	Various constants for use in X calls and event processing.
309		517
310	=back	518	=back
311		519
312	=head2 RENDITION	520	=head2 RENDITION
313		521
…		…
328		536
329	=item $rend = urxvt::OVERLAY_RSTYLE	537	=item $rend = urxvt::OVERLAY_RSTYLE
330		538
331	Return the rendition mask used for overlays by default.	539	Return the rendition mask used for overlays by default.
332		540
333	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	541	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		542	urxvt::RS_RVid, urxvt::RS_Uline
334		543
335	Return the bit that enabled bold, italic, blink, reverse-video and	544	Return the bit that enabled bold, italic, blink, reverse-video and
336	underline, respectively. To enable such a style, just logically OR it into	545	underline, respectively. To enable such a style, just logically OR it into
337	the bitset.	546	the bitset.
338		547
…		…
340		549
341	=item $background = urxvt::GET_BASEBG $rend	550	=item $background = urxvt::GET_BASEBG $rend
342		551
343	Return the foreground/background colour index, respectively.	552	Return the foreground/background colour index, respectively.
344		553
345	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	554	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
346		555
347	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	556	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		557
		558	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
348		559
349	Replace the foreground/background colour in the rendition mask with the	560	Replace the foreground/background colour in the rendition mask with the
350	specified one.	561	specified one.
351		562
352	=item $value = urxvt::GET_CUSTOM ($rend)	563	=item $value = urxvt::GET_CUSTOM $rend
353		564
354	Return the "custom" value: Every rendition has 5 bits for use by	565	Return the "custom" value: Every rendition has 5 bits for use by
355	extensions. They can be set and changed as you like and are initially	566	extensions. They can be set and changed as you like and are initially
356	zero.	567	zero.
357		568
358	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	569	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
359		570
360	Change the custom value.	571	Change the custom value.
361		572
362	=back	573	=back
363		574
364	=cut	575	=cut
365		576
366	package urxvt;
367
368	use strict;
369	use Scalar::Util ();
370
371	our $TERM;
372	our @HOOKNAME;
373	our $LIBDIR;
374
375	BEGIN {	577	BEGIN {
376	urxvt->bootstrap;
377
378	# overwrite perl's warn	578	# overwrite perl's warn
379	*CORE::GLOBAL::warn = sub {	579	*CORE::GLOBAL::warn = sub {
380	my $msg = join "", @_;	580	my $msg = join "", @_;
381	$msg .= "\n"	581	$msg .= "\n"
382	unless $msg =~ /\n$/;	582	unless $msg =~ /\n$/;
383	urxvt::warn ($msg);	583	urxvt::warn ($msg);
384	};	584	};
385	}	585	}
386		586
387	my @hook_count;	587	no warnings 'utf8';
		588
		589	sub parse_resource {
		590	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		591
		592	$term->scan_extensions;
		593
		594	my $r = $term->{meta}{resource};
		595	keys %$r; # reset iterator
		596	while (my ($k, $v) = each %$r) {
		597	my $pattern = $k;
		598	$pattern =~ y/./-/ if $isarg;
		599	my $prefix = $name;
		600	my $suffix;
		601	if ($pattern =~ /\-$/) {
		602	$prefix = substr $name, 0, length $pattern;
		603	$suffix = substr $name, length $pattern;
		604	}
		605	if ($pattern eq $prefix) {
		606	$name = "$urxvt::RESCLASS.$k$suffix";
		607
		608	push @{ $term->{perl_ext_3} }, $v->[0];
		609
		610	if ($v->[1] eq "boolean") {
		611	$term->put_option_db ($name, $flag ? "true" : "false");
		612	return 1;
		613	} else {
		614	$term->put_option_db ($name, $value);
		615	return 1 + 2;
		616	}
		617	}
		618	}
		619
		620	0
		621	}
		622
		623	sub usage {
		624	my ($term, $usage_type) = @_;
		625
		626	$term->scan_extensions;
		627
		628	my $r = $term->{meta}{resource};
		629
		630	for my $pattern (sort keys %$r) {
		631	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		632
		633	$desc .= " (-pe $ext)";
		634
		635	if ($usage_type == 1) {
		636	$pattern =~ y/./-/;
		637	$pattern =~ s/-$/-.../g;
		638
		639	if ($type eq "boolean") {
		640	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		641	} else {
		642	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		643	}
		644	} else {
		645	$pattern =~ s/\.$/.*/g;
		646	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		647	}
		648	}
		649	}
		650
388	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	651	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
389		652
390	sub verbose {	653	sub verbose {
391	my ($level, $msg) = @_;	654	my ($level, $msg) = @_;
392	warn "$msg\n" if $level <= $verbosity;	655	warn "$msg\n" if $level <= $verbosity;
393	}	656	}
394		657
395	# find on_xxx subs in the package and register them	658	my %extension_pkg;
396	# as hooks
397	sub register_package($) {
398	my ($pkg) = @_;
399
400	for my $htype (0.. $#HOOKNAME) {
401	my $name = $HOOKNAME[$htype];
402
403	my $ref = $pkg->can ("on_" . lc $name)
404	or next;
405
406	$TERM->{_hook}[$htype]{$pkg} = $ref;
407	$hook_count[$htype]++
408	or set_should_invoke $htype, 1;
409	}
410	}
411
412	my $script_pkg = "script0000";
413	my %script_pkg;
414		659
415	# load a single script into its own package, once only	660	# load a single script into its own package, once only
416	sub script_package($) {	661	sub extension_package($) {
417	my ($path) = @_;	662	my ($path) = @_;
418		663
419	$script_pkg{$path} ||= do {	664	$extension_pkg{$path} ||= do {
420	my $pkg = "urxvt::" . ($script_pkg++);	665	$path =~ /([^\/\\]+)$/;
		666	my $pkg = $1;
		667	$pkg =~ s/[^[:word:]]/_/g;
		668	$pkg = "urxvt::ext::$pkg";
421		669
422	verbose 3, "loading script '$path' into package '$pkg'";	670	verbose 3, "loading extension '$path' into package '$pkg'";
		671
		672	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
423		673
424	open my $fh, "<:raw", $path	674	open my $fh, "<:raw", $path
425	or die "$path: $!";	675	or die "$path: $!";
426		676
427	my $source = "package $pkg; use strict; use utf8;\n"	677	my $source =
		678	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
428	. "#line 1 \"$path\"\n{\n"	679	. "#line 1 \"$path\"\n{\n"
429	. (do { local $/; <$fh> })	680	. (do { local $/; <$fh> })
430	. "\n};\n1";	681	. "\n};\n1";
431		682
		683	eval $source
432	eval $source or die "$path: $@";	684	or die "$path: $@";
433		685
434	$pkg	686	$pkg
435	}	687	}
436	}	688	}
437		689
…		…
440	# called by the rxvt core	692	# called by the rxvt core
441	sub invoke {	693	sub invoke {
442	local $TERM = shift;	694	local $TERM = shift;
443	my $htype = shift;	695	my $htype = shift;
444		696
445	if ($htype == 0) { # INIT	697	if ($htype == HOOK_INIT) {
446	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	698	my @dirs = $TERM->perl_libdirs;
447		699
		700	$TERM->scan_extensions;
		701
		702	my %ext_arg;
		703
		704	{
		705	my @init = @TERM_INIT;
		706	@TERM_INIT = ();
		707	$_->($TERM) for @init;
		708	my @pkg = @TERM_EXT;
		709	@TERM_EXT = ();
		710	$TERM->register_package ($_) for @pkg;
		711	}
		712
		713	for (
448	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	714	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		715	@{ delete $TERM->{perl_ext_3} }
		716	) {
		717	if ($_ eq "default") {
		718
		719	$ext_arg{$_} = []
		720	for qw(selection option-popup selection-popup readline searchable-scrollback);
		721
		722	for ($TERM->_keysym_resources) {
		723	next if /^(?:string|command|builtin|builtin-string|perl)/;
		724	next unless /^([A-Za-z0-9_\-]+):/;
		725
		726	my $ext = $1;
		727
		728	$ext_arg{$ext} = [];
		729	}
		730
		731	} elsif (/^-(.*)$/) {
		732	delete $ext_arg{$1};
		733
		734	} elsif (/^([^<]+)<(.*)>$/) {
		735	push @{ $ext_arg{$1} }, $2;
		736
		737	} else {
		738	$ext_arg{$_} ||= [];
		739	}
		740	}
		741
		742	for my $ext (sort keys %ext_arg) {
449	my @files = grep -f $_, map "$_/$ext", @dirs;	743	my @files = grep -f $_, map "$_/$ext", @dirs;
450		744
451	if (@files) {	745	if (@files) {
452	register_package script_package $files[0];	746	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
453	} else {	747	} else {
454	warn "perl extension '$ext' not found in perl library search path\n";	748	warn "perl extension '$ext' not found in perl library search path\n";
455	}	749	}
456	}	750	}
		751
		752	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		753	warn $@ if $@;
457	}	754	}
458		755
459	$retval = undef;	756	$retval = undef;
460		757
461	if (my $cb = $TERM->{_hook}[$htype]) {	758	if (my $cb = $TERM->{_hook}[$htype]) {
462	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	759	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
463	if $verbosity >= 10;	760	if $verbosity >= 10;
464		761
465	keys %$cb;	762	if ($htype == HOOK_ACTION) {
		763	# this hook is only sent to the extension with the name
		764	# matching the first arg
		765	my $pkg = shift;
		766	$pkg =~ y/-/_/;
		767	$pkg = "urxvt::ext::$pkg";
466		768
467	while (my ($pkg, $cb) = each %$cb) {	769	$cb = $cb->{$pkg}
468	$retval = $cb->(	770	or return undef; #TODO: maybe warn user?
469	$TERM->{_pkg}{$pkg} ||= do {	771
470	my $proxy = bless { }, urxvt::term::proxy::;	772	$cb = { $pkg => $cb };
471	Scalar::Util::weaken ($proxy->{term} = $TERM);
472	$proxy
473	},
474	@_,
475	) and last;
476	}	773	}
477	}
478		774
479	if ($htype == 1) { # DESTROY	775	for my $pkg (keys %$cb) {
480	# remove hooks if unused	776	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
481	if (my $hook = $TERM->{_hook}) {	777	$retval ||= $retval_;
482	for my $htype (0..$#$hook) {	778
483	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }	779	if ($@) {
484	or set_should_invoke $htype, 0;	780	$TERM->ungrab; # better to lose the grab than the session
		781	warn $@;
485	}	782	}
486	}	783	}
487		784
		785	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		786	if $verbosity >= 11;
		787	}
		788
		789	if ($htype == HOOK_DESTROY) {
488	# clear package objects	790	# clear package objects
489	%$_ = () for values %{ $TERM->{_pkg} };	791	%$_ = () for values %{ $TERM->{_pkg} };
490		792
491	# clear package	793	# clear package
492	%$TERM = ();	794	%$TERM = ();
493	}	795	}
494		796
495	$retval	797	$retval
496	}	798	}
497		799
498	sub urxvt::term::proxy::AUTOLOAD {	800	sub SET_COLOR($$$) {
499	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	801	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		802	}
		803
		804	sub rend2mask {
		805	no strict 'refs';
		806	my ($str, $mask) = (@_, 0);
		807	my %color = ( fg => undef, bg => undef );
		808	my @failed;
		809	for my $spec ( split /\s+/, $str ) {
		810	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		811	$color{lc($1)} = $2;
		812	} else {
		813	my $neg = $spec =~ s/^[-^]//;
		814	unless ( exists &{"RS_$spec"} ) {
		815	push @failed, $spec;
		816	next;
		817	}
		818	my $cur = &{"RS_$spec"};
		819	if ( $neg ) {
		820	$mask &= ~$cur;
		821	} else {
		822	$mask |= $cur;
		823	}
		824	}
		825	}
		826	($mask, @color{qw(fg bg)}, \@failed)
		827	}
		828
		829	package urxvt::term::extension;
		830
		831	=head2 The C<urxvt::term::extension> class
		832
		833	Each extension attached to a terminal object is represented by
		834	a C<urxvt::term::extension> object.
		835
		836	You can use these objects, which are passed to all callbacks to store any
		837	state related to the terminal and extension instance.
		838
		839	The methods (And data members) documented below can be called on extension
		840	objects, in addition to call methods documented for the <urxvt::term>
		841	class.
		842
		843	=over 4
		844
		845	=item $urxvt_term = $self->{term}
		846
		847	Returns the C<urxvt::term> object associated with this instance of the
		848	extension. This member I<must not> be changed in any way.
		849
		850	=cut
		851
		852	our $AUTOLOAD;
		853
		854	sub AUTOLOAD {
		855	$AUTOLOAD =~ /:([^:]+)$/
500	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	856	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
501		857
502	eval qq{	858	eval qq{
503	sub $urxvt::term::proxy::AUTOLOAD {	859	sub $AUTOLOAD {
504	my \$proxy = shift;	860	my \$proxy = shift;
505	\$proxy->{term}->$1 (\@_)	861	\$proxy->{term}->$1 (\@_)
506	}	862	}
507	1	863	1
508	} or die "FATAL: unable to compile method forwarder: $@";	864	} or die "FATAL: unable to compile method forwarder: $@";
509		865
510	goto &$urxvt::term::proxy::AUTOLOAD;	866	goto &$AUTOLOAD;
511	}	867	}
		868
		869	sub DESTROY {
		870	# nop
		871	}
		872
		873	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
		874
		875	sub urxvt::destroy_hook::DESTROY {
		876	${$_[0]}->();
		877	}
		878
		879	sub urxvt::destroy_hook(&) {
		880	bless \shift, urxvt::destroy_hook::
		881	}
		882
		883	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		884
		885	Dynamically enable the given hooks (named without the C<on_> prefix) for
		886	this extension, replacing any hook previously installed via C<enable> in
		887	this extension.
		888
		889	This is useful when you want to overwrite time-critical hooks only
		890	temporarily.
		891
		892	To install additional callbacks for the same hook, you can use the C<on>
		893	method of the C<urxvt::term> class.
		894
		895	=item $self->disable ($hook_name[, $hook_name..])
		896
		897	Dynamically disable the given hooks.
		898
		899	=cut
		900
		901	sub enable {
		902	my ($self, %hook) = @_;
		903	my $pkg = $self->{_pkg};
		904
		905	while (my ($name, $cb) = each %hook) {
		906	my $htype = $HOOKTYPE{uc $name};
		907	defined $htype
		908	or Carp::croak "unsupported hook type '$name'";
		909
		910	$self->set_should_invoke ($htype, +1)
		911	unless exists $self->{term}{_hook}[$htype]{$pkg};
		912
		913	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		914	}
		915	}
		916
		917	sub disable {
		918	my ($self, @hook) = @_;
		919	my $pkg = $self->{_pkg};
		920
		921	for my $name (@hook) {
		922	my $htype = $HOOKTYPE{uc $name};
		923	defined $htype
		924	or Carp::croak "unsupported hook type '$name'";
		925
		926	$self->set_should_invoke ($htype, -1)
		927	if delete $self->{term}{_hook}[$htype]{$pkg};
		928	}
		929	}
		930
		931	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		932
		933	Similar to the C<enable> enable, but installs additional callbacks for
		934	the given hook(s) (that is, it doesn't replace existing callbacks), and
		935	returns a guard object. When the guard object is destroyed the callbacks
		936	are disabled again.
		937
		938	=cut
		939
		940	sub urxvt::extension::on_disable::DESTROY {
		941	my $disable = shift;
		942
		943	my $term = delete $disable->{""};
		944
		945	while (my ($htype, $id) = each %$disable) {
		946	delete $term->{_hook}[$htype]{$id};
		947	$term->set_should_invoke ($htype, -1);
		948	}
		949	}
		950
		951	sub on {
		952	my ($self, %hook) = @_;
		953
		954	my $term = $self->{term};
		955
		956	my %disable = ( "" => $term );
		957
		958	while (my ($name, $cb) = each %hook) {
		959	my $htype = $HOOKTYPE{uc $name};
		960	defined $htype
		961	or Carp::croak "unsupported hook type '$name'";
		962
		963	$term->set_should_invoke ($htype, +1);
		964	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		965	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		966	}
		967
		968	bless \%disable, "urxvt::extension::on_disable"
		969	}
		970
		971	=item $self->bind_action ($hotkey, $action)
		972
		973	=item $self->x_resource ($pattern)
		974
		975	=item $self->x_resource_boolean ($pattern)
		976
		977	These methods support an additional C<%> prefix for C<$action> or
		978	C<$pattern> when called on an extension object, compared to the
		979	C<urxvt::term> methods of the same name - see the description of these
		980	methods in the C<urxvt::term> class for details.
		981
		982	=cut
		983
		984	sub bind_action {
		985	my ($self, $hotkey, $action) = @_;
		986	$action =~ s/^%:/$_[0]{_name}:/;
		987	$self->{term}->bind_action ($hotkey, $action)
		988	}
		989
		990	sub x_resource {
		991	my ($self, $name) = @_;
		992	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		993	$self->{term}->x_resource ($name)
		994	}
		995
		996	sub x_resource_boolean {
		997	my ($self, $name) = @_;
		998	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		999	$self->{term}->x_resource_boolean ($name)
		1000	}
		1001
		1002	=back
		1003
		1004	=cut
		1005
		1006	package urxvt::anyevent;
		1007
		1008	=head2 The C<urxvt::anyevent> Class
		1009
		1010	The sole purpose of this class is to deliver an interface to the
		1011	C<AnyEvent> module - any module using it will work inside urxvt without
		1012	further programming. The only exception is that you cannot wait on
		1013	condition variables, but non-blocking condvar use is ok.
		1014
		1015	In practical terms this means is that you cannot use blocking APIs, but
		1016	the non-blocking variant should work.
		1017
		1018	=cut
		1019
		1020	our $VERSION = '5.23';
		1021
		1022	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		1023	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		1024
		1025	sub timer {
		1026	my ($class, %arg) = @_;
		1027
		1028	my $cb = $arg{cb};
		1029
		1030	urxvt::timer
		1031	->new
		1032	->after ($arg{after}, $arg{interval})
		1033	->cb ($arg{interval} ? $cb : sub {
		1034	$_[0]->stop; # need to cancel manually
		1035	$cb->();
		1036	})
		1037	}
		1038
		1039	sub io {
		1040	my ($class, %arg) = @_;
		1041
		1042	my $cb = $arg{cb};
		1043	my $fd = fileno $arg{fh};
		1044	defined $fd or $fd = $arg{fh};
		1045
		1046	bless [$arg{fh}, urxvt::iow
		1047	->new
		1048	->fd ($fd)
		1049	->events (($arg{poll} =~ /r/ ? 1 : 0)
		1050	| ($arg{poll} =~ /w/ ? 2 : 0))
		1051	->start
		1052	->cb ($cb)
		1053	], urxvt::anyevent::
		1054	}
		1055
		1056	sub idle {
		1057	my ($class, %arg) = @_;
		1058
		1059	my $cb = $arg{cb};
		1060
		1061	urxvt::iw
		1062	->new
		1063	->start
		1064	->cb ($cb)
		1065	}
		1066
		1067	sub child {
		1068	my ($class, %arg) = @_;
		1069
		1070	my $cb = $arg{cb};
		1071
		1072	urxvt::pw
		1073	->new
		1074	->start ($arg{pid})
		1075	->cb (sub {
		1076	$_[0]->stop; # need to cancel manually
		1077	$cb->($_[0]->rpid, $_[0]->rstatus);
		1078	})
		1079	}
		1080
		1081	sub DESTROY {
		1082	$_[0][1]->stop;
		1083	}
		1084
		1085	# only needed for AnyEvent < 6 compatibility
		1086	sub one_event {
		1087	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1088	}
		1089
		1090	package urxvt::term;
512		1091
513	=head2 The C<urxvt::term> Class	1092	=head2 The C<urxvt::term> Class
514		1093
515	=over 4	1094	=over 4
516		1095
		1096	=cut
		1097
		1098	# find on_xxx subs in the package and register them
		1099	# as hooks
		1100	sub register_package {
		1101	my ($self, $pkg, $argv) = @_;
		1102
		1103	no strict 'refs';
		1104
		1105	urxvt::verbose 6, "register package $pkg to $self";
		1106
		1107	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1108
		1109	my $proxy = bless {
		1110	_pkg => $pkg,
		1111	_name => ${"$pkg\::_NAME"}, # hackish
		1112	argv => $argv,
		1113	}, $pkg;
		1114	Scalar::Util::weaken ($proxy->{term} = $self);
		1115
		1116	$self->{_pkg}{$pkg} = $proxy;
		1117
		1118	for my $name (@HOOKNAME) {
		1119	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1120	$proxy->enable ($name => $ref);
		1121	}
		1122	}
		1123	}
		1124
		1125	sub perl_libdirs {
		1126	map { split /:/ }
		1127	$_[0]->resource ("perl_lib"),
		1128	$ENV{URXVT_PERL_LIB},
		1129	"$ENV{HOME}/.urxvt/ext",
		1130	"$LIBDIR/perl"
		1131	}
		1132
		1133	# scan for available extensions and collect their metadata
		1134	sub scan_extensions {
		1135	my ($self) = @_;
		1136
		1137	return if exists $self->{meta};
		1138
		1139	my @urxvtdirs = perl_libdirs $self;
		1140	my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1141
		1142	$self->{meta} = \my %meta;
		1143
		1144	# first gather extensions
		1145
		1146	my $gather = sub {
		1147	my ($dir, $core) = @_;
		1148
		1149	opendir my $fh, $dir
		1150	or return;
		1151
		1152	for my $ext (readdir $fh) {
		1153	$ext !~ /^\./
		1154	or next;
		1155
		1156	open my $fh, "<", "$dir/$ext"
		1157	or next;
		1158
		1159	-f $fh
		1160	or next;
		1161
		1162	$ext =~ s/\.uext$// or $core
		1163	or next;
		1164
		1165	my %ext = (dir => $dir);
		1166
		1167	while (<$fh>) {
		1168	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1169	my ($pattern, $type, $desc) = split /:/, $1;
		1170	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1171	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1172	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1173	} else {
		1174	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1175	}
		1176	} elsif (/^\s*(?:#|$)/) {
		1177	# skip other comments and empty lines
		1178	} else {
		1179	last; # stop parsing on first non-empty non-comment line
		1180	}
		1181	}
		1182
		1183	$meta{ext}{$ext} = \%ext;
		1184	}
		1185	};
		1186
		1187	$gather->($_, 0) for @cpandirs;
		1188	$gather->($_, 1) for @urxvtdirs;
		1189
		1190	# and now merge resources
		1191	while (my ($k, $v) = each %{ $meta{ext} }) {
		1192	#TODO: should check for extensions overriding each other
		1193	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1194	}
		1195	}
		1196
		1197	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1198
		1199	Creates a new terminal, very similar as if you had started it with system
		1200	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1201	hash which defines the environment of the new terminal.
		1202
		1203	Croaks (and probably outputs an error message) if the new instance
		1204	couldn't be created. Returns C<undef> if the new instance didn't
		1205	initialise perl, and the terminal object otherwise. The C<init> and
		1206	C<start> hooks will be called before this call returns, and are free to
		1207	refer to global data (which is race free).
		1208
		1209	=cut
		1210
		1211	sub new {
		1212	my ($class, $env, @args) = @_;
		1213
		1214	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1215	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1216
		1217	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1218	}
		1219
517	=item $term->destroy	1220	=item $term->destroy
518		1221
519	Destroy the terminal object (close the window, free resources etc.).	1222	Destroy the terminal object (close the window, free resources
		1223	etc.). Please note that urxvt will not exit as long as any event
		1224	watchers (timers, io watchers) are still active.
		1225
		1226	=item $term->exec_async ($cmd[, @args])
		1227
		1228	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1229	("starts") programs in the background. This function takes care of setting
		1230	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1231	be preferred over explicit calls to C<exec> or C<system>.
		1232
		1233	Returns the pid of the subprocess or C<undef> on error.
		1234
		1235	=cut
		1236
		1237	sub exec_async {
		1238	my $self = shift;
		1239
		1240	my $pid = fork;
		1241
		1242	return $pid
		1243	if !defined $pid or $pid;
		1244
		1245	%ENV = %{ $self->env };
		1246
		1247	exec @_;
		1248	urxvt::_exit 255;
		1249	}
		1250
		1251	=item $isset = $term->option ($optval[, $set])
		1252
		1253	Returns true if the option specified by C<$optval> is enabled, and
		1254	optionally change it. All option values are stored by name in the hash
		1255	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		1256
		1257	Here is a likely non-exhaustive list of option names, please see the
		1258	source file F</src/optinc.h> to see the actual list:
		1259
		1260	borderLess buffered console cursorBlink cursorUnderline hold iconic
		1261	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1262	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
		1263	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
		1264	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
		1265	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1266	urgentOnBell utmpInhibit visualBell
520		1267
521	=item $value = $term->resource ($name[, $newval])	1268	=item $value = $term->resource ($name[, $newval])
522		1269
523	Returns the current resource value associated with a given name and	1270	Returns the current resource value associated with a given name and
524	optionally sets a new value. Setting values is most useful in the C<init>	1271	optionally sets a new value. Setting values is most useful in the C<init>
…		…
533	likely change).	1280	likely change).
534		1281
535	Please note that resource strings will currently only be freed when the	1282	Please note that resource strings will currently only be freed when the
536	terminal is destroyed, so changing options frequently will eat memory.	1283	terminal is destroyed, so changing options frequently will eat memory.
537		1284
538	Here is a a likely non-exhaustive list of resource names, not all of which	1285	Here is a likely non-exhaustive list of resource names, not all of which
539	are supported in every build, please see the source to see the actual	1286	are supported in every build, please see the source file F</src/rsinc.h>
540	list:	1287	to see the actual list:
541		1288
542	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1289	answerbackstring backgroundPixmap backspace_key blurradius
543	borderLess color cursorBlink cursorUnderline cutchars delete_key	1290	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
544	display_name embed ext_bwidth fade font geometry hold iconName	1291	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
545	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1292	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1293	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
546	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1294	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
547	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1295	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
548	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1296	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
549	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1297	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
550	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1298	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
551	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1299	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
552	shade term_name title transparent transparent_all tripleclickwords	1300	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1301	term_name title transient_for transparent tripleclickwords urgentOnBell
553	utmpInhibit visualBell	1302	utmpInhibit visualBell
554		1303
555	=cut	1304	=cut
556		1305
557	sub urxvt::term::resource($$;$) {	1306	sub resource($$;$) {
558	my ($self, $name) = (shift, shift);	1307	my ($self, $name) = (shift, shift);
559	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1308	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
560	goto &urxvt::term::_resource;	1309	goto &urxvt::term::_resource
561	}	1310	}
		1311
		1312	=item $value = $term->x_resource ($pattern)
		1313
		1314	Returns the X-Resource for the given pattern, excluding the program or
		1315	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1316	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1317	resource with that pattern exists.
		1318
		1319	Extensions that define extra resources also need to call this method
		1320	to access their values.
		1321
		1322	If the method is called on an extension object (basically, from an
		1323	extension), then the special prefix C<%.> will be replaced by the name of
		1324	the extension and a dot, and the lone string C<%> will be replaced by the
		1325	extension name itself. This makes it possible to code extensions so you
		1326	can rename them and get a new set of resources without having to change
		1327	the actual code.
		1328
		1329	This method should only be called during the C<on_start> hook, as there is
		1330	only one resource database per display, and later invocations might return
		1331	the wrong resources.
		1332
		1333	=item $value = $term->x_resource_boolean ($pattern)
		1334
		1335	Like C<x_resource>, above, but interprets the string value as a boolean
		1336	and returns C<1> for true values, C<0> for false values and C<undef> if
		1337	the resource or option isn't specified.
		1338
		1339	You should always use this method to parse boolean resources.
		1340
		1341	=cut
		1342
		1343	sub x_resource_boolean {
		1344	my $res = &x_resource;
		1345
		1346	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1347	}
		1348
		1349	=item $success = $term->bind_action ($key, $action)
		1350
		1351	Adds a key binding exactly as specified via a C<keysym> resource. See the
		1352	C<keysym> resource in the urxvt(1) manpage.
		1353
		1354	To add default bindings for an extension, the extension should call C<<
		1355	->bind_action >> on it's C<init> hook for every such binding. Doing it
		1356	in the C<init> hook allows users the override or remove the the binding
		1357	again.
		1358
		1359	Example: the C<searchable-scrollback> by default binds itself
		1360	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1361	$term->bind_action >>.
		1362
		1363	sub init {
		1364	my ($self) = @_;
		1365
		1366	$self->bind_action ("M-s" => "%:start");
		1367	}
562		1368
563	=item $rend = $term->rstyle ([$new_rstyle])	1369	=item $rend = $term->rstyle ([$new_rstyle])
564		1370
565	Return and optionally change the current rendition. Text that is output by	1371	Return and optionally change the current rendition. Text that is output by
566	the terminal application will use this style.	1372	the terminal application will use this style.
…		…
574		1380
575	=item ($row, $col) = $term->selection_beg ([$row, $col])	1381	=item ($row, $col) = $term->selection_beg ([$row, $col])
576		1382
577	=item ($row, $col) = $term->selection_end ([$row, $col])	1383	=item ($row, $col) = $term->selection_end ([$row, $col])
578		1384
579	Return the current values of the selection mark, begin or end positions,	1385	Return the current values of the selection mark, begin or end positions.
580	and optionally set them to new values.
581		1386
		1387	When arguments are given, then the selection coordinates are set to
		1388	C<$row> and C<$col>, and the selection screen is set to the current
		1389	screen.
		1390
		1391	=item $screen = $term->selection_screen ([$screen])
		1392
		1393	Returns the current selection screen, and then optionally sets it.
		1394
		1395	=item $term->selection_make ($eventtime[, $rectangular])
		1396
		1397	Tries to make a selection as set by C<selection_beg> and
		1398	C<selection_end>. If C<$rectangular> is true (default: false), a
		1399	rectangular selection will be made. This is the preferred function to make
		1400	a selection.
		1401
582	=item $success = $term->selection_grab ($eventtime)	1402	=item $success = $term->selection_grab ($eventtime[, $clipboard])
583		1403
584	Try to request the primary selection from the server (for example, as set	1404	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
585	by the next method).	1405	true) selection from the server. The corresponding text can be set
		1406	with the next method. No visual feedback will be given. This function
		1407	is mostly useful from within C<on_sel_grab> hooks.
586		1408
587	=item $oldtext = $term->selection ([$newtext])	1409	=item $oldtext = $term->selection ([$newtext, $clipboard])
588		1410
589	Return the current selection text and optionally replace it by C<$newtext>.	1411	Return the current selection (clipboard if C<$clipboard> is true) text
		1412	and optionally replace it by C<$newtext>.
590		1413
		1414	=item $term->selection_clear ([$clipboard])
		1415
		1416	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1417
591	#=item $term->overlay ($x, $y, $text)	1418	=item $term->overlay_simple ($x, $y, $text)
592	#	1419
593	#Create a simple multi-line overlay box. See the next method for details.	1420	Create a simple multi-line overlay box. See the next method for details.
594	#	1421
595	#=cut	1422	=cut
596	#	1423
597	#sub urxvt::term::scr_overlay {	1424	sub overlay_simple {
598	# my ($self, $x, $y, $text) = @_;	1425	my ($self, $x, $y, $text) = @_;
599	#	1426
600	# my @lines = split /\n/, $text;	1427	my @lines = split /\n/, $text;
601	#	1428
602	# my $w = 0;	1429	my $w = List::Util::max map $self->strwidth ($_), @lines;
603	# for (map $self->strwidth ($_), @lines) {	1430
604	# $w = $_ if $w < $_;
605	# }
606	#
607	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1431	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
608	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1432	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
609	#}	1433
		1434	$overlay
		1435	}
610		1436
611	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1437	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
612		1438
613	Create a new (empty) overlay at the given position with the given	1439	Create a new (empty) overlay at the given position with the given
614	width/height. C<$rstyle> defines the initial rendition style	1440	width/height. C<$rstyle> defines the initial rendition style
…		…
625		1451
626	The methods currently supported on C<urxvt::overlay> objects are:	1452	The methods currently supported on C<urxvt::overlay> objects are:
627		1453
628	=over 4	1454	=over 4
629		1455
630	=item $overlay->set ($x, $y, $text, $rend)	1456	=item $overlay->set ($x, $y, $text[, $rend])
631		1457
632	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1458	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
633	text in rxvt-unicode's special encoding and an array of rendition values	1459	text in rxvt-unicode's special encoding and an array of rendition values
634	at a specific position inside the overlay.	1460	at a specific position inside the overlay.
635		1461
		1462	If C<$rend> is missing, then the rendition will not be changed.
		1463
636	=item $overlay->hide	1464	=item $overlay->hide
637		1465
638	If visible, hide the overlay, but do not destroy it.	1466	If visible, hide the overlay, but do not destroy it.
639		1467
640	=item $overlay->show	1468	=item $overlay->show
641		1469
642	If hidden, display the overlay again.	1470	If hidden, display the overlay again.
643		1471
644	=back	1472	=back
645		1473
		1474	=item $popup = $term->popup ($event)
		1475
		1476	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1477	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1478	currently).
		1479
		1480	=cut
		1481
		1482	sub popup {
		1483	my ($self, $event) = @_;
		1484
		1485	$self->grab ($event->{time}, 1)
		1486	or return;
		1487
		1488	my $popup = bless {
		1489	term => $self,
		1490	event => $event,
		1491	}, urxvt::popup::;
		1492
		1493	Scalar::Util::weaken $popup->{term};
		1494
		1495	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1496	Scalar::Util::weaken $self->{_destroy}{$popup};
		1497
		1498	$popup
		1499	}
		1500
646	=item $cellwidth = $term->strwidth $string	1501	=item $cellwidth = $term->strwidth ($string)
647		1502
648	Returns the number of screen-cells this string would need. Correctly	1503	Returns the number of screen-cells this string would need. Correctly
649	accounts for wide and combining characters.	1504	accounts for wide and combining characters.
650		1505
651	=item $octets = $term->locale_encode $string	1506	=item $octets = $term->locale_encode ($string)
652		1507
653	Convert the given text string into the corresponding locale encoding.	1508	Convert the given text string into the corresponding locale encoding.
654		1509
655	=item $string = $term->locale_decode $octets	1510	=item $string = $term->locale_decode ($octets)
656		1511
657	Convert the given locale-encoded octets into a perl string.	1512	Convert the given locale-encoded octets into a perl string.
		1513
		1514	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1515
		1516	XORs the rendition values in the given span with the provided value
		1517	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1518	refresh hooks to provide effects similar to the selection.
		1519
		1520	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1521
		1522	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1523	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1524	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1525	it instead. Both styles I<MUST NOT> contain font styles.
		1526
		1527	=item $term->scr_bell
		1528
		1529	Ring the bell!
658		1530
659	=item $term->scr_add_lines ($string)	1531	=item $term->scr_add_lines ($string)
660		1532
661	Write the given text string to the screen, as if output by the application	1533	Write the given text string to the screen, as if output by the application
662	running inside the terminal. It may not contain command sequences (escape	1534	running inside the terminal. It may not contain command sequences (escape
663	codes), but is free to use line feeds, carriage returns and tabs. The	1535	codes - see C<cmd_parse> for that), but is free to use line feeds,
664	string is a normal text string, not in locale-dependent encoding.	1536	carriage returns and tabs. The string is a normal text string, not in
		1537	locale-dependent encoding.
665		1538
666	Normally its not a good idea to use this function, as programs might be	1539	Normally its not a good idea to use this function, as programs might be
667	confused by changes in cursor position or scrolling. Its useful inside a	1540	confused by changes in cursor position or scrolling. Its useful inside a
668	C<on_add_lines> hook, though.	1541	C<on_add_lines> hook, though.
669		1542
		1543	=item $term->scr_change_screen ($screen)
		1544
		1545	Switch to given screen - 0 primary, 1 secondary.
		1546
670	=item $term->cmd_parse ($octets)	1547	=item $term->cmd_parse ($octets)
671		1548
672	Similar to C<scr_add_lines>, but the argument must be in the	1549	Similar to C<scr_add_lines>, but the argument must be in the
673	locale-specific encoding of the terminal and can contain command sequences	1550	locale-specific encoding of the terminal and can contain command sequences
674	(escape codes) that will be interpreted.	1551	(escape codes) that will be interpreted.
675		1552
676	=item $term->tt_write ($octets)	1553	=item $term->tt_write ($octets)
677		1554
678	Write the octets given in C<$data> to the tty (i.e. as program input). To	1555	Write the octets given in C<$octets> to the tty (i.e. as user input
		1556	to the program, see C<cmd_parse> for the opposite direction). To pass
679	pass characters instead of octets, you should convert your strings first	1557	characters instead of octets, you should convert your strings first to the
680	to the locale-specific encoding using C<< $term->locale_encode >>.	1558	locale-specific encoding using C<< $term->locale_encode >>.
		1559
		1560	=item $term->tt_write_user_input ($octets)
		1561
		1562	Like C<tt_write>, but should be used when writing strings in response to
		1563	the user pressing a key, to invoke the additional actions requested by
		1564	the user for that case (C<tt_write> doesn't do that).
		1565
		1566	The typical use case would be inside C<on_action> hooks.
		1567
		1568	=item $term->tt_paste ($octets)
		1569
		1570	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1571	CR and bracketing the data with control sequences if bracketed paste mode
		1572	is set.
		1573
		1574	=item $old_events = $term->pty_ev_events ([$new_events])
		1575
		1576	Replaces the event mask of the pty watcher by the given event mask. Can
		1577	be used to suppress input and output handling to the pty/tty. See the
		1578	description of C<< urxvt::timer->events >>. Make sure to always restore
		1579	the previous value.
		1580
		1581	=item $fd = $term->pty_fd
		1582
		1583	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1584	is used.
		1585
		1586	=item $windowid = $term->parent
		1587
		1588	Return the window id of the toplevel window.
		1589
		1590	=item $windowid = $term->vt
		1591
		1592	Return the window id of the terminal window.
		1593
		1594	=item $term->vt_emask_add ($x_event_mask)
		1595
		1596	Adds the specified events to the vt event mask. Useful e.g. when you want
		1597	to receive pointer events all the times:
		1598
		1599	$term->vt_emask_add (urxvt::PointerMotionMask);
		1600
		1601	=item $term->set_urgency ($set)
		1602
		1603	Enable/disable the urgency hint on the toplevel window.
		1604
		1605	=item $term->focus_in
		1606
		1607	=item $term->focus_out
		1608
		1609	=item $term->key_press ($state, $keycode[, $time])
		1610
		1611	=item $term->key_release ($state, $keycode[, $time])
		1612
		1613	Deliver various fake events to to terminal.
681		1614
682	=item $window_width = $term->width	1615	=item $window_width = $term->width
683		1616
684	=item $window_height = $term->height	1617	=item $window_height = $term->height
685		1618
…		…
699		1632
700	=item $max_scrollback = $term->saveLines	1633	=item $max_scrollback = $term->saveLines
701		1634
702	=item $nrow_plus_saveLines = $term->total_rows	1635	=item $nrow_plus_saveLines = $term->total_rows
703		1636
704	=item $lines_in_scrollback = $term->nsaved	1637	=item $topmost_scrollback_row = $term->top_row
705		1638
706	Return various integers describing terminal characteristics.	1639	Return various integers describing terminal characteristics.
707		1640
		1641	=item $x_display = $term->display_id
		1642
		1643	Return the DISPLAY used by rxvt-unicode.
		1644
		1645	=item $lc_ctype = $term->locale
		1646
		1647	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1648
		1649	=item $env = $term->env
		1650
		1651	Returns a copy of the environment in effect for the terminal as a hashref
		1652	similar to C<\%ENV>.
		1653
		1654	=item @envv = $term->envv
		1655
		1656	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1657
		1658	=item @argv = $term->argv
		1659
		1660	Return the argument vector as this terminal, similar to @ARGV, but
		1661	includes the program name as first element.
		1662
		1663	=cut
		1664
		1665	sub env {
		1666	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1667	}
		1668
		1669	=item $modifiermask = $term->ModLevel3Mask
		1670
		1671	=item $modifiermask = $term->ModMetaMask
		1672
		1673	=item $modifiermask = $term->ModNumLockMask
		1674
		1675	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1676	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1677
		1678	=item $screen = $term->current_screen
		1679
		1680	Returns the currently displayed screen (0 primary, 1 secondary).
		1681
		1682	=item $cursor_is_hidden = $term->hidden_cursor
		1683
		1684	Returns whether the cursor is currently hidden or not.
		1685
708	=item $view_start = $term->view_start ([$newvalue])	1686	=item $view_start = $term->view_start ([$newvalue])
709		1687
710	Returns the negative row number of the topmost line. Minimum value is	1688	Returns the row number of the topmost displayed line. Maximum value is
711	C<0>, which displays the normal terminal contents. Larger values scroll	1689	C<0>, which displays the normal terminal contents. Lower values scroll
712	this many lines into the scrollback buffer.	1690	this many lines into the scrollback buffer.
713		1691
714	=item $term->want_refresh	1692	=item $term->want_refresh
715		1693
716	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1694	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
719		1697
720	Used after changing terminal contents to display them.	1698	Used after changing terminal contents to display them.
721		1699
722	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1700	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
723		1701
724	Returns the text of the entire row with number C<$row_number>. Row C<0>	1702	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
725	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1703	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
726	terminal line. The scrollback buffer starts at line C<-1> and extends to
727	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1704	terminal line. Nothing will be returned if a nonexistent line
728	is requested.	1705	is requested.
729		1706
730	If C<$new_text> is specified, it will replace characters in the current	1707	If C<$new_text> is specified, it will replace characters in the current
731	line, starting at column C<$start_col> (default C<0>), which is useful	1708	line, starting at column C<$start_col> (default C<0>), which is useful
732	to replace only parts of a line. The font index in the rendition will	1709	to replace only parts of a line. The font index in the rendition will
733	automatically be updated.	1710	automatically be updated.
734		1711
735	C<$text> is in a special encoding: tabs and wide characters that use more	1712	C<$text> is in a special encoding: tabs and wide characters that use more
736	than one cell when displayed are padded with urxvt::NOCHAR characters	1713	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
737	(C<chr 65535>). Characters with combining characters and other characters	1714	characters. Characters with combining characters and other characters that
738	that do not fit into the normal tetx encoding will be replaced with	1715	do not fit into the normal text encoding will be replaced with characters
739	characters in the private use area.	1716	in the private use area.
740		1717
741	You have to obey this encoding when changing text. The advantage is	1718	You have to obey this encoding when changing text. The advantage is
742	that C<substr> and similar functions work on screen cells and not on	1719	that C<substr> and similar functions work on screen cells and not on
743	characters.	1720	characters.
744		1721
…		…
795	Return the row number of the first/last row of the line, respectively.	1772	Return the row number of the first/last row of the line, respectively.
796		1773
797	=item $offset = $line->offset_of ($row, $col)	1774	=item $offset = $line->offset_of ($row, $col)
798		1775
799	Returns the character offset of the given row|col pair within the logical	1776	Returns the character offset of the given row|col pair within the logical
800	line.	1777	line. Works for rows outside the line, too, and returns corresponding
		1778	offsets outside the string.
801		1779
802	=item ($row, $col) = $line->coord_of ($offset)	1780	=item ($row, $col) = $line->coord_of ($offset)
803		1781
804	Translates a string offset into terminal coordinates again.	1782	Translates a string offset into terminal coordinates again.
805		1783
806	=back	1784	=back
807		1785
808	=cut	1786	=cut
809		1787
810	sub urxvt::term::line {	1788	sub line {
811	my ($self, $row) = @_;	1789	my ($self, $row) = @_;
812		1790
813	my $maxrow = $self->nrow - 1;	1791	my $maxrow = $self->nrow - 1;
814		1792
815	my ($beg, $end) = ($row, $row);	1793	my ($beg, $end) = ($row, $row);
…		…
827	}	1805	}
828		1806
829	sub urxvt::line::t {	1807	sub urxvt::line::t {
830	my ($self) = @_;	1808	my ($self) = @_;
831		1809
832	if (@_ > 1)	1810	if (@_ > 1) {
833	{
834	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1811	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
835	for $self->{beg} .. $self->{end};	1812	for $self->{beg} .. $self->{end};
836	}	1813	}
837		1814
838	defined wantarray &&	1815	defined wantarray &&
839	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1816	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
840	0, $self->{len}	1817	0, $self->{len}
841	}	1818	}
842		1819
843	sub urxvt::line::r {	1820	sub urxvt::line::r {
844	my ($self) = @_;	1821	my ($self) = @_;
845		1822
846	if (@_ > 1)	1823	if (@_ > 1) {
847	{
848	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1824	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
849	for $self->{beg} .. $self->{end};	1825	for $self->{beg} .. $self->{end};
850	}	1826	}
851		1827
852	if (defined wantarray) {	1828	if (defined wantarray) {
853	my $rend = [	1829	my $rend = [
854	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1830	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
855	];	1831	];
…		…
879	$offset / $self->{ncol} + $self->{beg},	1855	$offset / $self->{ncol} + $self->{beg},
880	$offset % $self->{ncol}	1856	$offset % $self->{ncol}
881	)	1857	)
882	}	1858	}
883		1859
884	=item ($row, $col) = $line->coord_of ($offset)
885	=item $text = $term->special_encode $string	1860	=item $text = $term->special_encode $string
886		1861
887	Converts a perl string into the special encoding used by rxvt-unicode,	1862	Converts a perl string into the special encoding used by rxvt-unicode,
888	where one character corresponds to one screen cell. See	1863	where one character corresponds to one screen cell. See
889	C<< $term->ROW_t >> for details.	1864	C<< $term->ROW_t >> for details.
890		1865
891	=item $string = $term->special_decode $text	1866	=item $string = $term->special_decode $text
892		1867
893	Converts rxvt-unicodes text reprsentation into a perl string. See	1868	Converts rxvt-unicodes text representation into a perl string. See
894	C<< $term->ROW_t >> for details.	1869	C<< $term->ROW_t >> for details.
895		1870
		1871	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
		1872
		1873	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1874
		1875	Register/unregister a synchronous button grab. See the XGrabButton
		1876	manpage.
		1877
		1878	=item $success = $term->grab ($eventtime[, $sync])
		1879
		1880	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1881	synchronous (C<$sync> is true). Also remembers the grab timestamp.
		1882
		1883	=item $term->allow_events_async
		1884
		1885	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1886
		1887	=item $term->allow_events_sync
		1888
		1889	Calls XAllowEvents with SyncBoth for the most recent grab.
		1890
		1891	=item $term->allow_events_replay
		1892
		1893	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1894	recent grab.
		1895
		1896	=item $term->ungrab
		1897
		1898	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
		1899	evaluation errors, as it is better to lose the grab in the error case as
		1900	the session.
		1901
		1902	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1903
		1904	=item $atom_name = $term->XGetAtomName ($atom)
		1905
		1906	=item @atoms = $term->XListProperties ($window)
		1907
		1908	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1909
		1910	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1911
		1912	=item $term->XDeleteProperty ($window, $property)
		1913
		1914	=item $window = $term->DefaultRootWindow
		1915
		1916	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1917
		1918	=item $term->XMapWindow ($window)
		1919
		1920	=item $term->XUnmapWindow ($window)
		1921
		1922	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1923
		1924	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1925
		1926	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1927
		1928	=item $keysym = $term->XStringToKeysym ($string)
		1929
		1930	=item $string = $term->XKeysymToString ($keysym)
		1931
		1932	Various X or X-related functions. The C<$term> object only serves as
		1933	the source of the display, otherwise those functions map more-or-less
		1934	directly onto the X functions of the same name.
		1935
896	=back	1936	=back
		1937
		1938	=cut
		1939
		1940	package urxvt::popup;
		1941
		1942	=head2 The C<urxvt::popup> Class
		1943
		1944	=over 4
		1945
		1946	=cut
		1947
		1948	sub add_item {
		1949	my ($self, $item) = @_;
		1950
		1951	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1952	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1953	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1954
		1955	$item->{render} ||= sub { $_[0]{text} };
		1956
		1957	push @{ $self->{item} }, $item;
		1958	}
		1959
		1960	=item $popup->add_title ($title)
		1961
		1962	Adds a non-clickable title to the popup.
		1963
		1964	=cut
		1965
		1966	sub add_title {
		1967	my ($self, $title) = @_;
		1968
		1969	$self->add_item ({
		1970	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1971	text => $title,
		1972	activate => sub { },
		1973	});
		1974	}
		1975
		1976	=item $popup->add_separator ([$sepchr])
		1977
		1978	Creates a separator, optionally using the character given as C<$sepchr>.
		1979
		1980	=cut
		1981
		1982	sub add_separator {
		1983	my ($self, $sep) = @_;
		1984
		1985	$sep ||= "=";
		1986
		1987	$self->add_item ({
		1988	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1989	text => "",
		1990	render => sub { $sep x $self->{term}->ncol },
		1991	activate => sub { },
		1992	});
		1993	}
		1994
		1995	=item $popup->add_button ($text, $cb)
		1996
		1997	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1998	selected.
		1999
		2000	=cut
		2001
		2002	sub add_button {
		2003	my ($self, $text, $cb) = @_;
		2004
		2005	$self->add_item ({ type => "button", text => $text, activate => $cb});
		2006	}
		2007
		2008	=item $popup->add_toggle ($text, $initial_value, $cb)
		2009
		2010	Adds a toggle/checkbox item to the popup. The callback gets called
		2011	whenever it gets toggled, with a boolean indicating its new value as its
		2012	first argument.
		2013
		2014	=cut
		2015
		2016	sub add_toggle {
		2017	my ($self, $text, $value, $cb) = @_;
		2018
		2019	my $item; $item = {
		2020	type => "button",
		2021	text => " $text",
		2022	value => $value,
		2023	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		2024	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		2025	};
		2026
		2027	$self->add_item ($item);
		2028	}
		2029
		2030	=item $popup->show
		2031
		2032	Displays the popup (which is initially hidden).
		2033
		2034	=cut
		2035
		2036	sub show {
		2037	my ($self) = @_;
		2038
		2039	local $urxvt::popup::self = $self;
		2040
		2041	my $env = $self->{term}->env;
		2042	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		2043	delete $env->{LC_ALL};
		2044	$env->{LC_CTYPE} = $self->{term}->locale;
		2045
		2046	my $term = urxvt::term->new (
		2047	$env, "popup",
		2048	"--perl-lib" => "", "--perl-ext-common" => "",
		2049	"-pty-fd" => -1, "-sl" => 0,
		2050	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		2051	"--transient-for" => $self->{term}->parent,
		2052	"-display" => $self->{term}->display_id,
		2053	"-pe" => "urxvt-popup",
		2054	) or die "unable to create popup window\n";
		2055
		2056	unless (delete $term->{urxvt_popup_init_done}) {
		2057	$term->ungrab;
		2058	$term->destroy;
		2059	die "unable to initialise popup window\n";
		2060	}
		2061	}
		2062
		2063	sub DESTROY {
		2064	my ($self) = @_;
		2065
		2066	delete $self->{term}{_destroy}{$self};
		2067	$self->{term}->ungrab;
		2068	}
		2069
		2070	=back
		2071
		2072	=cut
		2073
		2074	package urxvt::watcher;
897		2075
898	=head2 The C<urxvt::timer> Class	2076	=head2 The C<urxvt::timer> Class
899		2077
900	This class implements timer watchers/events. Time is represented as a	2078	This class implements timer watchers/events. Time is represented as a
901	fractional number of seconds since the epoch. Example:	2079	fractional number of seconds since the epoch. Example:
…		…
905	->new	2083	->new
906	->interval (1)	2084	->interval (1)
907	->cb (sub {	2085	->cb (sub {
908	$term->{overlay}->set (0, 0,	2086	$term->{overlay}->set (0, 0,
909	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2087	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
910	});	2088	});
911		2089
912	=over 4	2090	=over 4
913		2091
914	=item $timer = new urxvt::timer	2092	=item $timer = new urxvt::timer
915		2093
…		…
918		2096
919	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2097	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
920		2098
921	Set the callback to be called when the timer triggers.	2099	Set the callback to be called when the timer triggers.
922		2100
923	=item $tstamp = $timer->at
924
925	Return the time this watcher will fire next.
926
927	=item $timer = $timer->set ($tstamp)	2101	=item $timer = $timer->set ($tstamp[, $interval])
928		2102
929	Set the time the event is generated to $tstamp.	2103	Set the time the event is generated to $tstamp (and optionally specifies a
		2104	new $interval).
930		2105
931	=item $timer = $timer->interval ($interval)	2106	=item $timer = $timer->interval ($interval)
932		2107
933	Normally (and when C<$interval> is C<0>), the timer will automatically	2108	By default (and when C<$interval> is C<0>), the timer will automatically
934	stop after it has fired once. If C<$interval> is non-zero, then the timer	2109	stop after it has fired once. If C<$interval> is non-zero, then the timer
935	is automatically rescheduled at the given intervals.	2110	is automatically rescheduled at the given intervals.
936		2111
937	=item $timer = $timer->start	2112	=item $timer = $timer->start
938		2113
939	Start the timer.	2114	Start the timer.
940		2115
941	=item $timer = $timer->start ($tstamp)	2116	=item $timer = $timer->start ($tstamp[, $interval])
942		2117
943	Set the event trigger time to C<$tstamp> and start the timer.	2118	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2119	also replaces the interval.
		2120
		2121	=item $timer = $timer->after ($delay[, $interval])
		2122
		2123	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
944		2124
945	=item $timer = $timer->stop	2125	=item $timer = $timer->stop
946		2126
947	Stop the timer.	2127	Stop the timer.
948		2128
…		…
954		2134
955	$term->{socket} = ...	2135	$term->{socket} = ...
956	$term->{iow} = urxvt::iow	2136	$term->{iow} = urxvt::iow
957	->new	2137	->new
958	->fd (fileno $term->{socket})	2138	->fd (fileno $term->{socket})
959	->events (1) # wait for read data	2139	->events (urxvt::EV_READ)
960	->start	2140	->start
961	->cb (sub {	2141	->cb (sub {
962	my ($iow, $revents) = @_;	2142	my ($iow, $revents) = @_;
963	# $revents must be 1 here, no need to check	2143	# $revents must be 1 here, no need to check
964	sysread $term->{socket}, my $buf, 8192	2144	sysread $term->{socket}, my $buf, 8192
…		…
977	Set the callback to be called when io events are triggered. C<$reventmask>	2157	Set the callback to be called when io events are triggered. C<$reventmask>
978	is a bitset as described in the C<events> method.	2158	is a bitset as described in the C<events> method.
979		2159
980	=item $iow = $iow->fd ($fd)	2160	=item $iow = $iow->fd ($fd)
981		2161
982	Set the filedescriptor (not handle) to watch.	2162	Set the file descriptor (not handle) to watch.
983		2163
984	=item $iow = $iow->events ($eventmask)	2164	=item $iow = $iow->events ($eventmask)
985		2165
986	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2166	Set the event mask to watch. The only allowed values are
987	data, Bit #1 (value C<2>) enables watching for write data.	2167	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
		2168	together, or C<urxvt::EV_NONE>.
988		2169
989	=item $iow = $iow->start	2170	=item $iow = $iow->start
990		2171
991	Start watching for requested events on the given handle.	2172	Start watching for requested events on the given handle.
992		2173
993	=item $iow = $iow->stop	2174	=item $iow = $iow->stop
994		2175
995	Stop watching for events on the given filehandle.	2176	Stop watching for events on the given file handle.
		2177
		2178	=back
		2179
		2180	=head2 The C<urxvt::iw> Class
		2181
		2182	This class implements idle watchers, that get called automatically when
		2183	the process is idle. They should return as fast as possible, after doing
		2184	some useful work.
		2185
		2186	=over 4
		2187
		2188	=item $iw = new urxvt::iw
		2189
		2190	Create a new idle watcher object in stopped state.
		2191
		2192	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2193
		2194	Set the callback to be called when the watcher triggers.
		2195
		2196	=item $timer = $timer->start
		2197
		2198	Start the watcher.
		2199
		2200	=item $timer = $timer->stop
		2201
		2202	Stop the watcher.
		2203
		2204	=back
		2205
		2206	=head2 The C<urxvt::pw> Class
		2207
		2208	This class implements process watchers. They create an event whenever a
		2209	process exits, after which they stop automatically.
		2210
		2211	my $pid = fork;
		2212	...
		2213	$term->{pw} = urxvt::pw
		2214	->new
		2215	->start ($pid)
		2216	->cb (sub {
		2217	my ($pw, $exit_status) = @_;
		2218	...
		2219	});
		2220
		2221	=over 4
		2222
		2223	=item $pw = new urxvt::pw
		2224
		2225	Create a new process watcher in stopped state.
		2226
		2227	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2228
		2229	Set the callback to be called when the timer triggers.
		2230
		2231	=item $pw = $timer->start ($pid)
		2232
		2233	Tells the watcher to start watching for process C<$pid>.
		2234
		2235	=item $pw = $pw->stop
		2236
		2237	Stop the watcher.
996		2238
997	=back	2239	=back
998		2240
999	=head1 ENVIRONMENT	2241	=head1 ENVIRONMENT
1000		2242
…		…
1003	This variable controls the verbosity level of the perl extension. Higher	2245	This variable controls the verbosity level of the perl extension. Higher
1004	numbers indicate more verbose output.	2246	numbers indicate more verbose output.
1005		2247
1006	=over 4	2248	=over 4
1007		2249
1008	=item =0 - only fatal messages	2250	=item == 0 - fatal messages
1009		2251
1010	=item =3 - script loading and management	2252	=item >= 3 - script loading and management
1011		2253
1012	=item =10 - all events received	2254	=item >=10 - all called hooks
		2255
		2256	=item >=11 - hook return values
1013		2257
1014	=back	2258	=back
1015		2259
1016	=head1 AUTHOR	2260	=head1 AUTHOR
1017		2261
1018	Marc Lehmann <pcg@goof.com>	2262	Marc Lehmann <schmorp@schmorp.de>
1019	http://software.schmorp.de/pkg/rxvt-unicode	2263	http://software.schmorp.de/pkg/rxvt-unicode
1020		2264
1021	=cut	2265	=cut
1022		2266
1023	1	2267	1
		2268
		2269	# vim: sw=3:

Diff Legend

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