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

Diff Legend

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