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.20 by root, Tue Jan 3 04:18:47 2006 UTC vs.
Revision 1.248 by root, Fri Dec 26 21:01:46 2014 UTC

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

Diff Legend

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