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

Diff Legend

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