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.68 by root, Mon Jan 9 20:00:31 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	=head2 Prepackaged Extensions	31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
32		33
33	This section describes the extensiosn delivered with this version. You can	34	=head1 PREPACKAGED EXTENSIONS
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	35
		36	A number of extensions are delivered with this release. You can find them
		37	in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed
		38	using F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	@@RXVT_NAME@@ -pe <extensionname>
39		43
40	=over 4	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	=item selection (enabled by default)	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	Intelligent selection. This extension tries to be more intelligent when	48	Extensions that add command line parameters or resources on their own are
45	the user extends selections (double-click). Right now, it tries to select	49	loaded automatically when used.
46	urls and complete shell-quoted arguments, which is very convenient, too,
47	if your F<ls> supports C<--quoting-style=shell>.
48		50
49	It also offers the following bindable event:	51	=head1 API DOCUMENTATION
50
51	=over 4
52
53	=item rot13
54
55	Rot-13 the selection when activated. Used via keyboard trigger:
56
57	URxvt.keysym.C-M-r: perl:selection:rot13
58
59	=back
60
61	=item option-popup (enabled by default)
62
63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.
65
66	=item selection-popup (enabled by default)
67
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.
70
71	=item digital-clock
72
73	Displays a digital clock using the built-in overlay.
74
75	=item mark-urls
76
77	Uses per-line display filtering (C<on_line_update>) to underline urls.
78
79	=item block-graphics-to-ascii
80
81	A not very useful example of filtering all text output to the terminal,
82	by replacing all line-drawing characters (U+2500 .. U+259F) by a
83	similar-looking ascii character.
84
85	=item example-refresh-hooks
86
87	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.
90
91	=back
92		52
93	=head2 General API Considerations	53	=head2 General API Considerations
94		54
95	All objects (such as terminals, time watchers etc.) are typical	55	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	56	reference-to-hash objects. The hash can be used to store anything you
…		…
108		68
109	=over 4	69	=over 4
110		70
111	=item $text	71	=item $text
112		72
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
114	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.
115		75
116	=item $string	76	=item $string
117		77
118	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
119	characters and is to be distinguished with text encoded in a specific	79	characters and is to be distinguished with text encoded in a specific
…		…
122	=item $octets	82	=item $octets
123		83
124	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
125	locale-specific way.	85	locale-specific way.
126		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
		93	=back
		94
		95	=head2 Extension Objects
		96
		97	Every perl extension is a perl class. A separate perl object is created
		98	for each terminal, and each terminal has its own set of extension objects,
		99	which are passed as the first parameter to hooks. So extensions can use
		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
		102	that begin with an underscore character C<_>: these are reserved for
		103	internal use.
		104
		105	Although it isn't a C<urxvt::term> object, you can call all methods of the
		106	C<urxvt::term> class on this object.
		107
		108	It has the following methods and data members:
		109
		110	=over 4
		111
		112	=item $urxvt_term = $self->{term}
		113
		114	Returns the C<urxvt::term> object associated with this instance of the
		115	extension. This member I<must not> be changed in any way.
		116
		117	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		118
		119	Dynamically enable the given hooks (named without the C<on_> prefix) for
		120	this extension, replacing any previous hook. This is useful when you want
		121	to overwrite time-critical hooks only temporarily.
		122
		123	=item $self->disable ($hook_name[, $hook_name..])
		124
		125	Dynamically disable the given hooks.
		126
127	=back	127	=back
128		128
129	=head2 Hooks	129	=head2 Hooks
130		130
131	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
132	called whenever the relevant event happens.	132	called whenever the relevant event happens.
133		133
134	The first argument passed to them is an object private to each terminal	134	The first argument passed to them is an extension object as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	135	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		136
141	All of them must return a boolean value. If it is true, then the event	137	B<All> of these hooks must return a boolean value. If any of the called
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	138	hooks returns true, then the event counts as being I<consumed>, and the
143	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.
144		140
145	When in doubt, return a false value (preferably C<()>).	141	I<< When in doubt, return a false value (preferably C<()>). >>
146		142
147	=over 4	143	=over 4
148		144
149	=item on_init $term	145	=item on_init $term
150		146
151	Called after a new terminal object has been initialized, but before	147	Called after a new terminal object has been initialized, but before
152	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
153	call or deliver senseless data, as terminal size and other characteristics	149	call or deliver senseless data, as terminal size and other characteristics
154	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
155	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).
156		163
157	=item on_reset $term	164	=item on_reset $term
158		165
159	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
160	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
161	variables.	168	variables.
162		169
163	=item on_start $term	170	=item on_child_start $term, $pid
164		171
165	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.
166	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>.
167		178
168	=item on_sel_make $term, $eventtime	179	=item on_sel_make $term, $eventtime
169		180
170	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
171	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
…		…
178		189
179	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
180	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
181	by calling C<< $term->selection >>.	192	by calling C<< $term->selection >>.
182		193
183	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.
184		195
185	=item on_sel_extend $term	196	=item on_sel_extend $term
186		197
187	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
188	click) and is either supposed to return false (normal operation), or	199	click) and is either supposed to return false (normal operation), or
189	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
190	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.
191		204
192	See the F<selection> example extension.	205	See the F<selection> example extension.
193		206
194	=item on_view_change $term, $offset	207	=item on_view_change $term, $offset
195		208
196	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
197	scrolls. Offset C<0> means display the normal terminal, positive values	210	scrolls. Offset C<0> means display the normal terminal, positive values
198	show this many lines of scrollback.	211	show this many lines of scrollback.
199		212
200	=item on_scroll_back $term, $lines, $saved	213	=item on_scroll_back $term, $lines, $saved
201		214
…		…
205		218
206	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,
207	$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
208	number of lines that will be in the scrollback buffer.	221	number of lines that will be in the scrollback buffer.
209		222
210	=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
211		234
212	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
213	operating system command) is processed. Cursor position and other state	236	operating system command) is processed. Cursor position and other state
214	information is up-to-date when this happens. For interoperability, the	237	information is up-to-date when this happens. For interoperability, the
215	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,
216	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
217	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	}
218		251
219	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,
220	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
221	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.
222		258
223	=item on_add_lines $term, $string	259	=item on_add_lines $term, $string
224		260
225	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
226	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
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	263	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	264	might be very slow, however, as your hook is called for B<all> text being
229	output.	265	output.
230		266
		267	=item on_tt_write $term, $octets
		268
		269	Called whenever some data is written to the tty/pty and can be used to
		270	suppress or filter tty input.
		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
231	=item on_line_update $term, $row	279	=item on_line_update $term, $row
232		280
233	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
234	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
235	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,
…		…
242	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
243	you cannot just toggle rendition bits, but only set them.	291	you cannot just toggle rendition bits, but only set them.
244		292
245	=item on_refresh_begin $term	293	=item on_refresh_begin $term
246		294
247	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
248	or similar effects by modify terminal contents in refresh_begin, and	296	similar effects by modifying the terminal contents in refresh_begin, and
249	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
250	code is run after this hook, and takes precedence.	298	code is run after this hook, and takes precedence.
251		299
252	=item on_refresh_end $term	300	=item on_refresh_end $term
253		301
254	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>.
255		303
256	=item on_keyboard_command $term, $string	304	=item on_user_command $term, $string
257		305
258	Called whenever the user presses a key combination that has a	306	Called whenever a user-configured event is being activated (e.g. via
259	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>
260	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.
261		335
262	=item on_focus_in $term	336	=item on_focus_in $term
263		337
264	Called whenever the window gets the keyboard focus, before rxvt-unicode	338	Called whenever the window gets the keyboard focus, before rxvt-unicode
265	does focus in processing.	339	does focus in processing.
266		340
267	=item on_focus_out $term	341	=item on_focus_out $term
268		342
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	343	Called whenever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	344	focus out processing.
271		345
		346	=item on_configure_notify $term, $event
		347
		348	=item on_property_notify $term, $event
		349
272	=item on_key_press $term, $event, $octets	350	=item on_key_press $term, $event, $keysym, $octets
273		351
274	=item on_key_release $term, $event	352	=item on_key_release $term, $event, $keysym
275		353
276	=item on_button_press $term, $event	354	=item on_button_press $term, $event
277		355
278	=item on_button_release $term, $event	356	=item on_button_release $term, $event
279		357
…		…
281		359
282	=item on_map_notify $term, $event	360	=item on_map_notify $term, $event
283		361
284	=item on_unmap_notify $term, $event	362	=item on_unmap_notify $term, $event
285		363
286	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
287	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.
288		366
289	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
290	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
291	and column under the mouse cursor.	369	(real, not screen-based) row and column under the mouse cursor.
292		370
293	C<on_key_press> additionally receives the string rxvt-unicode would	371	C<on_key_press> additionally receives the string rxvt-unicode would
294	output, if any, in locale-specific encoding.	372	output, if any, in locale-specific encoding.
295		373
296	subwindow.	374	subwindow.
297		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
298	=back	389	=back
299		390
		391	=cut
		392
		393	package urxvt;
		394
		395	use utf8;
		396	use strict 'vars';
		397	use Carp ();
		398	use Scalar::Util ();
		399	use List::Util ();
		400
		401	our $VERSION = 1;
		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.
		405	our @HOOKNAME;
		406	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		407	our %OPTION;
		408
		409	our $LIBDIR;
		410	our $RESNAME;
		411	our $RESCLASS;
		412	our $RXVTNAME;
		413
		414	our $NOCHAR = chr 0xffff;
		415
300	=head2 Variables in the C<urxvt> Package	416	=head2 Variables in the C<urxvt> Package
301		417
302	=over 4	418	=over 4
		419
		420	=item $urxvt::LIBDIR
		421
		422	The rxvt-unicode library directory, where, among other things, the perl
		423	modules and scripts are stored.
		424
		425	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		426
		427	The resource class and name rxvt-unicode uses to look up X resources.
		428
		429	=item $urxvt::RXVTNAME
		430
		431	The basename of the installed binaries, usually C<urxvt>.
303		432
304	=item $urxvt::TERM	433	=item $urxvt::TERM
305		434
306	The current terminal. This variable stores the current C<urxvt::term>	435	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	436	object, whenever a callback/hook is executing.
308		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
309	=back	454	=back
310		455
311	=head2 Functions in the C<urxvt> Package	456	=head2 Functions in the C<urxvt> Package
312		457
313	=over 4	458	=over 4
314		459
315	=item $term = new urxvt [arg...]
316
317	Creates a new terminal, very similar as if you had started it with
318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319	if the new instance couldn't be created. Returns C<undef> if the new
320	instance didn't initialise perl, and the terminal object otherwise. The
321	C<init> and C<start> hooks will be called during the call.
322
323	=item urxvt::fatal $errormessage	460	=item urxvt::fatal $errormessage
324		461
325	Fatally aborts execution with the given error message. Avoid at all	462	Fatally aborts execution with the given error message (which should
326	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
327	starts up.	464	is acceptable (and useful) is in the init hook, where it prevents the
		465	terminal from starting up.
328		466
329	=item urxvt::warn $string	467	=item urxvt::warn $string
330		468
331	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
332	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
333	that calls this function.	471	that calls this function.
334		472
335	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
336	correct place, e.g. on stderr of the connecting urxvtc client.	474	correct place, e.g. on stderr of the connecting urxvtc client.
337		475
338	=item $is_safe = urxvt::safe	476	Messages have a size limit of 1023 bytes currently.
339		477
340	Returns true when it is safe to do potentially unsafe things, such as	478	=item @terms = urxvt::termlist
341	evaluating perl code specified by the user. This is true when urxvt was	479
342	started setuid or setgid.	480	Returns all urxvt::term objects that exist in this process, regardless of
		481	whether they are started, being destroyed etc., so be careful. Only term
		482	objects that have perl extensions attached will be returned (because there
		483	is no urxvt::term object associated with others).
343		484
344	=item $time = urxvt::NOW	485	=item $time = urxvt::NOW
345		486
346	Returns the "current time" (as per the event loop).	487	Returns the "current time" (as per the event loop).
347		488
348	=item urxvt::CurrentTime	489	=item urxvt::CurrentTime
349		490
350	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	491	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
351	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	492	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
352	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
353		510
354	Various constants for use in X calls and event processing.	511	Various constants for use in X calls and event processing.
355		512
356	=back	513	=back
357		514
…		…
374		531
375	=item $rend = urxvt::OVERLAY_RSTYLE	532	=item $rend = urxvt::OVERLAY_RSTYLE
376		533
377	Return the rendition mask used for overlays by default.	534	Return the rendition mask used for overlays by default.
378		535
379	=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
380		538
381	Return the bit that enabled bold, italic, blink, reverse-video and	539	Return the bit that enabled bold, italic, blink, reverse-video and
382	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
383	the bitset.	541	the bitset.
384		542
…		…
386		544
387	=item $background = urxvt::GET_BASEBG $rend	545	=item $background = urxvt::GET_BASEBG $rend
388		546
389	Return the foreground/background colour index, respectively.	547	Return the foreground/background colour index, respectively.
390		548
391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	549	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392		550
393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	551	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		552
		553	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
394		554
395	Replace the foreground/background colour in the rendition mask with the	555	Replace the foreground/background colour in the rendition mask with the
396	specified one.	556	specified one.
397		557
398	=item $value = urxvt::GET_CUSTOM ($rend)	558	=item $value = urxvt::GET_CUSTOM $rend
399		559
400	Return the "custom" value: Every rendition has 5 bits for use by	560	Return the "custom" value: Every rendition has 5 bits for use by
401	extensions. They can be set and changed as you like and are initially	561	extensions. They can be set and changed as you like and are initially
402	zero.	562	zero.
403		563
404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	564	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405		565
406	Change the custom value.	566	Change the custom value.
407		567
408	=back	568	=back
409		569
410	=cut	570	=cut
411		571
412	package urxvt;
413
414	use utf8;
415	use strict;
416	use Scalar::Util ();
417	use List::Util ();
418
419	our $VERSION = 1;
420	our $TERM;
421	our @HOOKNAME;
422	our %OPTION;
423	our $LIBDIR;
424
425	BEGIN {	572	BEGIN {
426	urxvt->bootstrap;
427
428	# overwrite perl's warn	573	# overwrite perl's warn
429	*CORE::GLOBAL::warn = sub {	574	*CORE::GLOBAL::warn = sub {
430	my $msg = join "", @_;	575	my $msg = join "", @_;
431	$msg .= "\n"	576	$msg .= "\n"
432	unless $msg =~ /\n$/;	577	unless $msg =~ /\n$/;
433	urxvt::warn ($msg);	578	urxvt::warn ($msg);
434	};	579	};
435
436	delete $ENV{IFS};
437	delete $ENV{CDPATH};
438	delete $ENV{BASH_ENV};
439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
440	}	580	}
441		581
442	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
443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
444		645
445	sub verbose {	646	sub verbose {
446	my ($level, $msg) = @_;	647	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	648	warn "$msg\n" if $level <= $verbosity;
448	}	649	}
449		650
450	my $extension_pkg = "extension0000";
451	my %extension_pkg;	651	my %extension_pkg;
452		652
453	# load a single script into its own package, once only	653	# load a single script into its own package, once only
454	sub extension_package($) {	654	sub extension_package($) {
455	my ($path) = @_;	655	my ($path) = @_;
456		656
457	$extension_pkg{$path} ||= do {	657	$extension_pkg{$path} ||= do {
458	my $pkg = "urxvt::" . ($extension_pkg++);	658	$path =~ /([^\/\\]+)$/;
		659	my $pkg = $1;
		660	$pkg =~ s/[^[:word:]]/_/g;
		661	$pkg = "urxvt::ext::$pkg";
459		662
460	verbose 3, "loading extension '$path' into package '$pkg'";	663	verbose 3, "loading extension '$path' into package '$pkg'";
		664
		665	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
461		666
462	open my $fh, "<:raw", $path	667	open my $fh, "<:raw", $path
463	or die "$path: $!";	668	or die "$path: $!";
464		669
465	my $source = untaint "package $pkg; use strict; use utf8;\n"	670	my $source =
466	. "use base urxvt::term::proxy::;\n"	671	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
467	. "#line 1 \"$path\"\n{\n"	672	. "#line 1 \"$path\"\n{\n"
468	. (do { local $/; <$fh> })	673	. (do { local $/; <$fh> })
469	. "\n};\n1";	674	. "\n};\n1";
470		675
		676	eval $source
471	eval $source or die "$path: $@";	677	or die "$path: $@";
472		678
473	$pkg	679	$pkg
474	}	680	}
475	}	681	}
476		682
…		…
480	sub invoke {	686	sub invoke {
481	local $TERM = shift;	687	local $TERM = shift;
482	my $htype = shift;	688	my $htype = shift;
483		689
484	if ($htype == 0) { # INIT	690	if ($htype == 0) { # INIT
485	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	691	my @dirs = $TERM->perl_libdirs;
486		692
487	my %ext_arg;	693	my %ext_arg;
488		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} },
489	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		707	) {
490	if ($_ eq "default") {	708	if ($_ eq "default") {
491	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup);	709	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
492	} elsif (/^-(.*)$/) {	710	} elsif (/^-(.*)$/) {
493	delete $ext_arg{$1};	711	delete $ext_arg{$1};
494	} elsif (/^([^<]+)<(.*)>$/) {	712	} elsif (/^([^<]+)<(.*)>$/) {
495	push @{ $ext_arg{$1} }, $2;	713	push @{ $ext_arg{$1} }, $2;
496	} else {	714	} else {
497	$ext_arg{$_} ||= [];	715	$ext_arg{$_} ||= [];
498	}	716	}
499	}	717	}
500		718
501	while (my ($ext, $argv) = each %ext_arg) {	719	for my $ext (sort keys %ext_arg) {
502	my @files = grep -f $_, map "$_/$ext", @dirs;	720	my @files = grep -f $_, map "$_/$ext", @dirs;
503		721
504	if (@files) {	722	if (@files) {
505	$TERM->register_package (extension_package $files[0], $argv);	723	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
506	} else {	724	} else {
507	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";
508	}	726	}
509	}	727	}
510		728
…		…
516		734
517	if (my $cb = $TERM->{_hook}[$htype]) {	735	if (my $cb = $TERM->{_hook}[$htype]) {
518	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
519	if $verbosity >= 10;	737	if $verbosity >= 10;
520		738
521	keys %$cb;	739	for my $pkg (keys %$cb) {
522
523	while (my ($pkg, $cb) = each %$cb) {
524	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
525	and last;	741	$retval ||= $retval_;
526		742
527	if ($@) {	743	if ($@) {
528	$TERM->ungrab; # better to lose the grab than the session	744	$TERM->ungrab; # better to lose the grab than the session
529	warn $@;	745	warn $@;
530	}	746	}
531	}	747	}
		748
		749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		750	if $verbosity >= 11;
532	}	751	}
533		752
534	if ($htype == 1) { # DESTROY	753	if ($htype == 1) { # DESTROY
535	# remove hooks if unused
536	if (my $hook = $TERM->{_hook}) {
537	for my $htype (0..$#$hook) {
538	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
539	or set_should_invoke $htype, 0;
540	}
541	}
542
543	# clear package objects	754	# clear package objects
544	%$_ = () for values %{ $TERM->{_pkg} };	755	%$_ = () for values %{ $TERM->{_pkg} };
545		756
546	# clear package	757	# clear package
547	%$TERM = ();	758	%$TERM = ();
548	}	759	}
549		760
550	$retval	761	$retval
551	}	762	}
552		763
553	# urxvt::term::proxy	764	sub SET_COLOR($$$) {
		765	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		766	}
554		767
555	sub urxvt::term::proxy::AUTOLOAD {	768	sub rend2mask {
556	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	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	}
		792
		793	package urxvt::term::extension;
		794
		795	sub enable {
		796	my ($self, %hook) = @_;
		797	my $pkg = $self->{_pkg};
		798
		799	while (my ($name, $cb) = each %hook) {
		800	my $htype = $HOOKTYPE{uc $name};
		801	defined $htype
		802	or Carp::croak "unsupported hook type '$name'";
		803
		804	$self->set_should_invoke ($htype, +1)
		805	unless exists $self->{term}{_hook}[$htype]{$pkg};
		806
		807	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		808	}
		809	}
		810
		811	sub disable {
		812	my ($self, @hook) = @_;
		813	my $pkg = $self->{_pkg};
		814
		815	for my $name (@hook) {
		816	my $htype = $HOOKTYPE{uc $name};
		817	defined $htype
		818	or Carp::croak "unsupported hook type '$name'";
		819
		820	$self->set_should_invoke ($htype, -1)
		821	if delete $self->{term}{_hook}[$htype]{$pkg};
		822	}
		823	}
		824
		825	our $AUTOLOAD;
		826
		827	sub AUTOLOAD {
		828	$AUTOLOAD =~ /:([^:]+)$/
557	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	829	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
558		830
559	eval qq{	831	eval qq{
560	sub $urxvt::term::proxy::AUTOLOAD {	832	sub $AUTOLOAD {
561	my \$proxy = shift;	833	my \$proxy = shift;
562	\$proxy->{term}->$1 (\@_)	834	\$proxy->{term}->$1 (\@_)
563	}	835	}
564	1	836	1
565	} or die "FATAL: unable to compile method forwarder: $@";	837	} or die "FATAL: unable to compile method forwarder: $@";
566		838
567	goto &$urxvt::term::proxy::AUTOLOAD;	839	goto &$AUTOLOAD;
568	}	840	}
569		841
570	sub urxvt::term::proxy::DESTROY {	842	sub DESTROY {
571	# nop	843	# nop
572	}	844	}
573		845
574	# urxvt::destroy_hook	846	# urxvt::destroy_hook
575		847
…		…
579		851
580	sub urxvt::destroy_hook(&) {	852	sub urxvt::destroy_hook(&) {
581	bless \shift, urxvt::destroy_hook::	853	bless \shift, urxvt::destroy_hook::
582	}	854	}
583		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
584	package urxvt::anyevent;	868	package urxvt::anyevent;
585		869
586	=head2 The C<urxvt::anyevent> Class	870	=head2 The C<urxvt::anyevent> Class
587		871
588	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
589	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
590	further work. The only exception is that you cannot wait on condition	874	further programming. The only exception is that you cannot wait on
591	variables, but non-blocking condvar use is ok. What this means is that you	875	condition variables, but non-blocking condvar use is ok.
592	cannot use blocking APIs, but the non-blocking variant should work.	876
		877	In practical terms this means is that you cannot use blocking APIs, but
		878	the non-blocking variant should work.
593		879
594	=cut	880	=cut
595		881
596	our $VERSION = 1;	882	our $VERSION = '5.23';
597		883
598	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	884	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
599	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	885	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
600		886
601	sub timer {	887	sub timer {
…		…
603		889
604	my $cb = $arg{cb};	890	my $cb = $arg{cb};
605		891
606	urxvt::timer	892	urxvt::timer
607	->new	893	->new
608	->start (urxvt::NOW + $arg{after})	894	->after ($arg{after}, $arg{interval})
609	->cb (sub {	895	->cb ($arg{interval} ? $cb : sub {
610	$_[0]->stop; # need to cancel manually	896	$_[0]->stop; # need to cancel manually
611	$cb->();	897	$cb->();
612	})	898	})
613	}	899	}
614		900
615	sub io {	901	sub io {
616	my ($class, %arg) = @_;	902	my ($class, %arg) = @_;
617		903
618	my $cb = $arg{cb};	904	my $cb = $arg{cb};
		905	my $fd = fileno $arg{fh};
		906	defined $fd or $fd = $arg{fh};
619		907
620	bless [$arg{fh}, urxvt::iow	908	bless [$arg{fh}, urxvt::iow
621	->new	909	->new
622	->fd (fileno $arg{fh})	910	->fd ($fd)
623	->events (($arg{poll} =~ /r/ ? 1 : 0)	911	->events (($arg{poll} =~ /r/ ? 1 : 0)
624	| ($arg{poll} =~ /w/ ? 2 : 0))	912	| ($arg{poll} =~ /w/ ? 2 : 0))
625	->start	913	->start
626	->cb (sub {	914	->cb ($cb)
627	$cb->(($_[1] & 1 ? 'r' : '')
628	. ($_[1] & 2 ? 'w' : ''));
629	})],
630	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	})
631	}	941	}
632		942
633	sub DESTROY {	943	sub DESTROY {
634	$_[0][1]->stop;	944	$_[0][1]->stop;
635	}	945	}
636		946
637	sub condvar {	947	# only needed for AnyEvent < 6 compatibility
638	bless \my $flag, urxvt::anyevent::condvar::	948	sub one_event {
639	}
640
641	sub urxvt::anyevent::condvar::broadcast {
642	${$_[0]}++;
643	}
644
645	sub urxvt::anyevent::condvar::wait {
646	unless (${$_[0]}) {
647	require Carp;
648	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";
649	}
650	}	950	}
651		951
652	package urxvt::term;	952	package urxvt::term;
653		953
654	=head2 The C<urxvt::term> Class	954	=head2 The C<urxvt::term> Class
…		…
660	# find on_xxx subs in the package and register them	960	# find on_xxx subs in the package and register them
661	# as hooks	961	# as hooks
662	sub register_package {	962	sub register_package {
663	my ($self, $pkg, $argv) = @_;	963	my ($self, $pkg, $argv) = @_;
664		964
665	my $proxy = bless { argv => $argv }, $pkg;	965	no strict 'refs';
		966
		967	urxvt::verbose 6, "register package $pkg to $self";
		968
		969	@{"$pkg\::ISA"} = urxvt::term::extension::;
		970
		971	my $proxy = bless {
		972	_pkg => $pkg,
		973	_name => ${"$pkg\::_NAME"}, # hackish
		974	argv => $argv,
		975	}, $pkg;
666	Scalar::Util::weaken ($proxy->{term} = $TERM);	976	Scalar::Util::weaken ($proxy->{term} = $self);
667		977
668	$self->{_pkg}{$pkg} = $proxy;	978	$self->{_pkg}{$pkg} = $proxy;
669		979
670	for my $htype (0.. $#HOOKNAME) {	980	for my $name (@HOOKNAME) {
671	my $name = $HOOKNAME[$htype];
672
673	my $ref = $pkg->can ("on_" . lc $name)	981	if (my $ref = $pkg->can ("on_" . lc $name)) {
		982	$proxy->enable ($name => $ref);
		983	}
		984	}
		985	}
		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
674	or next;	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;
675		1014
676	$self->{_hook}[$htype]{$pkg} = $ref;	1015	while (<$fh>) {
677	$hook_count[$htype]++	1016	if (/^#:META:X_RESOURCE:(.*)/) {
678	or urxvt::set_should_invoke $htype, 1;	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	}
679	}	1031	}
680	}	1032	}
681		1033
		1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1035
		1036	Creates a new terminal, very similar as if you had started it with system
		1037	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1038	hash which defines the environment of the new terminal.
		1039
		1040	Croaks (and probably outputs an error message) if the new instance
		1041	couldn't be created. Returns C<undef> if the new instance didn't
		1042	initialise perl, and the terminal object otherwise. The C<init> and
		1043	C<start> hooks will be called before this call returns, and are free to
		1044	refer to global data (which is race free).
		1045
		1046	=cut
		1047
		1048	sub new {
		1049	my ($class, $env, @args) = @_;
		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
		1054	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1055	}
		1056
682	=item $term->destroy	1057	=item $term->destroy
683		1058
684	Destroy the terminal object (close the window, free resources etc.).	1059	Destroy the terminal object (close the window, free resources
		1060	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1061	watchers (timers, io watchers) are still active.
		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	}
685		1087
686	=item $isset = $term->option ($optval[, $set])	1088	=item $isset = $term->option ($optval[, $set])
687		1089
688	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
689	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
690	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.
691		1093
692	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
693	source file F</src/optinc.h> to see the actual list:	1095	source file F</src/optinc.h> to see the actual list:
694		1096
695	borderLess console cursorBlink cursorUnderline hold iconic insecure	1097	borderLess buffered console cursorBlink cursorUnderline hold iconic
696	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
697	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
698	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
699	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
700	tripleclickwords utmpInhibit visualBell	1103	urgentOnBell utmpInhibit visualBell
701		1104
702	=item $value = $term->resource ($name[, $newval])	1105	=item $value = $term->resource ($name[, $newval])
703		1106
704	Returns the current resource value associated with a given name and	1107	Returns the current resource value associated with a given name and
705	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>
…		…
714	likely change).	1117	likely change).
715		1118
716	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
717	terminal is destroyed, so changing options frequently will eat memory.	1120	terminal is destroyed, so changing options frequently will eat memory.
718		1121
719	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
720	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>
721	to see the actual list:	1124	to see the actual list:
722		1125
723	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1126	answerbackstring backgroundPixmap backspace_key blurradius
724	borderLess color cursorBlink cursorUnderline cutchars delete_key	1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
725	display_name embed ext_bwidth fade font geometry hold iconName	1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
726	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
727	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
728	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1132	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
729	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1133	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
730	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
731	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
732	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
733	shade term_name title transparent transparent_all tripleclickwords	1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1138	term_name title transient_for transparent tripleclickwords urgentOnBell
734	utmpInhibit visualBell	1139	utmpInhibit visualBell
735		1140
736	=cut	1141	=cut
737		1142
738	sub resource($$;$) {	1143	sub resource($$;$) {
739	my ($self, $name) = (shift, shift);	1144	my ($self, $name) = (shift, shift);
740	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1145	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
741	&urxvt::term::_resource	1146	goto &urxvt::term::_resource
742	}	1147	}
		1148
		1149	=item $value = $term->x_resource ($pattern)
		1150
		1151	Returns the X-Resource for the given pattern, excluding the program or
		1152	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1153	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1154	resource with that pattern exists.
		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
		1166	This method should only be called during the C<on_start> hook, as there is
		1167	only one resource database per display, and later invocations might return
		1168	the wrong resources.
		1169
		1170	=item $value = $term->x_resource_boolean ($pattern)
		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
		1188	Adds a key binding exactly as specified via a resource. See the
		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.
743		1197
744	=item $rend = $term->rstyle ([$new_rstyle])	1198	=item $rend = $term->rstyle ([$new_rstyle])
745		1199
746	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
747	the terminal application will use this style.	1201	the terminal application will use this style.
…		…
755		1209
756	=item ($row, $col) = $term->selection_beg ([$row, $col])	1210	=item ($row, $col) = $term->selection_beg ([$row, $col])
757		1211
758	=item ($row, $col) = $term->selection_end ([$row, $col])	1212	=item ($row, $col) = $term->selection_end ([$row, $col])
759		1213
760	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.
761	and optionally set them to new values.
762		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
763	=item $success = $term->selection_grab ($eventtime)	1231	=item $success = $term->selection_grab ($eventtime[, $clipboard])
764		1232
765	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
766	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.
767		1237
768	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext, $clipboard])
769		1239
770	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>.
771		1242
		1243	=item $term->selection_clear ([$clipboard])
		1244
		1245	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1246
772	#=item $term->overlay ($x, $y, $text)	1247	=item $term->overlay_simple ($x, $y, $text)
773	#	1248
774	#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.
775	#	1250
776	#=cut	1251	=cut
777	#	1252
778	#sub urxvt::term::scr_overlay {	1253	sub overlay_simple {
779	# my ($self, $x, $y, $text) = @_;	1254	my ($self, $x, $y, $text) = @_;
780	#	1255
781	# my @lines = split /\n/, $text;	1256	my @lines = split /\n/, $text;
782	#	1257
783	# my $w = 0;	1258	my $w = List::Util::max map $self->strwidth ($_), @lines;
784	# for (map $self->strwidth ($_), @lines) {	1259
785	# $w = $_ if $w < $_;
786	# }
787	#
788	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1260	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
789	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1261	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
790	#}	1262
		1263	$overlay
		1264	}
791		1265
792	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1266	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
793		1267
794	Create a new (empty) overlay at the given position with the given	1268	Create a new (empty) overlay at the given position with the given
795	width/height. C<$rstyle> defines the initial rendition style	1269	width/height. C<$rstyle> defines the initial rendition style
…		…
806		1280
807	The methods currently supported on C<urxvt::overlay> objects are:	1281	The methods currently supported on C<urxvt::overlay> objects are:
808		1282
809	=over 4	1283	=over 4
810		1284
811	=item $overlay->set ($x, $y, $text, $rend)	1285	=item $overlay->set ($x, $y, $text[, $rend])
812		1286
813	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
814	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
815	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.
816		1292
817	=item $overlay->hide	1293	=item $overlay->hide
818		1294
819	If visible, hide the overlay, but do not destroy it.	1295	If visible, hide the overlay, but do not destroy it.
820		1296
…		…
862		1338
863	=item $string = $term->locale_decode ($octets)	1339	=item $string = $term->locale_decode ($octets)
864		1340
865	Convert the given locale-encoded octets into a perl string.	1341	Convert the given locale-encoded octets into a perl string.
866		1342
		1343	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1344
		1345	XORs the rendition values in the given span with the provided value
		1346	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1347	refresh hooks to provide effects similar to the selection.
		1348
		1349	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1350
		1351	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1352	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1353	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1354	it instead. Both styles I<MUST NOT> contain font styles.
		1355
		1356	=item $term->scr_bell
		1357
		1358	Ring the bell!
		1359
867	=item $term->scr_add_lines ($string)	1360	=item $term->scr_add_lines ($string)
868		1361
869	Write the given text string to the screen, as if output by the application	1362	Write the given text string to the screen, as if output by the application
870	running inside the terminal. It may not contain command sequences (escape	1363	running inside the terminal. It may not contain command sequences (escape
871	codes), but is free to use line feeds, carriage returns and tabs. The	1364	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
873		1366
874	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
875	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
876	C<on_add_lines> hook, though.	1369	C<on_add_lines> hook, though.
877		1370
		1371	=item $term->scr_change_screen ($screen)
		1372
		1373	Switch to given screen - 0 primary, 1 secondary.
		1374
878	=item $term->cmd_parse ($octets)	1375	=item $term->cmd_parse ($octets)
879		1376
880	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
881	locale-specific encoding of the terminal and can contain command sequences	1378	locale-specific encoding of the terminal and can contain command sequences
882	(escape codes) that will be interpreted.	1379	(escape codes) that will be interpreted.
883		1380
884	=item $term->tt_write ($octets)	1381	=item $term->tt_write ($octets)
885		1382
886	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
887	pass characters instead of octets, you should convert your strings first	1384	pass characters instead of octets, you should convert your strings first
888	to the locale-specific encoding using C<< $term->locale_encode >>.	1385	to the locale-specific encoding using C<< $term->locale_encode >>.
889		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.
		1392
		1393	=item $old_events = $term->pty_ev_events ([$new_events])
		1394
		1395	Replaces the event mask of the pty watcher by the given event mask. Can
		1396	be used to suppress input and output handling to the pty/tty. See the
		1397	description of C<< urxvt::timer->events >>. Make sure to always restore
		1398	the previous value.
		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
890	=item $windowid = $term->parent	1405	=item $windowid = $term->parent
891		1406
892	Return the window id of the toplevel window.	1407	Return the window id of the toplevel window.
893		1408
894	=item $windowid = $term->vt	1409	=item $windowid = $term->vt
895		1410
896	Return the window id of the terminal window.	1411	Return the window id of the terminal window.
897		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
898	=item $window_width = $term->width	1434	=item $window_width = $term->width
899		1435
900	=item $window_height = $term->height	1436	=item $window_height = $term->height
901		1437
902	=item $font_width = $term->fwidth	1438	=item $font_width = $term->fwidth
…		…
915		1451
916	=item $max_scrollback = $term->saveLines	1452	=item $max_scrollback = $term->saveLines
917		1453
918	=item $nrow_plus_saveLines = $term->total_rows	1454	=item $nrow_plus_saveLines = $term->total_rows
919		1455
920	=item $lines_in_scrollback = $term->nsaved	1456	=item $topmost_scrollback_row = $term->top_row
921		1457
922	Return various integers describing terminal characteristics.	1458	Return various integers describing terminal characteristics.
923		1459
		1460	=item $x_display = $term->display_id
		1461
		1462	Return the DISPLAY used by rxvt-unicode.
		1463
924	=item $lc_ctype = $term->locale	1464	=item $lc_ctype = $term->locale
925		1465
926	Returns the LC_CTYPE category string used by this rxvt-unicode.	1466	Returns the LC_CTYPE category string used by this rxvt-unicode.
927		1467
928	=item $x_display = $term->display_id	1468	=item $env = $term->env
929		1469
930	Return the DISPLAY used by rxvt-unicode.	1470	Returns a copy of the environment in effect for the terminal as a hashref
		1471	similar to C<\%ENV>.
		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
		1482	=cut
		1483
		1484	sub env {
		1485	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1486	}
931		1487
932	=item $modifiermask = $term->ModLevel3Mask	1488	=item $modifiermask = $term->ModLevel3Mask
933		1489
934	=item $modifiermask = $term->ModMetaMask	1490	=item $modifiermask = $term->ModMetaMask
935		1491
936	=item $modifiermask = $term->ModNumLockMask	1492	=item $modifiermask = $term->ModNumLockMask
937		1493
938	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
939	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.
940		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
941	=item $view_start = $term->view_start ([$newvalue])	1505	=item $view_start = $term->view_start ([$newvalue])
942		1506
943	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
944	C<0>, which displays the normal terminal contents. Larger values scroll	1508	C<0>, which displays the normal terminal contents. Lower values scroll
945	this many lines into the scrollback buffer.	1509	this many lines into the scrollback buffer.
946		1510
947	=item $term->want_refresh	1511	=item $term->want_refresh
948		1512
949	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1513	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
952		1516
953	Used after changing terminal contents to display them.	1517	Used after changing terminal contents to display them.
954		1518
955	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
956		1520
957	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 >>
958	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
959	terminal line. The scrollback buffer starts at line C<-1> and extends to
960	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1523	terminal line. Nothing will be returned if a nonexistent line
961	is requested.	1524	is requested.
962		1525
963	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
964	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
965	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
966	automatically be updated.	1529	automatically be updated.
967		1530
968	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
969	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)
970	(C<chr 65535>). Characters with combining characters and other characters	1533	characters. Characters with combining characters and other characters that
971	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
972	characters in the private use area.	1535	in the private use area.
973		1536
974	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
975	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
976	characters.	1539	characters.
977		1540
…		…
1028	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.
1029		1592
1030	=item $offset = $line->offset_of ($row, $col)	1593	=item $offset = $line->offset_of ($row, $col)
1031		1594
1032	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
1033	line.	1596	line. Works for rows outside the line, too, and returns corresponding
		1597	offsets outside the string.
1034		1598
1035	=item ($row, $col) = $line->coord_of ($offset)	1599	=item ($row, $col) = $line->coord_of ($offset)
1036		1600
1037	Translates a string offset into terminal coordinates again.	1601	Translates a string offset into terminal coordinates again.
1038		1602
…		…
1120	where one character corresponds to one screen cell. See	1684	where one character corresponds to one screen cell. See
1121	C<< $term->ROW_t >> for details.	1685	C<< $term->ROW_t >> for details.
1122		1686
1123	=item $string = $term->special_decode $text	1687	=item $string = $term->special_decode $text
1124		1688
1125	Converts rxvt-unicodes text reprsentation into a perl string. See	1689	Converts rxvt-unicodes text representation into a perl string. See
1126	C<< $term->ROW_t >> for details.	1690	C<< $term->ROW_t >> for details.
1127		1691
1128	=item $success = $term->grab_button ($button, $modifiermask)	1692	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1129		1693
		1694	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1695
1130	Registers a synchronous button grab. See the XGrabButton manpage.	1696	Register/unregister a synchronous button grab. See the XGrabButton
		1697	manpage.
1131		1698
1132	=item $success = $term->grab ($eventtime[, $sync])	1699	=item $success = $term->grab ($eventtime[, $sync])
1133		1700
1134	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1701	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1135	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1702	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1136		1703
1137	=item $term->allow_events_async	1704	=item $term->allow_events_async
1138		1705
1139	Calls XAllowEvents with AsyncBoth for the most recent grab.	1706	Calls XAllowEvents with AsyncBoth for the most recent grab.
1140		1707
…		…
1147	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1714	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1148	recent grab.	1715	recent grab.
1149		1716
1150	=item $term->ungrab	1717	=item $term->ungrab
1151		1718
1152	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
1153	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
1154	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.
1155		1756
1156	=back	1757	=back
1157		1758
1158	=cut	1759	=cut
1159		1760
…		…
1174		1775
1175	$item->{render} ||= sub { $_[0]{text} };	1776	$item->{render} ||= sub { $_[0]{text} };
1176		1777
1177	push @{ $self->{item} }, $item;	1778	push @{ $self->{item} }, $item;
1178	}	1779	}
		1780
		1781	=item $popup->add_title ($title)
		1782
		1783	Adds a non-clickable title to the popup.
		1784
		1785	=cut
		1786
		1787	sub add_title {
		1788	my ($self, $title) = @_;
		1789
		1790	$self->add_item ({
		1791	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1792	text => $title,
		1793	activate => sub { },
		1794	});
		1795	}
		1796
		1797	=item $popup->add_separator ([$sepchr])
		1798
		1799	Creates a separator, optionally using the character given as C<$sepchr>.
		1800
		1801	=cut
1179		1802
1180	sub add_separator {	1803	sub add_separator {
1181	my ($self, $sep) = @_;	1804	my ($self, $sep) = @_;
1182		1805
1183	$sep ||= "=";	1806	$sep ||= "=";
…		…
1188	render => sub { $sep x $self->{term}->ncol },	1811	render => sub { $sep x $self->{term}->ncol },
1189	activate => sub { },	1812	activate => sub { },
1190	});	1813	});
1191	}	1814	}
1192		1815
1193	sub add_title {	1816	=item $popup->add_button ($text, $cb)
1194	my ($self, $title) = @_;
1195		1817
1196	$self->add_item ({	1818	Adds a clickable button to the popup. C<$cb> is called whenever it is
1197	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1819	selected.
1198	text => $title,	1820
1199	activate => sub { },	1821	=cut
1200	});
1201	}
1202		1822
1203	sub add_button {	1823	sub add_button {
1204	my ($self, $text, $cb) = @_;	1824	my ($self, $text, $cb) = @_;
1205		1825
1206	$self->add_item ({ type => "button", text => $text, activate => $cb});	1826	$self->add_item ({ type => "button", text => $text, activate => $cb});
1207	}	1827	}
1208		1828
		1829	=item $popup->add_toggle ($text, $initial_value, $cb)
		1830
		1831	Adds a toggle/checkbox item to the popup. The callback gets called
		1832	whenever it gets toggled, with a boolean indicating its new value as its
		1833	first argument.
		1834
		1835	=cut
		1836
1209	sub add_toggle {	1837	sub add_toggle {
1210	my ($self, $text, $cb, $value) = @_;	1838	my ($self, $text, $value, $cb) = @_;
1211		1839
1212	my $item; $item = {	1840	my $item; $item = {
1213	type => "button",	1841	type => "button",
1214	text => " $text",	1842	text => " $text",
1215	value => $value,	1843	value => $value,
1216	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1844	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1217	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1845	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1218	};	1846	};
1219		1847
1220	$self->add_item ($item);	1848	$self->add_item ($item);
1221	}	1849	}
		1850
		1851	=item $popup->show
		1852
		1853	Displays the popup (which is initially hidden).
		1854
		1855	=cut
1222		1856
1223	sub show {	1857	sub show {
1224	my ($self) = @_;	1858	my ($self) = @_;
1225		1859
1226	local $urxvt::popup::self = $self;	1860	local $urxvt::popup::self = $self;
1227		1861
		1862	my $env = $self->{term}->env;
		1863	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1864	delete $env->{LC_ALL};
1228	local $ENV{LC_ALL} = $self->{term}->locale;	1865	$env->{LC_CTYPE} = $self->{term}->locale;
1229		1866
1230	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1867	my $term = urxvt::term->new (
		1868	$env, "popup",
		1869	"--perl-lib" => "", "--perl-ext-common" => "",
		1870	"-pty-fd" => -1, "-sl" => 0,
		1871	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1231	"--transient-for" => $self->{term}->parent,	1872	"--transient-for" => $self->{term}->parent,
1232	"-display" => $self->{term}->display_id,	1873	"-display" => $self->{term}->display_id,
1233	"-pe" => "urxvt-popup")	1874	"-pe" => "urxvt-popup",
1234	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	}
1235	}	1882	}
1236		1883
1237	sub DESTROY {	1884	sub DESTROY {
1238	my ($self) = @_;	1885	my ($self) = @_;
1239		1886
1240	delete $self->{term}{_destroy}{$self};	1887	delete $self->{term}{_destroy}{$self};
1241	$self->{term}->ungrab;	1888	$self->{term}->ungrab;
1242	}	1889	}
		1890
		1891	=back
		1892
		1893	=cut
		1894
		1895	package urxvt::watcher;
1243		1896
1244	=head2 The C<urxvt::timer> Class	1897	=head2 The C<urxvt::timer> Class
1245		1898
1246	This class implements timer watchers/events. Time is represented as a	1899	This class implements timer watchers/events. Time is represented as a
1247	fractional number of seconds since the epoch. Example:	1900	fractional number of seconds since the epoch. Example:
…		…
1251	->new	1904	->new
1252	->interval (1)	1905	->interval (1)
1253	->cb (sub {	1906	->cb (sub {
1254	$term->{overlay}->set (0, 0,	1907	$term->{overlay}->set (0, 0,
1255	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1908	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1256	});	1909	});
1257		1910
1258	=over 4	1911	=over 4
1259		1912
1260	=item $timer = new urxvt::timer	1913	=item $timer = new urxvt::timer
1261		1914
…		…
1264		1917
1265	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1918	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1266		1919
1267	Set the callback to be called when the timer triggers.	1920	Set the callback to be called when the timer triggers.
1268		1921
1269	=item $tstamp = $timer->at
1270
1271	Return the time this watcher will fire next.
1272
1273	=item $timer = $timer->set ($tstamp)	1922	=item $timer = $timer->set ($tstamp[, $interval])
1274		1923
1275	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).
1276		1926
1277	=item $timer = $timer->interval ($interval)	1927	=item $timer = $timer->interval ($interval)
1278		1928
1279	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
1280	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
1281	is automatically rescheduled at the given intervals.	1931	is automatically rescheduled at the given intervals.
1282		1932
1283	=item $timer = $timer->start	1933	=item $timer = $timer->start
1284		1934
1285	Start the timer.	1935	Start the timer.
1286		1936
1287	=item $timer = $timer->start ($tstamp)	1937	=item $timer = $timer->start ($tstamp[, $interval])
1288		1938
1289	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>.
1290		1945
1291	=item $timer = $timer->stop	1946	=item $timer = $timer->stop
1292		1947
1293	Stop the timer.	1948	Stop the timer.
1294		1949
…		…
1300		1955
1301	$term->{socket} = ...	1956	$term->{socket} = ...
1302	$term->{iow} = urxvt::iow	1957	$term->{iow} = urxvt::iow
1303	->new	1958	->new
1304	->fd (fileno $term->{socket})	1959	->fd (fileno $term->{socket})
1305	->events (1) # wait for read data	1960	->events (urxvt::EV_READ)
1306	->start	1961	->start
1307	->cb (sub {	1962	->cb (sub {
1308	my ($iow, $revents) = @_;	1963	my ($iow, $revents) = @_;
1309	# $revents must be 1 here, no need to check	1964	# $revents must be 1 here, no need to check
1310	sysread $term->{socket}, my $buf, 8192	1965	sysread $term->{socket}, my $buf, 8192
…		…
1323	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>
1324	is a bitset as described in the C<events> method.	1979	is a bitset as described in the C<events> method.
1325		1980
1326	=item $iow = $iow->fd ($fd)	1981	=item $iow = $iow->fd ($fd)
1327		1982
1328	Set the filedescriptor (not handle) to watch.	1983	Set the file descriptor (not handle) to watch.
1329		1984
1330	=item $iow = $iow->events ($eventmask)	1985	=item $iow = $iow->events ($eventmask)
1331		1986
1332	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1987	Set the event mask to watch. The only allowed values are
1333	data, Bit #1 (value C<2>) enables watching for write data.	1988	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
		1989	together, or C<urxvt::EV_NONE>.
1334		1990
1335	=item $iow = $iow->start	1991	=item $iow = $iow->start
1336		1992
1337	Start watching for requested events on the given handle.	1993	Start watching for requested events on the given handle.
1338		1994
1339	=item $iow = $iow->stop	1995	=item $iow = $iow->stop
1340		1996
1341	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.
1342		2059
1343	=back	2060	=back
1344		2061
1345	=head1 ENVIRONMENT	2062	=head1 ENVIRONMENT
1346		2063
…		…
1353		2070
1354	=item == 0 - fatal messages	2071	=item == 0 - fatal messages
1355		2072
1356	=item >= 3 - script loading and management	2073	=item >= 3 - script loading and management
1357		2074
1358	=item >=10 - all events received	2075	=item >=10 - all called hooks
		2076
		2077	=item >=11 - hook return values
1359		2078
1360	=back	2079	=back
1361		2080
1362	=head1 AUTHOR	2081	=head1 AUTHOR
1363		2082
1364	Marc Lehmann <pcg@goof.com>	2083	Marc Lehmann <schmorp@schmorp.de>
1365	http://software.schmorp.de/pkg/rxvt-unicode	2084	http://software.schmorp.de/pkg/rxvt-unicode
1366		2085
1367	=cut	2086	=cut
1368		2087
1369	1	2088	1
		2089
		2090	# vim: sw=3:

Diff Legend

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