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.22 by root, Tue Jan 3 19:10:54 2006 UTC vs.
Revision 1.250 by sf-exg, Fri Dec 26 21:49:11 2014 UTC

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

Diff Legend

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