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.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.222 by root, Sat Jul 7 07:00:17 2012 UTC

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

Diff Legend

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