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.19 by root, Tue Jan 3 02:42:17 2006 UTC vs.
Revision 1.245 by root, Mon Dec 22 09:10:12 2014 UTC

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

Diff Legend

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