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

Diff Legend

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