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.32 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.247 by root, Fri Dec 26 19:19:30 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 example-refresh-hooks
66
67	Displays a very simple digital clock in the upper right corner of the
68	window. Illustrates overwriting the refresh callbacks to create your own
69	overlays or changes.
70
71	=back
72		59
73	=head2 General API Considerations	60	=head2 General API Considerations
74		61
75	All objects (such as terminals, time watchers etc.) are typical	62	All objects (such as terminals, time watchers etc.) are typical
76	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
…		…
81	When objects are destroyed on the C++ side, the perl object hashes are	68	When objects are destroyed on the C++ side, the perl object hashes are
82	emptied, so its best to store related objects such as time watchers and	69	emptied, so its best to store related objects such as time watchers and
83	the like inside the terminal object so they get destroyed as soon as the	70	the like inside the terminal object so they get destroyed as soon as the
84	terminal is destroyed.	71	terminal is destroyed.
85		72
		73	Argument names also often indicate the type of a parameter. Here are some
		74	hints on what they mean:
		75
		76	=over 4
		77
		78	=item $text
		79
		80	Rxvt-unicode's special way of encoding text, where one "unicode" character
		81	always represents one screen cell. See L<ROW_t> for a discussion of this format.
		82
		83	=item $string
		84
		85	A perl text string, with an emphasis on I<text>. It can store all unicode
		86	characters and is to be distinguished with text encoded in a specific
		87	encoding (often locale-specific) and binary data.
		88
		89	=item $octets
		90
		91	Either binary data or - more common - a text string encoded in a
		92	locale-specific way.
		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
		100	=back
		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
86	=head2 Hooks	135	=head2 Hooks
87		136
88	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
89	called whenever the relevant event happens.	138	called whenever the relevant event happens.
90		139
91	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
92	and extension package. You can call all C<urxvt::term> methods on it, but	141	the in the C<Extension Objects> section.
93	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
94	object that is shared between all packages is stored in the C<term>
95	member.
96		142
97	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
98	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
99	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.
100		146
101	When in doubt, return a false value (preferably C<()>).	147	I<< When in doubt, return a false value (preferably C<()>). >>
102		148
103	=over 4	149	=over 4
104		150
105	=item on_init $term	151	=item on_init $term
106		152
107	Called after a new terminal object has been initialized, but before	153	Called after a new terminal object has been initialized, but before
108	windows are created or the command gets run.	154	windows are created or the command gets run. Most methods are unsafe to
		155	call or deliver senseless data, as terminal size and other characteristics
		156	have not yet been determined. You can safely query and change resources
		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).
109		169
110	=item on_reset $term	170	=item on_reset $term
111		171
112	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
113	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
114	variables.	174	variables.
115		175
116	=item on_start $term	176	=item on_child_start $term, $pid
117		177
118	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.
119	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>.
120		184
121	=item on_sel_make $term, $eventtime	185	=item on_sel_make $term, $eventtime
122		186
123	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
124	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
…		…
131		195
132	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
133	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
134	by calling C<< $term->selection >>.	198	by calling C<< $term->selection >>.
135		199
136	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.
137		201
138	=item on_sel_extend $term	202	=item on_sel_extend $term
139		203
140	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
141	click) and is either supposed to return false (normal operation), or	205	click) and is either supposed to return false (normal operation), or
142	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
143	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.
144		210
145	See the F<selection> example extension.	211	See the F<selection> example extension.
146		212
147	=item on_focus_in $term
148
149	Called whenever the window gets the keyboard focus, before urxvt does
150	focus in processing.
151
152	=item on_focus_out $term
153
154	Called wheneever the window loses keyboard focus, before urxvt does focus
155	out processing.
156
157	=item on_view_change $term, $offset	213	=item on_view_change $term, $offset
158		214
159	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
160	scrolls. Offset C<0> means display the normal terminal, positive values	216	scrolls. Offset C<0> means display the normal terminal, positive values
161	show this many lines of scrollback.	217	show this many lines of scrollback.
162		218
163	=item on_scroll_back $term, $lines, $saved	219	=item on_scroll_back $term, $lines, $saved
164		220
…		…
168		224
169	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,
170	$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
171	number of lines that will be in the scrollback buffer.	227	number of lines that will be in the scrollback buffer.
172		228
173	=item on_tty_activity $term *NYI*
174
175	Called whenever the program(s) running in the urxvt window send output.
176
177	=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
178		240
179	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	241	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
180	operating system command) is processed. Cursor position and other state	242	operating system command) is processed. Cursor position and other state
181	information is up-to-date when this happens. For interoperability, the	243	information is up-to-date when this happens. For interoperability, the
182	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,
183	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
184	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	}
185		257
186	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,
187	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
188	other users on the same system etc.).	260	other users on the same system etc.).
189		261
		262	For responses, C<$resp> contains the end-of-args separator used by the
		263	sender.
		264
		265	=item on_add_lines $term, $string
		266
		267	Called whenever text is about to be output, with the text as argument. You
		268	can filter/change and output the text yourself by returning a true value
		269	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		270	might be very slow, however, as your hook is called for B<all> text being
		271	output.
		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
		285	=item on_line_update $term, $row
		286
		287	Called whenever a line was updated or changed. Can be used to filter
		288	screen output (e.g. underline urls or other useless stuff). Only lines
		289	that are being shown will be filtered, and, due to performance reasons,
		290	not always immediately.
		291
		292	The row number is always the topmost row of the line if the line spans
		293	multiple rows.
		294
		295	Please note that, if you change the line, then the hook might get called
		296	later with the already-modified line (e.g. if unrelated parts change), so
		297	you cannot just toggle rendition bits, but only set them.
		298
190	=item on_refresh_begin $term	299	=item on_refresh_begin $term
191		300
192	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
193	or similar effects by modify terminal contents in refresh_begin, and	302	similar effects by modifying the terminal contents in refresh_begin, and
194	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
195	code is run after this hook, and takes precedence.	304	code is run after this hook, and takes precedence.
196		305
197	=item on_refresh_end $term	306	=item on_refresh_end $term
198		307
199	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>.
200		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
201	=item on_keyboard_command $term, $string	318	=item on_user_command $term, $string *DEPRECATED*
202		319
203	Called whenever the user presses a key combination that has a	320	Called whenever a user-configured event is being activated (e.g. via
204	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>
205	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.
206		393
207	=back	394	=back
208		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
209	=head2 Variables in the C<urxvt> Package	421	=head2 Variables in the C<urxvt> Package
210		422
211	=over 4	423	=over 4
212		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
213	=item $urxvt::TERM	438	=item $urxvt::TERM
214		439
215	The current terminal. Whenever a callback/Hook is bein executed, this	440	The current terminal. This variable stores the current C<urxvt::term>
216	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>.
217		458
218	=back	459	=back
219		460
220	=head2 Functions in the C<urxvt> Package	461	=head2 Functions in the C<urxvt> Package
221		462
222	=over 4	463	=over 4
223		464
224	=item urxvt::fatal $errormessage	465	=item urxvt::fatal $errormessage
225		466
226	Fatally aborts execution with the given error message. Avoid at all	467	Fatally aborts execution with the given error message (which should
227	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
228	starts up.	469	is acceptable (and useful) is in the init hook, where it prevents the
		470	terminal from starting up.
229		471
230	=item urxvt::warn $string	472	=item urxvt::warn $string
231		473
232	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
233	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
234	that calls this function.	476	that calls this function.
235		477
236	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
237	correct place, e.g. on stderr of the connecting urxvtc client.	479	correct place, e.g. on stderr of the connecting urxvtc client.
238		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
239	=item $time = urxvt::NOW	490	=item $time = urxvt::NOW
240		491
241	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.
242		517
243	=back	518	=back
244		519
245	=head2 RENDITION	520	=head2 RENDITION
246		521
…		…
261		536
262	=item $rend = urxvt::OVERLAY_RSTYLE	537	=item $rend = urxvt::OVERLAY_RSTYLE
263		538
264	Return the rendition mask used for overlays by default.	539	Return the rendition mask used for overlays by default.
265		540
266	=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
267		543
268	Return the bit that enabled bold, italic, blink, reverse-video and	544	Return the bit that enabled bold, italic, blink, reverse-video and
269	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
270	the bitset.	546	the bitset.
271		547
…		…
273		549
274	=item $background = urxvt::GET_BASEBG $rend	550	=item $background = urxvt::GET_BASEBG $rend
275		551
276	Return the foreground/background colour index, respectively.	552	Return the foreground/background colour index, respectively.
277		553
278	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	554	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
279		555
280	=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
281		559
282	Replace the foreground/background colour in the rendition mask with the	560	Replace the foreground/background colour in the rendition mask with the
283	specified one.	561	specified one.
284		562
285	=item $value = urxvt::GET_CUSTOM ($rend)	563	=item $value = urxvt::GET_CUSTOM $rend
286		564
287	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
288	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
289	zero.	567	zero.
290		568
291	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	569	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
292		570
293	Change the custom value.	571	Change the custom value.
294		572
295	=back	573	=back
296		574
297	=cut	575	=cut
298		576
299	package urxvt;
300
301	use strict;
302	use Scalar::Util ();
303
304	our $TERM;
305	our @HOOKNAME;
306	our $LIBDIR;
307
308	BEGIN {	577	BEGIN {
309	urxvt->bootstrap;
310
311	# overwrite perl's warn	578	# overwrite perl's warn
312	*CORE::GLOBAL::warn = sub {	579	*CORE::GLOBAL::warn = sub {
313	my $msg = join "", @_;	580	my $msg = join "", @_;
314	$msg .= "\n"	581	$msg .= "\n"
315	unless $msg =~ /\n$/;	582	unless $msg =~ /\n$/;
316	urxvt::warn ($msg);	583	urxvt::warn ($msg);
317	};	584	};
318	}	585	}
319		586
320	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
321	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	651	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
322		652
323	sub verbose {	653	sub verbose {
324	my ($level, $msg) = @_;	654	my ($level, $msg) = @_;
325	warn "$msg\n" if $level <= $verbosity;	655	warn "$msg\n" if $level <= $verbosity;
326	}	656	}
327		657
328	# find on_xxx subs in the package and register them	658	my %extension_pkg;
329	# as hooks
330	sub register_package($) {
331	my ($pkg) = @_;
332
333	for my $htype (0.. $#HOOKNAME) {
334	my $name = $HOOKNAME[$htype];
335
336	my $ref = $pkg->can ("on_" . lc $name)
337	or next;
338
339	$TERM->{_hook}[$htype]{$pkg} = $ref;
340	$hook_count[$htype]++
341	or set_should_invoke $htype, 1;
342	}
343	}
344
345	my $script_pkg = "script0000";
346	my %script_pkg;
347		659
348	# load a single script into its own package, once only	660	# load a single script into its own package, once only
349	sub script_package($) {	661	sub extension_package($) {
350	my ($path) = @_;	662	my ($path) = @_;
351		663
352	$script_pkg{$path} ||= do {	664	$extension_pkg{$path} ||= do {
353	my $pkg = "urxvt::" . ($script_pkg++);	665	$path =~ /([^\/\\]+)$/;
		666	my $pkg = $1;
		667	$pkg =~ s/[^[:word:]]/_/g;
		668	$pkg = "urxvt::ext::$pkg";
354		669
355	verbose 3, "loading script '$path' into package '$pkg'";	670	verbose 3, "loading extension '$path' into package '$pkg'";
		671
		672	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
356		673
357	open my $fh, "<:raw", $path	674	open my $fh, "<:raw", $path
358	or die "$path: $!";	675	or die "$path: $!";
359		676
360	my $source = "package $pkg; use strict; use utf8;\n"	677	my $source =
		678	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
361	. "#line 1 \"$path\"\n{\n"	679	. "#line 1 \"$path\"\n{\n"
362	. (do { local $/; <$fh> })	680	. (do { local $/; <$fh> })
363	. "\n};\n1";	681	. "\n};\n1";
364		682
		683	eval $source
365	eval $source or die "$path: $@";	684	or die "$path: $@";
366		685
367	$pkg	686	$pkg
368	}	687	}
369	}	688	}
370		689
…		…
373	# called by the rxvt core	692	# called by the rxvt core
374	sub invoke {	693	sub invoke {
375	local $TERM = shift;	694	local $TERM = shift;
376	my $htype = shift;	695	my $htype = shift;
377		696
378	if ($htype == 0) { # INIT	697	if ($htype == HOOK_INIT) {
379	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	698	my @dirs = $TERM->perl_libdirs;
380		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 (
381	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
		721	qw(selection option-popup selection-popup readline searchable-scrollback),
		722	map $_->[0], values %{ $TERM->{meta}{binding} };
		723
		724	for ($TERM->_keysym_resources) {
		725	next if /^(?:string|command|builtin|builtin-string|perl)/;
		726	next unless /^([A-Za-z0-9_\-]+):/;
		727
		728	my $ext = $1;
		729
		730	$ext_arg{$ext} = [];
		731	}
		732
		733	} elsif (/^-(.*)$/) {
		734	delete $ext_arg{$1};
		735
		736	} elsif (/^([^<]+)<(.*)>$/) {
		737	push @{ $ext_arg{$1} }, $2;
		738
		739	} else {
		740	$ext_arg{$_} ||= [];
		741	}
		742	}
		743
		744	# now register default key bindings
		745	for my $ext (sort keys %ext_arg) {
		746	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		747	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
		748	}
		749	}
		750
		751	for my $ext (sort keys %ext_arg) {
382	my @files = grep -f $_, map "$_/$ext", @dirs;	752	my @files = grep -f $_, map "$_/$ext", @dirs;
383		753
384	if (@files) {	754	if (@files) {
385	register_package script_package $files[0];	755	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
386	} else {	756	} else {
387	warn "perl extension '$ext' not found in perl library search path\n";	757	warn "perl extension '$ext' not found in perl library search path\n";
388	}	758	}
389	}	759	}
		760
		761	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		762	warn $@ if $@;
390	}	763	}
391		764
392	$retval = undef;	765	$retval = undef;
393		766
394	if (my $cb = $TERM->{_hook}[$htype]) {	767	if (my $cb = $TERM->{_hook}[$htype]) {
395	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	768	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
396	if $verbosity >= 10;	769	if $verbosity >= 10;
397		770
398	keys %$cb;	771	if ($htype == HOOK_ACTION) {
		772	# this hook is only sent to the extension with the name
		773	# matching the first arg
		774	my $pkg = shift;
		775	$pkg =~ y/-/_/;
		776	$pkg = "urxvt::ext::$pkg";
399		777
400	while (my ($pkg, $cb) = each %$cb) {	778	$cb = $cb->{$pkg}
401	$retval = $cb->(	779	or return undef; #TODO: maybe warn user?
402	$TERM->{_pkg}{$pkg} ||= do {	780
403	my $proxy = bless { }, urxvt::term::proxy::;	781	$cb = { $pkg => $cb };
404	Scalar::Util::weaken ($proxy->{term} = $TERM);
405	$proxy
406	},
407	@_,
408	) and last;
409	}	782	}
410	}
411		783
412	if ($htype == 1) { # DESTROY	784	for my $pkg (keys %$cb) {
413	# remove hooks if unused	785	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
414	if (my $hook = $TERM->{_hook}) {	786	$retval ||= $retval_;
415	for my $htype (0..$#$hook) {	787
416	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }	788	if ($@) {
417	or set_should_invoke $htype, 0;	789	$TERM->ungrab; # better to lose the grab than the session
		790	warn $@;
418	}	791	}
419	}	792	}
420		793
		794	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		795	if $verbosity >= 11;
		796	}
		797
		798	if ($htype == HOOK_DESTROY) {
421	# clear package objects	799	# clear package objects
422	%$_ = () for values %{ $TERM->{_pkg} };	800	%$_ = () for values %{ $TERM->{_pkg} };
423		801
424	# clear package	802	# clear package
425	%$TERM = ();	803	%$TERM = ();
426	}	804	}
427		805
428	$retval	806	$retval
429	}	807	}
430		808
431	sub urxvt::term::proxy::AUTOLOAD {	809	sub SET_COLOR($$$) {
432	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	810	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		811	}
		812
		813	sub rend2mask {
		814	no strict 'refs';
		815	my ($str, $mask) = (@_, 0);
		816	my %color = ( fg => undef, bg => undef );
		817	my @failed;
		818	for my $spec ( split /\s+/, $str ) {
		819	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		820	$color{lc($1)} = $2;
		821	} else {
		822	my $neg = $spec =~ s/^[-^]//;
		823	unless ( exists &{"RS_$spec"} ) {
		824	push @failed, $spec;
		825	next;
		826	}
		827	my $cur = &{"RS_$spec"};
		828	if ( $neg ) {
		829	$mask &= ~$cur;
		830	} else {
		831	$mask |= $cur;
		832	}
		833	}
		834	}
		835	($mask, @color{qw(fg bg)}, \@failed)
		836	}
		837
		838	package urxvt::term::extension;
		839
		840	=head2 The C<urxvt::term::extension> class
		841
		842	Each extension attached to a terminal object is represented by
		843	a C<urxvt::term::extension> object.
		844
		845	You can use these objects, which are passed to all callbacks to store any
		846	state related to the terminal and extension instance.
		847
		848	The methods (And data members) documented below can be called on extension
		849	objects, in addition to call methods documented for the <urxvt::term>
		850	class.
		851
		852	=over 4
		853
		854	=item $urxvt_term = $self->{term}
		855
		856	Returns the C<urxvt::term> object associated with this instance of the
		857	extension. This member I<must not> be changed in any way.
		858
		859	=cut
		860
		861	our $AUTOLOAD;
		862
		863	sub AUTOLOAD {
		864	$AUTOLOAD =~ /:([^:]+)$/
433	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	865	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
434		866
435	eval qq{	867	eval qq{
436	sub $urxvt::term::proxy::AUTOLOAD {	868	sub $AUTOLOAD {
437	my \$proxy = shift;	869	my \$proxy = shift;
438	\$proxy->{term}->$1 (\@_)	870	\$proxy->{term}->$1 (\@_)
439	}	871	}
440	1	872	1
441	} or die "FATAL: unable to compile method forwarder: $@";	873	} or die "FATAL: unable to compile method forwarder: $@";
442		874
443	goto &$urxvt::term::proxy::AUTOLOAD;	875	goto &$AUTOLOAD;
444	}	876	}
		877
		878	sub DESTROY {
		879	# nop
		880	}
		881
		882	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
		883
		884	sub urxvt::destroy_hook::DESTROY {
		885	${$_[0]}->();
		886	}
		887
		888	sub urxvt::destroy_hook(&) {
		889	bless \shift, urxvt::destroy_hook::
		890	}
		891
		892	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		893
		894	Dynamically enable the given hooks (named without the C<on_> prefix) for
		895	this extension, replacing any hook previously installed via C<enable> in
		896	this extension.
		897
		898	This is useful when you want to overwrite time-critical hooks only
		899	temporarily.
		900
		901	To install additional callbacks for the same hook, you can use the C<on>
		902	method of the C<urxvt::term> class.
		903
		904	=item $self->disable ($hook_name[, $hook_name..])
		905
		906	Dynamically disable the given hooks.
		907
		908	=cut
		909
		910	sub enable {
		911	my ($self, %hook) = @_;
		912	my $pkg = $self->{_pkg};
		913
		914	while (my ($name, $cb) = each %hook) {
		915	my $htype = $HOOKTYPE{uc $name};
		916	defined $htype
		917	or Carp::croak "unsupported hook type '$name'";
		918
		919	$self->set_should_invoke ($htype, +1)
		920	unless exists $self->{term}{_hook}[$htype]{$pkg};
		921
		922	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		923	}
		924	}
		925
		926	sub disable {
		927	my ($self, @hook) = @_;
		928	my $pkg = $self->{_pkg};
		929
		930	for my $name (@hook) {
		931	my $htype = $HOOKTYPE{uc $name};
		932	defined $htype
		933	or Carp::croak "unsupported hook type '$name'";
		934
		935	$self->set_should_invoke ($htype, -1)
		936	if delete $self->{term}{_hook}[$htype]{$pkg};
		937	}
		938	}
		939
		940	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		941
		942	Similar to the C<enable> enable, but installs additional callbacks for
		943	the given hook(s) (that is, it doesn't replace existing callbacks), and
		944	returns a guard object. When the guard object is destroyed the callbacks
		945	are disabled again.
		946
		947	=cut
		948
		949	sub urxvt::extension::on_disable::DESTROY {
		950	my $disable = shift;
		951
		952	my $term = delete $disable->{""};
		953
		954	while (my ($htype, $id) = each %$disable) {
		955	delete $term->{_hook}[$htype]{$id};
		956	$term->set_should_invoke ($htype, -1);
		957	}
		958	}
		959
		960	sub on {
		961	my ($self, %hook) = @_;
		962
		963	my $term = $self->{term};
		964
		965	my %disable = ( "" => $term );
		966
		967	while (my ($name, $cb) = each %hook) {
		968	my $htype = $HOOKTYPE{uc $name};
		969	defined $htype
		970	or Carp::croak "unsupported hook type '$name'";
		971
		972	$term->set_should_invoke ($htype, +1);
		973	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		974	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		975	}
		976
		977	bless \%disable, "urxvt::extension::on_disable"
		978	}
		979
		980	=item $self->bind_action ($hotkey, $action)
		981
		982	=item $self->x_resource ($pattern)
		983
		984	=item $self->x_resource_boolean ($pattern)
		985
		986	These methods support an additional C<%> prefix for C<$action> or
		987	C<$pattern> when called on an extension object, compared to the
		988	C<urxvt::term> methods of the same name - see the description of these
		989	methods in the C<urxvt::term> class for details.
		990
		991	=cut
		992
		993	sub bind_action {
		994	my ($self, $hotkey, $action) = @_;
		995	$action =~ s/^%:/$_[0]{_name}:/;
		996	$self->{term}->bind_action ($hotkey, $action)
		997	}
		998
		999	sub x_resource {
		1000	my ($self, $name) = @_;
		1001	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1002	$self->{term}->x_resource ($name)
		1003	}
		1004
		1005	sub x_resource_boolean {
		1006	my ($self, $name) = @_;
		1007	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1008	$self->{term}->x_resource_boolean ($name)
		1009	}
		1010
		1011	=back
		1012
		1013	=cut
		1014
		1015	package urxvt::anyevent;
		1016
		1017	=head2 The C<urxvt::anyevent> Class
		1018
		1019	The sole purpose of this class is to deliver an interface to the
		1020	C<AnyEvent> module - any module using it will work inside urxvt without
		1021	further programming. The only exception is that you cannot wait on
		1022	condition variables, but non-blocking condvar use is ok.
		1023
		1024	In practical terms this means is that you cannot use blocking APIs, but
		1025	the non-blocking variant should work.
		1026
		1027	=cut
		1028
		1029	our $VERSION = '5.23';
		1030
		1031	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		1032	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		1033
		1034	sub timer {
		1035	my ($class, %arg) = @_;
		1036
		1037	my $cb = $arg{cb};
		1038
		1039	urxvt::timer
		1040	->new
		1041	->after ($arg{after}, $arg{interval})
		1042	->cb ($arg{interval} ? $cb : sub {
		1043	$_[0]->stop; # need to cancel manually
		1044	$cb->();
		1045	})
		1046	}
		1047
		1048	sub io {
		1049	my ($class, %arg) = @_;
		1050
		1051	my $cb = $arg{cb};
		1052	my $fd = fileno $arg{fh};
		1053	defined $fd or $fd = $arg{fh};
		1054
		1055	bless [$arg{fh}, urxvt::iow
		1056	->new
		1057	->fd ($fd)
		1058	->events (($arg{poll} =~ /r/ ? 1 : 0)
		1059	| ($arg{poll} =~ /w/ ? 2 : 0))
		1060	->start
		1061	->cb ($cb)
		1062	], urxvt::anyevent::
		1063	}
		1064
		1065	sub idle {
		1066	my ($class, %arg) = @_;
		1067
		1068	my $cb = $arg{cb};
		1069
		1070	urxvt::iw
		1071	->new
		1072	->start
		1073	->cb ($cb)
		1074	}
		1075
		1076	sub child {
		1077	my ($class, %arg) = @_;
		1078
		1079	my $cb = $arg{cb};
		1080
		1081	urxvt::pw
		1082	->new
		1083	->start ($arg{pid})
		1084	->cb (sub {
		1085	$_[0]->stop; # need to cancel manually
		1086	$cb->($_[0]->rpid, $_[0]->rstatus);
		1087	})
		1088	}
		1089
		1090	sub DESTROY {
		1091	$_[0][1]->stop;
		1092	}
		1093
		1094	# only needed for AnyEvent < 6 compatibility
		1095	sub one_event {
		1096	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1097	}
		1098
		1099	package urxvt::term;
445		1100
446	=head2 The C<urxvt::term> Class	1101	=head2 The C<urxvt::term> Class
447		1102
448	=over 4	1103	=over 4
		1104
		1105	=cut
		1106
		1107	# find on_xxx subs in the package and register them
		1108	# as hooks
		1109	sub register_package {
		1110	my ($self, $pkg, $argv) = @_;
		1111
		1112	no strict 'refs';
		1113
		1114	urxvt::verbose 6, "register package $pkg to $self";
		1115
		1116	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1117
		1118	my $proxy = bless {
		1119	_pkg => $pkg,
		1120	_name => ${"$pkg\::_NAME"}, # hackish
		1121	argv => $argv,
		1122	}, $pkg;
		1123	Scalar::Util::weaken ($proxy->{term} = $self);
		1124
		1125	$self->{_pkg}{$pkg} = $proxy;
		1126
		1127	for my $name (@HOOKNAME) {
		1128	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1129	$proxy->enable ($name => $ref);
		1130	}
		1131	}
		1132	}
		1133
		1134	sub perl_libdirs {
		1135	map { split /:/ }
		1136	$_[0]->resource ("perl_lib"),
		1137	$ENV{URXVT_PERL_LIB},
		1138	"$ENV{HOME}/.urxvt/ext",
		1139	"$LIBDIR/perl"
		1140	}
		1141
		1142	# scan for available extensions and collect their metadata
		1143	sub scan_extensions {
		1144	my ($self) = @_;
		1145
		1146	return if exists $self->{meta};
		1147
		1148	my @libdirs = perl_libdirs $self;
		1149
		1150	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1151
		1152	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1153	$self->{meta} = \my %meta;
		1154
		1155	# first gather extensions
		1156	for my $dir (reverse @libdirs) {
		1157	opendir my $fh, $dir
		1158	or next;
		1159	for my $ext (readdir $fh) {
		1160	$ext !~ /^\./
		1161	and open my $fh, "<", "$dir/$ext"
		1162	or next;
		1163
		1164	my %ext = (dir => $dir);
		1165
		1166	while (<$fh>) {
		1167	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1168	my ($pattern, $type, $desc) = split /:/, $1;
		1169	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1170	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1171	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1172	} else {
		1173	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1174	}
		1175	} elsif (/^#:META:BINDING:(.*)/) {
		1176	my ($keysym, $action) = split /:/, $1;
		1177	$ext{binding}{$keysym} = [$ext, $action];
		1178	} elsif (/^\s*(?:#|$)/) {
		1179	# skip other comments and empty lines
		1180	} else {
		1181	last; # stop parsing on first non-empty non-comment line
		1182	}
		1183	}
		1184
		1185	$meta{ext}{$ext} = \%ext;
		1186	}
		1187	}
		1188
		1189	# and now merge resources and bindings
		1190	while (my ($k, $v) = each %{ $meta{ext} }) {
		1191	#TODO: should check for extensions overriding each other
		1192	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1193	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		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
		1220	=item $term->destroy
		1221
		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
449		1267
450	=item $value = $term->resource ($name[, $newval])	1268	=item $value = $term->resource ($name[, $newval])
451		1269
452	Returns the current resource value associated with a given name and	1270	Returns the current resource value associated with a given name and
453	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>
…		…
462	likely change).	1280	likely change).
463		1281
464	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
465	terminal is destroyed, so changing options frequently will eat memory.	1283	terminal is destroyed, so changing options frequently will eat memory.
466		1284
467	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
468	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>
469	list:	1287	to see the actual list:
470		1288
471	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1289	answerbackstring backgroundPixmap backspace_key blurradius
472	borderLess color cursorBlink cursorUnderline cutchars delete_key	1290	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
473	display_name embed ext_bwidth fade font geometry hold iconName	1291	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
474	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
475	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1294	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
476	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1295	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
477	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1296	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
478	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1297	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
479	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1298	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
480	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1299	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
481	shade term_name title transparent transparent_all tripleclickwords	1300	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1301	term_name title transient_for transparent tripleclickwords urgentOnBell
482	utmpInhibit visualBell	1302	utmpInhibit visualBell
483		1303
484	=cut	1304	=cut
485		1305
486	sub urxvt::term::resource($$;$) {	1306	sub resource($$;$) {
487	my ($self, $name) = (shift, shift);	1307	my ($self, $name) = (shift, shift);
488	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1308	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
489	goto &urxvt::term::_resource;	1309	goto &urxvt::term::_resource
490	}	1310	}
491		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	}
		1368
492	=item $rend = $term->screen_rstyle ([$new_rstyle])	1369	=item $rend = $term->rstyle ([$new_rstyle])
493		1370
494	Return and optionally change the current rendition. Text thta is output by	1371	Return and optionally change the current rendition. Text that is output by
495	the temrianl application will use this style.	1372	the terminal application will use this style.
496		1373
497	=item ($row, $col) = $term->screen_cur ([$row, $col])	1374	=item ($row, $col) = $term->screen_cur ([$row, $col])
498		1375
499	Return the current coordinates of the text cursor position and optionally	1376	Return the current coordinates of the text cursor position and optionally
500	set it (which is usually bad as applications don't expect that).	1377	set it (which is usually bad as applications don't expect that).
…		…
503		1380
504	=item ($row, $col) = $term->selection_beg ([$row, $col])	1381	=item ($row, $col) = $term->selection_beg ([$row, $col])
505		1382
506	=item ($row, $col) = $term->selection_end ([$row, $col])	1383	=item ($row, $col) = $term->selection_end ([$row, $col])
507		1384
508	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.
509	and optionally set them to new values.
510		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
511	=item $success = $term->selection_grab ($eventtime)	1402	=item $success = $term->selection_grab ($eventtime[, $clipboard])
512		1403
513	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
514	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.
515		1408
516	=item $oldtext = $term->selection ([$newtext])	1409	=item $oldtext = $term->selection ([$newtext, $clipboard])
517		1410
518	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>.
519		1413
		1414	=item $term->selection_clear ([$clipboard])
		1415
		1416	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1417
520	#=item $term->overlay ($x, $y, $text)	1418	=item $term->overlay_simple ($x, $y, $text)
521	#	1419
522	#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.
523	#	1421
524	#=cut	1422	=cut
525		1423
526	sub urxvt::term::scr_overlay {	1424	sub overlay_simple {
527	die;
528	my ($self, $x, $y, $text) = @_;	1425	my ($self, $x, $y, $text) = @_;
529		1426
530	my @lines = split /\n/, $text;	1427	my @lines = split /\n/, $text;
531		1428
532	my $w = 0;	1429	my $w = List::Util::max map $self->strwidth ($_), @lines;
533	for (map $self->strwidth ($_), @lines) {
534	$w = $_ if $w < $_;
535	}
536		1430
537	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	1431	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
538	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1432	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		1433
		1434	$overlay
539	}	1435	}
540		1436
541	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1437	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
542		1438
543	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
…		…
555		1451
556	The methods currently supported on C<urxvt::overlay> objects are:	1452	The methods currently supported on C<urxvt::overlay> objects are:
557		1453
558	=over 4	1454	=over 4
559		1455
560	=item $overlay->set ($x, $y, $text, $rend)	1456	=item $overlay->set ($x, $y, $text[, $rend])
561		1457
562	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
563	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
564	at a specific position inside the overlay.	1460	at a specific position inside the overlay.
565		1461
		1462	If C<$rend> is missing, then the rendition will not be changed.
		1463
566	=item $overlay->hide	1464	=item $overlay->hide
567		1465
568	If visible, hide the overlay, but do not destroy it.	1466	If visible, hide the overlay, but do not destroy it.
569		1467
570	=item $overlay->show	1468	=item $overlay->show
571		1469
572	If hidden, display the overlay again.	1470	If hidden, display the overlay again.
573		1471
574	=back	1472	=back
575		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
576	=item $cellwidth = $term->strwidth $string	1501	=item $cellwidth = $term->strwidth ($string)
577		1502
578	Returns the number of screen-cells this string would need. Correctly	1503	Returns the number of screen-cells this string would need. Correctly
579	accounts for wide and combining characters.	1504	accounts for wide and combining characters.
580		1505
581	=item $octets = $term->locale_encode $string	1506	=item $octets = $term->locale_encode ($string)
582		1507
583	Convert the given text string into the corresponding locale encoding.	1508	Convert the given text string into the corresponding locale encoding.
584		1509
585	=item $string = $term->locale_decode $octets	1510	=item $string = $term->locale_decode ($octets)
586		1511
587	Convert the given locale-encoded octets into a perl string.	1512	Convert the given locale-encoded octets into a perl string.
588		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!
		1530
		1531	=item $term->scr_add_lines ($string)
		1532
		1533	Write the given text string to the screen, as if output by the application
		1534	running inside the terminal. It may not contain command sequences (escape
		1535	codes - see C<cmd_parse> for that), but is free to use line feeds,
		1536	carriage returns and tabs. The string is a normal text string, not in
		1537	locale-dependent encoding.
		1538
		1539	Normally its not a good idea to use this function, as programs might be
		1540	confused by changes in cursor position or scrolling. Its useful inside a
		1541	C<on_add_lines> hook, though.
		1542
		1543	=item $term->scr_change_screen ($screen)
		1544
		1545	Switch to given screen - 0 primary, 1 secondary.
		1546
		1547	=item $term->cmd_parse ($octets)
		1548
		1549	Similar to C<scr_add_lines>, but the argument must be in the
		1550	locale-specific encoding of the terminal and can contain command sequences
		1551	(escape codes) that will be interpreted.
		1552
589	=item $term->tt_write ($octets)	1553	=item $term->tt_write ($octets)
590		1554
591	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
592	pass characters instead of octets, you should convert your strings first	1557	characters instead of octets, you should convert your strings first to the
593	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.
594		1614
595	=item $window_width = $term->width	1615	=item $window_width = $term->width
596		1616
597	=item $window_height = $term->height	1617	=item $window_height = $term->height
598		1618
…		…
612		1632
613	=item $max_scrollback = $term->saveLines	1633	=item $max_scrollback = $term->saveLines
614		1634
615	=item $nrow_plus_saveLines = $term->total_rows	1635	=item $nrow_plus_saveLines = $term->total_rows
616		1636
617	=item $lines_in_scrollback = $term->nsaved	1637	=item $topmost_scrollback_row = $term->top_row
618		1638
619	Return various integers describing terminal characteristics.	1639	Return various integers describing terminal characteristics.
620		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
621	=item $view_start = $term->view_start ([$newvalue])	1686	=item $view_start = $term->view_start ([$newvalue])
622		1687
623	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
624	C<0>, which displays the normal terminal contents. Larger values scroll	1689	C<0>, which displays the normal terminal contents. Lower values scroll
625	this many lines into the scrollback buffer.	1690	this many lines into the scrollback buffer.
626		1691
627	=item $term->want_refresh	1692	=item $term->want_refresh
628		1693
629	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1694	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
632		1697
633	Used after changing terminal contents to display them.	1698	Used after changing terminal contents to display them.
634		1699
635	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1700	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
636		1701
637	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 >>
638	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
639	terminal line. The scrollback buffer starts at line C<-1> and extends to
640	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1704	terminal line. Nothing will be returned if a nonexistent line
641	is requested.	1705	is requested.
642		1706
643	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
644	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
645	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
646	automatically be updated.	1710	automatically be updated.
647		1711
648	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
649	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)
650	(C<chr 65535>). Characters with combining characters and other characters	1714	characters. Characters with combining characters and other characters that
651	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
652	characters in the private use area.	1716	in the private use area.
653		1717
654	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
655	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
656	characters.	1720	characters.
657		1721
…		…
687	about the logical line that row C<$row_number> is part of. It supports the	1751	about the logical line that row C<$row_number> is part of. It supports the
688	following methods:	1752	following methods:
689		1753
690	=over 4	1754	=over 4
691		1755
692	=item $text = $line->t	1756	=item $text = $line->t ([$new_text])
693		1757
694	Returns the full text of the line, similar to C<ROW_t>	1758	Returns or replaces the full text of the line, similar to C<ROW_t>
695		1759
696	=item $rend = $line->r	1760	=item $rend = $line->r ([$new_rend])
697		1761
698	Returns the full rendition array of the line, similar to C<ROW_r>	1762	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
699		1763
700	=item $length = $line->l	1764	=item $length = $line->l
701		1765
702	Returns the length of the line in cells, similar to C<ROW_l>.	1766	Returns the length of the line in cells, similar to C<ROW_l>.
703		1767
…		…
708	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.
709		1773
710	=item $offset = $line->offset_of ($row, $col)	1774	=item $offset = $line->offset_of ($row, $col)
711		1775
712	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
713	line.	1777	line. Works for rows outside the line, too, and returns corresponding
		1778	offsets outside the string.
714		1779
715	=item ($row, $col) = $line->coord_of ($offset)	1780	=item ($row, $col) = $line->coord_of ($offset)
716		1781
717	Translates a string offset into terminal coordinates again.	1782	Translates a string offset into terminal coordinates again.
718		1783
719	=back	1784	=back
720		1785
721	=cut	1786	=cut
722		1787
723	sub urxvt::term::line {	1788	sub line {
724	my ($self, $row) = @_;	1789	my ($self, $row) = @_;
725		1790
726	my $maxrow = $self->nrow - 1;	1791	my $maxrow = $self->nrow - 1;
727		1792
728	my ($beg, $end) = ($row, $row);	1793	my ($beg, $end) = ($row, $row);
…		…
732		1797
733	bless {	1798	bless {
734	term => $self,	1799	term => $self,
735	beg => $beg,	1800	beg => $beg,
736	end => $end,	1801	end => $end,
		1802	ncol => $self->ncol,
737	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1803	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
738	}, urxvt::line::	1804	}, urxvt::line::
739	}	1805	}
740		1806
741	sub urxvt::line::t {	1807	sub urxvt::line::t {
742	my ($self) = @_;	1808	my ($self) = @_;
743		1809
		1810	if (@_ > 1) {
		1811	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1812	for $self->{beg} .. $self->{end};
		1813	}
		1814
		1815	defined wantarray &&
744	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1816	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
745	0, $self->{len}	1817	0, $self->{len}
746	}	1818	}
747		1819
748	sub urxvt::line::r {	1820	sub urxvt::line::r {
749	my ($self) = @_;	1821	my ($self) = @_;
750		1822
		1823	if (@_ > 1) {
		1824	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1825	for $self->{beg} .. $self->{end};
		1826	}
		1827
		1828	if (defined wantarray) {
751	my $rend = [	1829	my $rend = [
752	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1830	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
753	];	1831	];
754	$#$rend = $self->{len} - 1;	1832	$#$rend = $self->{len} - 1;
755	$rend	1833	return $rend;
		1834	}
		1835
		1836	()
756	}	1837	}
757		1838
758	sub urxvt::line::beg { $_[0]{beg} }	1839	sub urxvt::line::beg { $_[0]{beg} }
759	sub urxvt::line::end { $_[0]{end} }	1840	sub urxvt::line::end { $_[0]{end} }
760	sub urxvt::line::l { $_[0]{len} }	1841	sub urxvt::line::l { $_[0]{len} }
761		1842
762	sub urxvt::line::offset_of {	1843	sub urxvt::line::offset_of {
763	my ($self, $row, $col) = @_;	1844	my ($self, $row, $col) = @_;
764		1845
765	($row - $self->{beg}) * $self->{term}->ncol + $col	1846	($row - $self->{beg}) * $self->{ncol} + $col
766	}	1847	}
767		1848
768	sub urxvt::line::coord_of {	1849	sub urxvt::line::coord_of {
769	my ($self, $offset) = @_;	1850	my ($self, $offset) = @_;
770		1851
771	use integer;	1852	use integer;
772		1853
773	(	1854	(
774	$offset / $self->{term}->ncol + $self->{beg},	1855	$offset / $self->{ncol} + $self->{beg},
775	$offset % $self->{term}->ncol	1856	$offset % $self->{ncol}
776	)	1857	)
777	}	1858	}
778		1859
779	=item ($row, $col) = $line->coord_of ($offset)
780	=item $text = $term->special_encode $string	1860	=item $text = $term->special_encode $string
781		1861
782	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,
783	where one character corresponds to one screen cell. See	1863	where one character corresponds to one screen cell. See
784	C<< $term->ROW_t >> for details.	1864	C<< $term->ROW_t >> for details.
785		1865
786	=item $string = $term->special_decode $text	1866	=item $string = $term->special_decode $text
787		1867
788	Converts rxvt-unicodes text reprsentation into a perl string. See	1868	Converts rxvt-unicodes text representation into a perl string. See
789	C<< $term->ROW_t >> for details.	1869	C<< $term->ROW_t >> for details.
790		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
791	=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;
792		2075
793	=head2 The C<urxvt::timer> Class	2076	=head2 The C<urxvt::timer> Class
794		2077
795	This class implements timer watchers/events. Time is represented as a	2078	This class implements timer watchers/events. Time is represented as a
796	fractional number of seconds since the epoch. Example:	2079	fractional number of seconds since the epoch. Example:
…		…
800	->new	2083	->new
801	->interval (1)	2084	->interval (1)
802	->cb (sub {	2085	->cb (sub {
803	$term->{overlay}->set (0, 0,	2086	$term->{overlay}->set (0, 0,
804	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2087	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
805	});	2088	});
806		2089
807	=over 4	2090	=over 4
808		2091
809	=item $timer = new urxvt::timer	2092	=item $timer = new urxvt::timer
810		2093
…		…
813		2096
814	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2097	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
815		2098
816	Set the callback to be called when the timer triggers.	2099	Set the callback to be called when the timer triggers.
817		2100
818	=item $tstamp = $timer->at
819
820	Return the time this watcher will fire next.
821
822	=item $timer = $timer->set ($tstamp)	2101	=item $timer = $timer->set ($tstamp[, $interval])
823		2102
824	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).
825		2105
826	=item $timer = $timer->interval ($interval)	2106	=item $timer = $timer->interval ($interval)
827		2107
828	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
829	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
830	is automatically rescheduled at the given intervals.	2110	is automatically rescheduled at the given intervals.
831		2111
832	=item $timer = $timer->start	2112	=item $timer = $timer->start
833		2113
834	Start the timer.	2114	Start the timer.
835		2115
836	=item $timer = $timer->start ($tstamp)	2116	=item $timer = $timer->start ($tstamp[, $interval])
837		2117
838	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>.
839		2124
840	=item $timer = $timer->stop	2125	=item $timer = $timer->stop
841		2126
842	Stop the timer.	2127	Stop the timer.
843		2128
…		…
849		2134
850	$term->{socket} = ...	2135	$term->{socket} = ...
851	$term->{iow} = urxvt::iow	2136	$term->{iow} = urxvt::iow
852	->new	2137	->new
853	->fd (fileno $term->{socket})	2138	->fd (fileno $term->{socket})
854	->events (1) # wait for read data	2139	->events (urxvt::EV_READ)
855	->start	2140	->start
856	->cb (sub {	2141	->cb (sub {
857	my ($iow, $revents) = @_;	2142	my ($iow, $revents) = @_;
858	# $revents must be 1 here, no need to check	2143	# $revents must be 1 here, no need to check
859	sysread $term->{socket}, my $buf, 8192	2144	sysread $term->{socket}, my $buf, 8192
…		…
872	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>
873	is a bitset as described in the C<events> method.	2158	is a bitset as described in the C<events> method.
874		2159
875	=item $iow = $iow->fd ($fd)	2160	=item $iow = $iow->fd ($fd)
876		2161
877	Set the filedescriptor (not handle) to watch.	2162	Set the file descriptor (not handle) to watch.
878		2163
879	=item $iow = $iow->events ($eventmask)	2164	=item $iow = $iow->events ($eventmask)
880		2165
881	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
882	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>.
883		2169
884	=item $iow = $iow->start	2170	=item $iow = $iow->start
885		2171
886	Start watching for requested events on the given handle.	2172	Start watching for requested events on the given handle.
887		2173
888	=item $iow = $iow->stop	2174	=item $iow = $iow->stop
889		2175
890	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.
891		2238
892	=back	2239	=back
893		2240
894	=head1 ENVIRONMENT	2241	=head1 ENVIRONMENT
895		2242
…		…
898	This variable controls the verbosity level of the perl extension. Higher	2245	This variable controls the verbosity level of the perl extension. Higher
899	numbers indicate more verbose output.	2246	numbers indicate more verbose output.
900		2247
901	=over 4	2248	=over 4
902		2249
903	=item =0 - only fatal messages	2250	=item == 0 - fatal messages
904		2251
905	=item =3 - script loading and management	2252	=item >= 3 - script loading and management
906		2253
907	=item =10 - all events received	2254	=item >=10 - all called hooks
		2255
		2256	=item >=11 - hook return values
908		2257
909	=back	2258	=back
910		2259
911	=head1 AUTHOR	2260	=head1 AUTHOR
912		2261
913	Marc Lehmann <pcg@goof.com>	2262	Marc Lehmann <schmorp@schmorp.de>
914	http://software.schmorp.de/pkg/rxvt-unicode	2263	http://software.schmorp.de/pkg/rxvt-unicode
915		2264
916	=cut	2265	=cut
917		2266
918	1	2267	1
		2268
		2269	# vim: sw=3:

Diff Legend

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