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

Diff Legend

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