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.70 by root, Mon Jan 9 23:00:07 2006 UTC vs.
Revision 1.223 by root, Sat Jul 14 08:00:18 2012 UTC

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

Diff Legend

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