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.87 by root, Thu Jan 12 05:37:34 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 and further clicks). Right	49	loaded automatically when used.
46	now, it tries to select words, urls and complete shell-quoted
47	arguments, which is very convenient, too, if your F<ls> supports
48	C<--quoting-style=shell>.
49
50	A double-click usually selects the word under the cursor, further clicks
51	will enlarge the selection.
52
53	It also offers the following bindable keyboard command:
54
55	=over 4
56
57	=item rot13
58
59	Rot-13 the selection when activated. Used via keyboard trigger:
60
61	URxvt.keysym.C-M-r: perl:selection:rot13
62
63	=back
64
65	=item option-popup (enabled by default)
66
67	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
68	runtime.
69
70	=item selection-popup (enabled by default)
71
72	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
73	text into various other formats/action (such as uri unescaping, perl
74	evalution, web-browser starting etc.), depending on content.
75
76	=item searchable-scrollback<hotkey> (enabled by default)
77
78	Adds regex search functionality to the scrollback buffer, triggered
79	by a hotkey (default: C<M-s>). While in search mode, normal terminal
80	input/output is suspended and a regex is displayed at the bottom of the
81	screen.
82
83	Inputting characters appends them to the regex and continues incremental
84	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
85	search upwards/downwards in the scrollback buffer, C<End> jumps to the
86	bottom. C<Escape> leaves search mode and returns to the point where search
87	was started, while C<Enter> or C<Return> stay at the current position and
88	additionally stores the first match in the current line into the primary
89	selection.
90
91	=item digital-clock
92
93	Displays a digital clock using the built-in overlay.
94
95	=item mark-urls
96
97	Uses per-line display filtering (C<on_line_update>) to underline urls and
98	make them clickable. When middle-clicked, the program specified in the
99	resource C<urlLauncher> (default C<x-www-browser>) will be started with
100	the URL as first argument.
101
102	=item block-graphics-to-ascii
103
104	A not very useful example of filtering all text output to the terminal,
105	by replacing all line-drawing characters (U+2500 .. U+259F) by a
106	similar-looking ascii character.
107
108	=item example-refresh-hooks
109
110	Displays a very simple digital clock in the upper right corner of the
111	window. Illustrates overwriting the refresh callbacks to create your own
112	overlays or changes.
113
114	=back
115		50
116	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
117		52
118	=head2 General API Considerations	53	=head2 General API Considerations
119		54
…		…
133		68
134	=over 4	69	=over 4
135		70
136	=item $text	71	=item $text
137		72
138	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
139	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.
140		75
141	=item $string	76	=item $string
142		77
143	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
…		…
147	=item $octets	82	=item $octets
148		83
149	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
150	locale-specific way.	85	locale-specific way.
151		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
152	=back	93	=back
153		94
154	=head2 Extension Objects	95	=head2 Extension Objects
155		96
156	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
157	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,
158	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
159	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
160	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
161	use.	103	internal use.
162		104
163	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
164	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
165		107
166	It has the following methods and data members:	108	It has the following methods and data members:
…		…
187	=head2 Hooks	129	=head2 Hooks
188		130
189	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
190	called whenever the relevant event happens.	132	called whenever the relevant event happens.
191		133
192	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
193	the in the C<Extension Objects> section.	135	the in the C<Extension Objects> section.
194		136
195	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
196	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
197	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.
198		140
199	I<< When in doubt, return a false value (preferably C<()>). >>	141	I<< When in doubt, return a false value (preferably C<()>). >>
200		142
201	=over 4	143	=over 4
202		144
203	=item on_init $term	145	=item on_init $term
204		146
205	Called after a new terminal object has been initialized, but before	147	Called after a new terminal object has been initialized, but before
206	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
207	call or deliver senseless data, as terminal size and other characteristics	149	call or deliver senseless data, as terminal size and other characteristics
208	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
209	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).
210		163
211	=item on_reset $term	164	=item on_reset $term
212		165
213	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
214	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
215	variables.	168	variables.
216		169
217	=item on_start $term	170	=item on_child_start $term, $pid
218		171
219	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.
220	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>.
221		178
222	=item on_sel_make $term, $eventtime	179	=item on_sel_make $term, $eventtime
223		180
224	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
225	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
…		…
232		189
233	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
234	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
235	by calling C<< $term->selection >>.	192	by calling C<< $term->selection >>.
236		193
237	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.
238		195
239	=item on_sel_extend $term	196	=item on_sel_extend $term
240		197
241	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
242	click) and is either supposed to return false (normal operation), or	199	click) and is either supposed to return false (normal operation), or
243	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
244	processing. This can happen multiple times, as long as the callback	201	processing. This can happen multiple times, as long as the callback
245	returns true, it will be called on every further click by the user and is	202	returns true, it will be called on every further click by the user and is
246	supposed to enlarge the selection more and more, if possible.	203	supposed to enlarge the selection more and more, if possible.
247		204
248	See the F<selection> example extension.	205	See the F<selection> example extension.
249		206
250	=item on_view_change $term, $offset	207	=item on_view_change $term, $offset
251		208
252	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
253	scrolls. Offset C<0> means display the normal terminal, positive values	210	scrolls. Offset C<0> means display the normal terminal, positive values
254	show this many lines of scrollback.	211	show this many lines of scrollback.
255		212
256	=item on_scroll_back $term, $lines, $saved	213	=item on_scroll_back $term, $lines, $saved
257		214
…		…
261		218
262	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,
263	$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
264	number of lines that will be in the scrollback buffer.	221	number of lines that will be in the scrollback buffer.
265		222
266	=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
267		234
268	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
269	operating system command) is processed. Cursor position and other state	236	operating system command) is processed. Cursor position and other state
270	information is up-to-date when this happens. For interoperability, the	237	information is up-to-date when this happens. For interoperability, the
271	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,
272	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
273	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	}
274		251
275	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,
276	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
277	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.
278		258
279	=item on_add_lines $term, $string	259	=item on_add_lines $term, $string
280		260
281	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
282	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
…		…
287	=item on_tt_write $term, $octets	267	=item on_tt_write $term, $octets
288		268
289	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
290	suppress or filter tty input.	270	suppress or filter tty input.
291		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
292	=item on_line_update $term, $row	279	=item on_line_update $term, $row
293		280
294	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
295	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
296	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,
…		…
303	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
304	you cannot just toggle rendition bits, but only set them.	291	you cannot just toggle rendition bits, but only set them.
305		292
306	=item on_refresh_begin $term	293	=item on_refresh_begin $term
307		294
308	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
309	or similar effects by modify terminal contents in refresh_begin, and	296	similar effects by modifying the terminal contents in refresh_begin, and
310	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
311	code is run after this hook, and takes precedence.	298	code is run after this hook, and takes precedence.
312		299
313	=item on_refresh_end $term	300	=item on_refresh_end $term
314		301
315	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>.
316		303
317	=item on_keyboard_command $term, $string	304	=item on_user_command $term, $string
318		305
319	Called whenever the user presses a key combination that has a	306	Called whenever a user-configured event is being activated (e.g. via
320	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>
321	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.
322		335
323	=item on_focus_in $term	336	=item on_focus_in $term
324		337
325	Called whenever the window gets the keyboard focus, before rxvt-unicode	338	Called whenever the window gets the keyboard focus, before rxvt-unicode
326	does focus in processing.	339	does focus in processing.
327		340
328	=item on_focus_out $term	341	=item on_focus_out $term
329		342
330	Called wheneever the window loses keyboard focus, before rxvt-unicode does	343	Called whenever the window loses keyboard focus, before rxvt-unicode does
331	focus out processing.	344	focus out processing.
332		345
		346	=item on_configure_notify $term, $event
		347
		348	=item on_property_notify $term, $event
		349
333	=item on_key_press $term, $event, $keysym, $octets	350	=item on_key_press $term, $event, $keysym, $octets
334		351
335	=item on_key_release $term, $event, $keysym	352	=item on_key_release $term, $event, $keysym
336		353
337	=item on_button_press $term, $event	354	=item on_button_press $term, $event
…		…
342		359
343	=item on_map_notify $term, $event	360	=item on_map_notify $term, $event
344		361
345	=item on_unmap_notify $term, $event	362	=item on_unmap_notify $term, $event
346		363
347	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
348	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.
349		366
350	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
351	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
352	and column under the mouse cursor.	369	(real, not screen-based) row and column under the mouse cursor.
353		370
354	C<on_key_press> additionally receives the string rxvt-unicode would	371	C<on_key_press> additionally receives the string rxvt-unicode would
355	output, if any, in locale-specific encoding.	372	output, if any, in locale-specific encoding.
356		373
357	subwindow.	374	subwindow.
358		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
359	=back	389	=back
360		390
361	=cut	391	=cut
362		392
363	package urxvt;	393	package urxvt;
364		394
365	use utf8;	395	use utf8;
366	use strict;	396	use strict 'vars';
367	use Carp ();	397	use Carp ();
368	use Scalar::Util ();	398	use Scalar::Util ();
369	use List::Util ();	399	use List::Util ();
370		400
371	our $VERSION = 1;	401	our $VERSION = 1;
372	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.
373	our @HOOKNAME;	405	our @HOOKNAME;
374	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	406	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
375	our %OPTION;	407	our %OPTION;
376		408
377	our $LIBDIR;	409	our $LIBDIR;
378	our $RESNAME;	410	our $RESNAME;
379	our $RESCLASS;	411	our $RESCLASS;
380	our $RXVTNAME;	412	our $RXVTNAME;
381		413
		414	our $NOCHAR = chr 0xffff;
		415
382	=head2 Variables in the C<urxvt> Package	416	=head2 Variables in the C<urxvt> Package
383		417
384	=over 4	418	=over 4
385		419
386	=item $urxvt::LIBDIR	420	=item $urxvt::LIBDIR
…		…
399	=item $urxvt::TERM	433	=item $urxvt::TERM
400		434
401	The current terminal. This variable stores the current C<urxvt::term>	435	The current terminal. This variable stores the current C<urxvt::term>
402	object, whenever a callback/hook is executing.	436	object, whenever a callback/hook is executing.
403		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
404	=back	454	=back
405		455
406	=head2 Functions in the C<urxvt> Package	456	=head2 Functions in the C<urxvt> Package
407		457
408	=over 4	458	=over 4
409		459
410	=item urxvt::fatal $errormessage	460	=item urxvt::fatal $errormessage
411		461
412	Fatally aborts execution with the given error message. Avoid at all	462	Fatally aborts execution with the given error message (which should
413	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
414	starts up.	464	is acceptable (and useful) is in the init hook, where it prevents the
		465	terminal from starting up.
415		466
416	=item urxvt::warn $string	467	=item urxvt::warn $string
417		468
418	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
419	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
420	that calls this function.	471	that calls this function.
421		472
422	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
423	correct place, e.g. on stderr of the connecting urxvtc client.	474	correct place, e.g. on stderr of the connecting urxvtc client.
424		475
425	Messages have a size limit of 1023 bytes currently.	476	Messages have a size limit of 1023 bytes currently.
426		477
427	=item $is_safe = urxvt::safe	478	=item @terms = urxvt::termlist
428		479
429	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
430	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
431	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).
432		484
433	=item $time = urxvt::NOW	485	=item $time = urxvt::NOW
434		486
435	Returns the "current time" (as per the event loop).	487	Returns the "current time" (as per the event loop).
436		488
437	=item urxvt::CurrentTime	489	=item urxvt::CurrentTime
438		490
439	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	491	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	492	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441	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
442		510
443	Various constants for use in X calls and event processing.	511	Various constants for use in X calls and event processing.
444		512
445	=back	513	=back
446		514
…		…
463		531
464	=item $rend = urxvt::OVERLAY_RSTYLE	532	=item $rend = urxvt::OVERLAY_RSTYLE
465		533
466	Return the rendition mask used for overlays by default.	534	Return the rendition mask used for overlays by default.
467		535
468	=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
469		538
470	Return the bit that enabled bold, italic, blink, reverse-video and	539	Return the bit that enabled bold, italic, blink, reverse-video and
471	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
472	the bitset.	541	the bitset.
473		542
…		…
479		548
480	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	549	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
481		550
482	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	551	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
483		552
		553	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		554
484	Replace the foreground/background colour in the rendition mask with the	555	Replace the foreground/background colour in the rendition mask with the
485	specified one.	556	specified one.
486		557
487	=item $value = urxvt::GET_CUSTOM $rend	558	=item $value = urxvt::GET_CUSTOM $rend
488		559
…		…
497	=back	568	=back
498		569
499	=cut	570	=cut
500		571
501	BEGIN {	572	BEGIN {
502	urxvt->bootstrap;
503
504	# overwrite perl's warn	573	# overwrite perl's warn
505	*CORE::GLOBAL::warn = sub {	574	*CORE::GLOBAL::warn = sub {
506	my $msg = join "", @_;	575	my $msg = join "", @_;
507	$msg .= "\n"	576	$msg .= "\n"
508	unless $msg =~ /\n$/;	577	unless $msg =~ /\n$/;
509	urxvt::warn ($msg);	578	urxvt::warn ($msg);
510	};	579	};
511
512	# %ENV is the original startup environment
513	delete $ENV{IFS};
514	delete $ENV{CDPATH};
515	delete $ENV{BASH_ENV};
516	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
517	}	580	}
518		581
519	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
520	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521		645
522	sub verbose {	646	sub verbose {
523	my ($level, $msg) = @_;	647	my ($level, $msg) = @_;
524	warn "$msg\n" if $level <= $verbosity;	648	warn "$msg\n" if $level <= $verbosity;
525	}	649	}
526		650
527	my $extension_pkg = "extension0000";
528	my %extension_pkg;	651	my %extension_pkg;
529		652
530	# load a single script into its own package, once only	653	# load a single script into its own package, once only
531	sub extension_package($) {	654	sub extension_package($) {
532	my ($path) = @_;	655	my ($path) = @_;
533		656
534	$extension_pkg{$path} ||= do {	657	$extension_pkg{$path} ||= do {
535	my $pkg = "urxvt::" . ($extension_pkg++);	658	$path =~ /([^\/\\]+)$/;
		659	my $pkg = $1;
		660	$pkg =~ s/[^[:word:]]/_/g;
		661	$pkg = "urxvt::ext::$pkg";
536		662
537	verbose 3, "loading extension '$path' into package '$pkg'";	663	verbose 3, "loading extension '$path' into package '$pkg'";
		664
		665	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
538		666
539	open my $fh, "<:raw", $path	667	open my $fh, "<:raw", $path
540	or die "$path: $!";	668	or die "$path: $!";
541		669
542	my $source = untaint	670	my $source =
543	"package $pkg; use strict; use utf8;\n"	671	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
544	. "use base urxvt::term::extension::;\n"
545	. "#line 1 \"$path\"\n{\n"	672	. "#line 1 \"$path\"\n{\n"
546	. (do { local $/; <$fh> })	673	. (do { local $/; <$fh> })
547	. "\n};\n1";	674	. "\n};\n1";
548		675
549	eval $source	676	eval $source
…		…
559	sub invoke {	686	sub invoke {
560	local $TERM = shift;	687	local $TERM = shift;
561	my $htype = shift;	688	my $htype = shift;
562		689
563	if ($htype == 0) { # INIT	690	if ($htype == 0) { # INIT
564	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	691	my @dirs = $TERM->perl_libdirs;
565		692
566	my %ext_arg;	693	my %ext_arg;
567		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} },
568	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		707	) {
569	if ($_ eq "default") {	708	if ($_ eq "default") {
570	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	709	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
571	} elsif (/^-(.*)$/) {	710	} elsif (/^-(.*)$/) {
572	delete $ext_arg{$1};	711	delete $ext_arg{$1};
573	} elsif (/^([^<]+)<(.*)>$/) {	712	} elsif (/^([^<]+)<(.*)>$/) {
574	push @{ $ext_arg{$1} }, $2;	713	push @{ $ext_arg{$1} }, $2;
575	} else {	714	} else {
576	$ext_arg{$_} ||= [];	715	$ext_arg{$_} ||= [];
577	}	716	}
578	}	717	}
579		718
580	while (my ($ext, $argv) = each %ext_arg) {	719	for my $ext (sort keys %ext_arg) {
581	my @files = grep -f $_, map "$_/$ext", @dirs;	720	my @files = grep -f $_, map "$_/$ext", @dirs;
582		721
583	if (@files) {	722	if (@files) {
584	$TERM->register_package (extension_package $files[0], $argv);	723	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
585	} else {	724	} else {
586	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";
587	}	726	}
588	}	727	}
589		728
…		…
595		734
596	if (my $cb = $TERM->{_hook}[$htype]) {	735	if (my $cb = $TERM->{_hook}[$htype]) {
597	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
598	if $verbosity >= 10;	737	if $verbosity >= 10;
599		738
600	keys %$cb;	739	for my $pkg (keys %$cb) {
601
602	while (my ($pkg, $cb) = each %$cb) {
603	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
604	and last;	741	$retval ||= $retval_;
605		742
606	if ($@) {	743	if ($@) {
607	$TERM->ungrab; # better to lose the grab than the session	744	$TERM->ungrab; # better to lose the grab than the session
608	warn $@;	745	warn $@;
609	}	746	}
…		…
612	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613	if $verbosity >= 11;	750	if $verbosity >= 11;
614	}	751	}
615		752
616	if ($htype == 1) { # DESTROY	753	if ($htype == 1) { # DESTROY
617	if (my $hook = delete $TERM->{_hook}) {
618	for my $htype (0..$#$hook) {
619	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
620	or set_should_invoke $htype, 0;
621	}
622	}
623
624	# clear package objects	754	# clear package objects
625	%$_ = () for values %{ $TERM->{_pkg} };	755	%$_ = () for values %{ $TERM->{_pkg} };
626		756
627	# clear package	757	# clear package
628	%$TERM = ();	758	%$TERM = ();
629	}	759	}
630		760
631	$retval	761	$retval
632	}	762	}
633		763
634	sub exec_async(@) {	764	sub SET_COLOR($$$) {
635	my $pid = fork;	765	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
636
637	return
638	if !defined $pid or $pid;
639
640	%ENV = %{ $TERM->env };
641
642	exec @_;
643	_exit 255;
644	}	766	}
645		767
646	# 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	}
647		792
648	package urxvt::term::extension;	793	package urxvt::term::extension;
649		794
650	sub enable {	795	sub enable {
651	my ($self, %hook) = @_;	796	my ($self, %hook) = @_;
…		…
654	while (my ($name, $cb) = each %hook) {	799	while (my ($name, $cb) = each %hook) {
655	my $htype = $HOOKTYPE{uc $name};	800	my $htype = $HOOKTYPE{uc $name};
656	defined $htype	801	defined $htype
657	or Carp::croak "unsupported hook type '$name'";	802	or Carp::croak "unsupported hook type '$name'";
658		803
		804	$self->set_should_invoke ($htype, +1)
659	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	805	unless exists $self->{term}{_hook}[$htype]{$pkg};
660	$hook_count[$htype]++
661	or urxvt::set_should_invoke $htype, 1;
662	}
663		806
664	$self->{term}{_hook}[$htype]{$pkg} = $cb;	807	$self->{term}{_hook}[$htype]{$pkg} = $cb;
665	}	808	}
666	}	809	}
667		810
…		…
672	for my $name (@hook) {	815	for my $name (@hook) {
673	my $htype = $HOOKTYPE{uc $name};	816	my $htype = $HOOKTYPE{uc $name};
674	defined $htype	817	defined $htype
675	or Carp::croak "unsupported hook type '$name'";	818	or Carp::croak "unsupported hook type '$name'";
676		819
		820	$self->set_should_invoke ($htype, -1)
677	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	821	if delete $self->{term}{_hook}[$htype]{$pkg};
678	--$hook_count[$htype]
679	or urxvt::set_should_invoke $htype, 0;
680	}
681	}	822	}
682	}	823	}
683		824
684	our $AUTOLOAD;	825	our $AUTOLOAD;
685		826
…		…
710		851
711	sub urxvt::destroy_hook(&) {	852	sub urxvt::destroy_hook(&) {
712	bless \shift, urxvt::destroy_hook::	853	bless \shift, urxvt::destroy_hook::
713	}	854	}
714		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
715	package urxvt::anyevent;	868	package urxvt::anyevent;
716		869
717	=head2 The C<urxvt::anyevent> Class	870	=head2 The C<urxvt::anyevent> Class
718		871
719	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
720	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
721	further programming. The only exception is that you cannot wait on	874	further programming. The only exception is that you cannot wait on
722	condition variables, but non-blocking condvar use is ok. What this means	875	condition variables, but non-blocking condvar use is ok.
723	is that you cannot use blocking APIs, but the non-blocking variant should	876
724	work.	877	In practical terms this means is that you cannot use blocking APIs, but
		878	the non-blocking variant should work.
725		879
726	=cut	880	=cut
727		881
728	our $VERSION = 1;	882	our $VERSION = '5.23';
729		883
730	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	884	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
731	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	885	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
732		886
733	sub timer {	887	sub timer {
…		…
735		889
736	my $cb = $arg{cb};	890	my $cb = $arg{cb};
737		891
738	urxvt::timer	892	urxvt::timer
739	->new	893	->new
740	->start (urxvt::NOW + $arg{after})	894	->after ($arg{after}, $arg{interval})
741	->cb (sub {	895	->cb ($arg{interval} ? $cb : sub {
742	$_[0]->stop; # need to cancel manually	896	$_[0]->stop; # need to cancel manually
743	$cb->();	897	$cb->();
744	})	898	})
745	}	899	}
746		900
747	sub io {	901	sub io {
748	my ($class, %arg) = @_;	902	my ($class, %arg) = @_;
749		903
750	my $cb = $arg{cb};	904	my $cb = $arg{cb};
		905	my $fd = fileno $arg{fh};
		906	defined $fd or $fd = $arg{fh};
751		907
752	bless [$arg{fh}, urxvt::iow	908	bless [$arg{fh}, urxvt::iow
753	->new	909	->new
754	->fd (fileno $arg{fh})	910	->fd ($fd)
755	->events (($arg{poll} =~ /r/ ? 1 : 0)	911	->events (($arg{poll} =~ /r/ ? 1 : 0)
756	| ($arg{poll} =~ /w/ ? 2 : 0))	912	| ($arg{poll} =~ /w/ ? 2 : 0))
757	->start	913	->start
758	->cb (sub {	914	->cb ($cb)
759	$cb->(($_[1] & 1 ? 'r' : '')
760	. ($_[1] & 2 ? 'w' : ''));
761	})],
762	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	})
763	}	941	}
764		942
765	sub DESTROY {	943	sub DESTROY {
766	$_[0][1]->stop;	944	$_[0][1]->stop;
767	}	945	}
768		946
769	sub condvar {	947	# only needed for AnyEvent < 6 compatibility
770	bless \my $flag, urxvt::anyevent::condvar::	948	sub one_event {
771	}
772
773	sub urxvt::anyevent::condvar::broadcast {
774	${$_[0]}++;
775	}
776
777	sub urxvt::anyevent::condvar::wait {
778	unless (${$_[0]}) {
779	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";
780	}
781	}	950	}
782		951
783	package urxvt::term;	952	package urxvt::term;
784		953
785	=head2 The C<urxvt::term> Class	954	=head2 The C<urxvt::term> Class
…		…
791	# find on_xxx subs in the package and register them	960	# find on_xxx subs in the package and register them
792	# as hooks	961	# as hooks
793	sub register_package {	962	sub register_package {
794	my ($self, $pkg, $argv) = @_;	963	my ($self, $pkg, $argv) = @_;
795		964
		965	no strict 'refs';
		966
		967	urxvt::verbose 6, "register package $pkg to $self";
		968
		969	@{"$pkg\::ISA"} = urxvt::term::extension::;
		970
796	my $proxy = bless {	971	my $proxy = bless {
797	_pkg => $pkg,	972	_pkg => $pkg,
		973	_name => ${"$pkg\::_NAME"}, # hackish
798	argv => $argv,	974	argv => $argv,
799	}, $pkg;	975	}, $pkg;
800	Scalar::Util::weaken ($proxy->{term} = $self);	976	Scalar::Util::weaken ($proxy->{term} = $self);
801		977
802	$self->{_pkg}{$pkg} = $proxy;	978	$self->{_pkg}{$pkg} = $proxy;
803		979
…		…
806	$proxy->enable ($name => $ref);	982	$proxy->enable ($name => $ref);
807	}	983	}
808	}	984	}
809	}	985	}
810		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
811	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
812		1035
813	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
814	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
815	hash which defines the environment of the new terminal.	1038	hash which defines the environment of the new terminal.
816		1039
817	Croaks (and probably outputs an error message) if the new instance	1040	Croaks (and probably outputs an error message) if the new instance
818	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
819	initialise perl, and the terminal object otherwise. The C<init> and	1042	initialise perl, and the terminal object otherwise. The C<init> and
820	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).
821		1045
822	=cut	1046	=cut
823		1047
824	sub new {	1048	sub new {
825	my ($class, $env, @args) = @_;	1049	my ($class, $env, @args) = @_;
826		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
827	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1054	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
828	}	1055	}
829		1056
830	=item $term->destroy	1057	=item $term->destroy
831		1058
832	Destroy the terminal object (close the window, free resources	1059	Destroy the terminal object (close the window, free resources
833	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
834	watchers (timers, io watchers) are still active.	1061	watchers (timers, io watchers) are still active.
835		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
836	=item $isset = $term->option ($optval[, $set])	1088	=item $isset = $term->option ($optval[, $set])
837		1089
838	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
839	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
840	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.
841		1093
842	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
843	source file F</src/optinc.h> to see the actual list:	1095	source file F</src/optinc.h> to see the actual list:
844		1096
845	borderLess console cursorBlink cursorUnderline hold iconic insecure	1097	borderLess buffered console cursorBlink cursorUnderline hold iconic
846	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
847	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
848	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
849	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
850	tripleclickwords utmpInhibit visualBell	1103	urgentOnBell utmpInhibit visualBell
851		1104
852	=item $value = $term->resource ($name[, $newval])	1105	=item $value = $term->resource ($name[, $newval])
853		1106
854	Returns the current resource value associated with a given name and	1107	Returns the current resource value associated with a given name and
855	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>
…		…
864	likely change).	1117	likely change).
865		1118
866	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
867	terminal is destroyed, so changing options frequently will eat memory.	1120	terminal is destroyed, so changing options frequently will eat memory.
868		1121
869	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
870	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>
871	to see the actual list:	1124	to see the actual list:
872		1125
873	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1126	answerbackstring backgroundPixmap backspace_key blurradius
874	borderLess color cursorBlink cursorUnderline cutchars delete_key	1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
875	display_name embed ext_bwidth fade font geometry hold iconName	1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
876	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
877	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
878	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1132	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
879	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1133	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
880	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
881	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
882	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
883	shade term_name title transparent transparent_all tripleclickwords	1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1138	term_name title transient_for transparent tripleclickwords urgentOnBell
884	utmpInhibit visualBell	1139	utmpInhibit visualBell
885		1140
886	=cut	1141	=cut
887		1142
888	sub resource($$;$) {	1143	sub resource($$;$) {
889	my ($self, $name) = (shift, shift);	1144	my ($self, $name) = (shift, shift);
890	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1145	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
891	&urxvt::term::_resource	1146	goto &urxvt::term::_resource
892	}	1147	}
893		1148
894	=item $value = $term->x_resource ($pattern)	1149	=item $value = $term->x_resource ($pattern)
895		1150
896	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
897	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
898	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
899	resource with that pattern exists.	1154	resource with that pattern exists.
900		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
901	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
902	only one resource database per display, and later invocations might return	1167	only one resource database per display, and later invocations might return
903	the wrong resources.	1168	the wrong resources.
904		1169
905	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1170	=item $value = $term->x_resource_boolean ($pattern)
906		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
907	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
908	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.
909		1197
910	=item $rend = $term->rstyle ([$new_rstyle])	1198	=item $rend = $term->rstyle ([$new_rstyle])
911		1199
912	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
913	the terminal application will use this style.	1201	the terminal application will use this style.
…		…
921		1209
922	=item ($row, $col) = $term->selection_beg ([$row, $col])	1210	=item ($row, $col) = $term->selection_beg ([$row, $col])
923		1211
924	=item ($row, $col) = $term->selection_end ([$row, $col])	1212	=item ($row, $col) = $term->selection_end ([$row, $col])
925		1213
926	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.
927	and optionally set them to new values.	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.
928		1223
929	=item $term->selection_make ($eventtime[, $rectangular])	1224	=item $term->selection_make ($eventtime[, $rectangular])
930		1225
931	Tries to make a selection as set by C<selection_beg> and	1226	Tries to make a selection as set by C<selection_beg> and
932	C<selection_end>. If C<$rectangular> is true (default: false), a	1227	C<selection_end>. If C<$rectangular> is true (default: false), a
933	rectangular selection will be made. This is the prefered function to make	1228	rectangular selection will be made. This is the preferred function to make
934	a selection.	1229	a selection.
935		1230
936	=item $success = $term->selection_grab ($eventtime)	1231	=item $success = $term->selection_grab ($eventtime[, $clipboard])
937		1232
938	Try to request the primary selection text from the server (for example, as	1233	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1234	true) selection from the server. The corresponding text can be set
939	set by the next method). No visual feedback will be given. This function	1235	with the next method. No visual feedback will be given. This function
940	is mostly useful from within C<on_sel_grab> hooks.	1236	is mostly useful from within C<on_sel_grab> hooks.
941		1237
942	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext, $clipboard])
943		1239
944	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.
945		1246
946	=item $term->overlay_simple ($x, $y, $text)	1247	=item $term->overlay_simple ($x, $y, $text)
947		1248
948	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.
949		1250
…		…
979		1280
980	The methods currently supported on C<urxvt::overlay> objects are:	1281	The methods currently supported on C<urxvt::overlay> objects are:
981		1282
982	=over 4	1283	=over 4
983		1284
984	=item $overlay->set ($x, $y, $text, $rend)	1285	=item $overlay->set ($x, $y, $text[, $rend])
985		1286
986	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
987	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
988	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.
989		1292
990	=item $overlay->hide	1293	=item $overlay->hide
991		1294
992	If visible, hide the overlay, but do not destroy it.	1295	If visible, hide the overlay, but do not destroy it.
993		1296
…		…
1063		1366
1064	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
1065	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
1066	C<on_add_lines> hook, though.	1369	C<on_add_lines> hook, though.
1067		1370
		1371	=item $term->scr_change_screen ($screen)
		1372
		1373	Switch to given screen - 0 primary, 1 secondary.
		1374
1068	=item $term->cmd_parse ($octets)	1375	=item $term->cmd_parse ($octets)
1069		1376
1070	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
1071	locale-specific encoding of the terminal and can contain command sequences	1378	locale-specific encoding of the terminal and can contain command sequences
1072	(escape codes) that will be interpreted.	1379	(escape codes) that will be interpreted.
1073		1380
1074	=item $term->tt_write ($octets)	1381	=item $term->tt_write ($octets)
1075		1382
1076	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
1077	pass characters instead of octets, you should convert your strings first	1384	pass characters instead of octets, you should convert your strings first
1078	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.
1079		1392
1080	=item $old_events = $term->pty_ev_events ([$new_events])	1393	=item $old_events = $term->pty_ev_events ([$new_events])
1081		1394
1082	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
1083	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
1084	description of C<< urxvt::timer->events >>. Make sure to always restore	1397	description of C<< urxvt::timer->events >>. Make sure to always restore
1085	the previous value.	1398	the previous value.
1086		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
1087	=item $windowid = $term->parent	1405	=item $windowid = $term->parent
1088		1406
1089	Return the window id of the toplevel window.	1407	Return the window id of the toplevel window.
1090		1408
1091	=item $windowid = $term->vt	1409	=item $windowid = $term->vt
1092		1410
1093	Return the window id of the terminal window.	1411	Return the window id of the terminal window.
1094		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
1095	=item $window_width = $term->width	1434	=item $window_width = $term->width
1096		1435
1097	=item $window_height = $term->height	1436	=item $window_height = $term->height
1098		1437
1099	=item $font_width = $term->fwidth	1438	=item $font_width = $term->fwidth
…		…
1112		1451
1113	=item $max_scrollback = $term->saveLines	1452	=item $max_scrollback = $term->saveLines
1114		1453
1115	=item $nrow_plus_saveLines = $term->total_rows	1454	=item $nrow_plus_saveLines = $term->total_rows
1116		1455
1117	=item $lines_in_scrollback = $term->nsaved	1456	=item $topmost_scrollback_row = $term->top_row
1118		1457
1119	Return various integers describing terminal characteristics.	1458	Return various integers describing terminal characteristics.
1120		1459
1121	=item $x_display = $term->display_id	1460	=item $x_display = $term->display_id
1122		1461
…		…
1129	=item $env = $term->env	1468	=item $env = $term->env
1130		1469
1131	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
1132	similar to C<\%ENV>.	1471	similar to C<\%ENV>.
1133		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
1134	=cut	1482	=cut
1135		1483
1136	sub env {	1484	sub env {
1137	if (my $env = $_[0]->_env) {
1138	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1485	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1139	} else {
1140	+{ %ENV }
1141	}
1142	}	1486	}
1143		1487
1144	=item $modifiermask = $term->ModLevel3Mask	1488	=item $modifiermask = $term->ModLevel3Mask
1145		1489
1146	=item $modifiermask = $term->ModMetaMask	1490	=item $modifiermask = $term->ModMetaMask
…		…
1148	=item $modifiermask = $term->ModNumLockMask	1492	=item $modifiermask = $term->ModNumLockMask
1149		1493
1150	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
1151	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.
1152		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
1153	=item $view_start = $term->view_start ([$newvalue])	1505	=item $view_start = $term->view_start ([$newvalue])
1154		1506
1155	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
1156	C<0>, which displays the normal terminal contents. Larger values scroll	1508	C<0>, which displays the normal terminal contents. Lower values scroll
1157	this many lines into the scrollback buffer.	1509	this many lines into the scrollback buffer.
1158		1510
1159	=item $term->want_refresh	1511	=item $term->want_refresh
1160		1512
1161	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1513	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1164		1516
1165	Used after changing terminal contents to display them.	1517	Used after changing terminal contents to display them.
1166		1518
1167	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1168		1520
1169	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 >>
1170	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
1171	terminal line. The scrollback buffer starts at line C<-1> and extends to
1172	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1523	terminal line. Nothing will be returned if a nonexistent line
1173	is requested.	1524	is requested.
1174		1525
1175	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
1176	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
1177	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
1178	automatically be updated.	1529	automatically be updated.
1179		1530
1180	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
1181	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)
1182	(C<chr 65535>). Characters with combining characters and other characters	1533	characters. Characters with combining characters and other characters that
1183	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
1184	characters in the private use area.	1535	in the private use area.
1185		1536
1186	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
1187	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
1188	characters.	1539	characters.
1189		1540
…		…
1333	where one character corresponds to one screen cell. See	1684	where one character corresponds to one screen cell. See
1334	C<< $term->ROW_t >> for details.	1685	C<< $term->ROW_t >> for details.
1335		1686
1336	=item $string = $term->special_decode $text	1687	=item $string = $term->special_decode $text
1337		1688
1338	Converts rxvt-unicodes text reprsentation into a perl string. See	1689	Converts rxvt-unicodes text representation into a perl string. See
1339	C<< $term->ROW_t >> for details.	1690	C<< $term->ROW_t >> for details.
1340		1691
1341	=item $success = $term->grab_button ($button, $modifiermask)	1692	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1342		1693
		1694	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1695
1343	Registers a synchronous button grab. See the XGrabButton manpage.	1696	Register/unregister a synchronous button grab. See the XGrabButton
		1697	manpage.
1344		1698
1345	=item $success = $term->grab ($eventtime[, $sync])	1699	=item $success = $term->grab ($eventtime[, $sync])
1346		1700
1347	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1701	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1348	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1702	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1349		1703
1350	=item $term->allow_events_async	1704	=item $term->allow_events_async
1351		1705
1352	Calls XAllowEvents with AsyncBoth for the most recent grab.	1706	Calls XAllowEvents with AsyncBoth for the most recent grab.
1353		1707
…		…
1360	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1714	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1361	recent grab.	1715	recent grab.
1362		1716
1363	=item $term->ungrab	1717	=item $term->ungrab
1364		1718
1365	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
1366	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
1367	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.
1368		1756
1369	=back	1757	=back
1370		1758
1371	=cut	1759	=cut
1372		1760
…		…
1436	my ($self, $text, $cb) = @_;	1824	my ($self, $text, $cb) = @_;
1437		1825
1438	$self->add_item ({ type => "button", text => $text, activate => $cb});	1826	$self->add_item ({ type => "button", text => $text, activate => $cb});
1439	}	1827	}
1440		1828
1441	=item $popup->add_toggle ($text, $cb, $initial_value)	1829	=item $popup->add_toggle ($text, $initial_value, $cb)
1442		1830
1443	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
1444	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
1445	argument.	1833	first argument.
1446		1834
1447	=cut	1835	=cut
1448		1836
1449	sub add_toggle {	1837	sub add_toggle {
1450	my ($self, $text, $cb, $value) = @_;	1838	my ($self, $text, $value, $cb) = @_;
1451		1839
1452	my $item; $item = {	1840	my $item; $item = {
1453	type => "button",	1841	type => "button",
1454	text => " $text",	1842	text => " $text",
1455	value => $value,	1843	value => $value,
…		…
1474	my $env = $self->{term}->env;	1862	my $env = $self->{term}->env;
1475	# 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.
1476	delete $env->{LC_ALL};	1864	delete $env->{LC_ALL};
1477	$env->{LC_CTYPE} = $self->{term}->locale;	1865	$env->{LC_CTYPE} = $self->{term}->locale;
1478		1866
1479	urxvt::term->new ($env, $self->{term}->resource ("name"),	1867	my $term = urxvt::term->new (
1480	"--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",
1481	"--transient-for" => $self->{term}->parent,	1872	"--transient-for" => $self->{term}->parent,
1482	"-display" => $self->{term}->display_id,	1873	"-display" => $self->{term}->display_id,
1483	"-pe" => "urxvt-popup")	1874	"-pe" => "urxvt-popup",
1484	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	}
1485	}	1882	}
1486		1883
1487	sub DESTROY {	1884	sub DESTROY {
1488	my ($self) = @_;	1885	my ($self) = @_;
1489		1886
1490	delete $self->{term}{_destroy}{$self};	1887	delete $self->{term}{_destroy}{$self};
1491	$self->{term}->ungrab;	1888	$self->{term}->ungrab;
1492	}	1889	}
1493		1890
1494	=back	1891	=back
		1892
		1893	=cut
		1894
		1895	package urxvt::watcher;
1495		1896
1496	=head2 The C<urxvt::timer> Class	1897	=head2 The C<urxvt::timer> Class
1497		1898
1498	This class implements timer watchers/events. Time is represented as a	1899	This class implements timer watchers/events. Time is represented as a
1499	fractional number of seconds since the epoch. Example:	1900	fractional number of seconds since the epoch. Example:
…		…
1503	->new	1904	->new
1504	->interval (1)	1905	->interval (1)
1505	->cb (sub {	1906	->cb (sub {
1506	$term->{overlay}->set (0, 0,	1907	$term->{overlay}->set (0, 0,
1507	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1908	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1508	});	1909	});
1509		1910
1510	=over 4	1911	=over 4
1511		1912
1512	=item $timer = new urxvt::timer	1913	=item $timer = new urxvt::timer
1513		1914
…		…
1516		1917
1517	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1918	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1518		1919
1519	Set the callback to be called when the timer triggers.	1920	Set the callback to be called when the timer triggers.
1520		1921
1521	=item $tstamp = $timer->at
1522
1523	Return the time this watcher will fire next.
1524
1525	=item $timer = $timer->set ($tstamp)	1922	=item $timer = $timer->set ($tstamp[, $interval])
1526		1923
1527	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).
1528		1926
1529	=item $timer = $timer->interval ($interval)	1927	=item $timer = $timer->interval ($interval)
1530		1928
1531	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
1532	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
1533	is automatically rescheduled at the given intervals.	1931	is automatically rescheduled at the given intervals.
1534		1932
1535	=item $timer = $timer->start	1933	=item $timer = $timer->start
1536		1934
1537	Start the timer.	1935	Start the timer.
1538		1936
1539	=item $timer = $timer->start ($tstamp)	1937	=item $timer = $timer->start ($tstamp[, $interval])
1540		1938
1541	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>.
1542		1945
1543	=item $timer = $timer->stop	1946	=item $timer = $timer->stop
1544		1947
1545	Stop the timer.	1948	Stop the timer.
1546		1949
…		…
1552		1955
1553	$term->{socket} = ...	1956	$term->{socket} = ...
1554	$term->{iow} = urxvt::iow	1957	$term->{iow} = urxvt::iow
1555	->new	1958	->new
1556	->fd (fileno $term->{socket})	1959	->fd (fileno $term->{socket})
1557	->events (urxvt::EVENT_READ)	1960	->events (urxvt::EV_READ)
1558	->start	1961	->start
1559	->cb (sub {	1962	->cb (sub {
1560	my ($iow, $revents) = @_;	1963	my ($iow, $revents) = @_;
1561	# $revents must be 1 here, no need to check	1964	# $revents must be 1 here, no need to check
1562	sysread $term->{socket}, my $buf, 8192	1965	sysread $term->{socket}, my $buf, 8192
…		…
1575	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>
1576	is a bitset as described in the C<events> method.	1979	is a bitset as described in the C<events> method.
1577		1980
1578	=item $iow = $iow->fd ($fd)	1981	=item $iow = $iow->fd ($fd)
1579		1982
1580	Set the filedescriptor (not handle) to watch.	1983	Set the file descriptor (not handle) to watch.
1581		1984
1582	=item $iow = $iow->events ($eventmask)	1985	=item $iow = $iow->events ($eventmask)
1583		1986
1584	Set the event mask to watch. The only allowed values are	1987	Set the event mask to watch. The only allowed values are
1585	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
1586	together, or C<urxvt::EVENT_NONE>.	1989	together, or C<urxvt::EV_NONE>.
1587		1990
1588	=item $iow = $iow->start	1991	=item $iow = $iow->start
1589		1992
1590	Start watching for requested events on the given handle.	1993	Start watching for requested events on the given handle.
1591		1994
1592	=item $iow = $iow->stop	1995	=item $iow = $iow->stop
1593		1996
1594	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.
1595		2059
1596	=back	2060	=back
1597		2061
1598	=head1 ENVIRONMENT	2062	=head1 ENVIRONMENT
1599		2063
…		…
1608		2072
1609	=item >= 3 - script loading and management	2073	=item >= 3 - script loading and management
1610		2074
1611	=item >=10 - all called hooks	2075	=item >=10 - all called hooks
1612		2076
1613	=item >=11 - hook reutrn values	2077	=item >=11 - hook return values
1614		2078
1615	=back	2079	=back
1616		2080
1617	=head1 AUTHOR	2081	=head1 AUTHOR
1618		2082
1619	Marc Lehmann <pcg@goof.com>	2083	Marc Lehmann <schmorp@schmorp.de>
1620	http://software.schmorp.de/pkg/rxvt-unicode	2084	http://software.schmorp.de/pkg/rxvt-unicode
1621		2085
1622	=cut	2086	=cut
1623		2087
1624	1	2088	1
		2089
		2090	# vim: sw=3:

Diff Legend

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