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.13 by root, Tue Jan 3 00:06:57 2006 UTC vs.
Revision 1.257 by root, Thu Jul 13 10:31:27 2017 UTC

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

Diff Legend

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