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.32 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.232 by sf-exg, Fri May 2 20:33:56 2014 UTC

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

Diff Legend

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