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

Diff Legend

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