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

Diff Legend

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