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.33 by root, Thu Jan 5 01:04:10 2006 UTC vs.
Revision 1.231 by root, Sun Apr 27 20:26:28 2014 UTC

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

Diff Legend

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