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

Diff Legend

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