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.92 by root, Fri Jan 13 04:59:04 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	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed
		38	using F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	@@RXVT_NAME@@ -pe <extensionname>
39		43
40	=over 4	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	=item selection (enabled by default)	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	Extensions that add command line parameters or resources on their own are
45	when the user extends selections (double-click and further clicks). Right	49	loaded automatically when used.
46	now, it tries to select words, urls and complete shell-quoted
47	arguments, which is very convenient, too, if your F<ls> supports
48	C<--quoting-style=shell>.
49
50	A double-click usually selects the word under the cursor, further clicks
51	will enlarge the selection.
52
53	The selection works by trying to match a number of regexes and displaying
54	them in increasing order of length. You can add your own regexes by
55	specifying resources of the form:
56
57	URxvt.selection.pattern-0: perl-regex
58	URxvt.selection.pattern-1: perl-regex
59	...
60
61	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:
65
66	URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.
70
71	This extension also offers the following bindable keyboard command:
72
73	=over 4
74
75	=item rot13
76
77	Rot-13 the selection when activated. Used via keyboard trigger:
78
79	URxvt.keysym.C-M-r: perl:selection:rot13
80
81	=back
82
83	=item option-popup (enabled by default)
84
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.
87
88	=item selection-popup (enabled by default)
89
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.
93
94	=item searchable-scrollback<hotkey> (enabled by default)
95
96	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
98	input/output is suspended and a regex is displayed at the bottom of the
99	screen.
100
101	Inputting characters appends them to the regex and continues incremental
102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
104	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary
107	selection.
108
109	=item selection-autotransform
110
111	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.
113
114	It works by specifying perl snippets (most useful is a single C<s///>
115	operator) that modify C<$_> as resources:
116
117	URxvt.selection-autotransform.0: transform
118	URxvt.selection-autotransform.1: transform
119	...
120
121	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:
124
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126
127	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:
129
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131
132	Of course, this can be modified to suit your needs and your editor :)
133
134	To expand the example above to typical perl error messages ("XXX at
135	FILENAME line YYY."), you need a slightly more elaborate solution:
136
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
139
140	The first line tells the selection code to treat the unchanging part of
141	every error message as a selection pattern, and the second line transforms
142	the message into vi commands to load the file.
143
144	=item mark-urls
145
146	Uses per-line display filtering (C<on_line_update>) to underline urls and
147	make them clickable. When middle-clicked, the program specified in the
148	resource C<urlLauncher> (default C<x-www-browser>) will be started with
149	the URL as first argument.
150
151	=item block-graphics-to-ascii
152
153	A not very useful example of filtering all text output to the terminal,
154	by replacing all line-drawing characters (U+2500 .. U+259F) by a
155	similar-looking ascii character.
156
157	=item digital-clock
158
159	Displays a digital clock using the built-in overlay.
160
161	=item example-refresh-hooks
162
163	Displays a very simple digital clock in the upper right corner of the
164	window. Illustrates overwriting the refresh callbacks to create your own
165	overlays or changes.
166
167	=back
168		50
169	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
170		52
171	=head2 General API Considerations	53	=head2 General API Considerations
172		54
…		…
186		68
187	=over 4	69	=over 4
188		70
189	=item $text	71	=item $text
190		72
191	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
192	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.
193		75
194	=item $string	76	=item $string
195		77
196	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
…		…
200	=item $octets	82	=item $octets
201		83
202	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
203	locale-specific way.	85	locale-specific way.
204		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
205	=back	93	=back
206		94
207	=head2 Extension Objects	95	=head2 Extension Objects
208		96
209	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
210	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,
211	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
212	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
213	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
214	use.	103	internal use.
215		104
216	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
217	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
218		107
219	It has the following methods and data members:	108	It has the following methods and data members:
…		…
223	=item $urxvt_term = $self->{term}	112	=item $urxvt_term = $self->{term}
224		113
225	Returns the C<urxvt::term> object associated with this instance of the	114	Returns the C<urxvt::term> object associated with this instance of the
226	extension. This member I<must not> be changed in any way.	115	extension. This member I<must not> be changed in any way.
227		116
228	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	117	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
229		118
230	Dynamically enable the given hooks (named without the C<on_> prefix) for	119	Dynamically enable the given hooks (named without the C<on_> prefix) for
231	this extension, replacing any previous hook. This is useful when you want	120	this extension, replacing any previous hook. This is useful when you want
232	to overwrite time-critical hooks only temporarily.	121	to overwrite time-critical hooks only temporarily.
233		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
234	=item $self->disable ($hook_name[, $hook_name..])	126	=item $self->disable ($hook_name[, $hook_name..])
235		127
236	Dynamically disable the given hooks.	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.
237		137
238	=back	138	=back
239		139
240	=head2 Hooks	140	=head2 Hooks
241		141
242	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
243	called whenever the relevant event happens.	143	called whenever the relevant event happens.
244		144
245	The first argument passed to them is an extension oject as described in	145	The first argument passed to them is an extension object as described in
246	the in the C<Extension Objects> section.	146	the in the C<Extension Objects> section.
247		147
248	B<All> of these hooks must return a boolean value. If it is true, then the	148	B<All> of these hooks must return a boolean value. If any of the called
249	event counts as being I<consumed>, and the invocation of other hooks is	149	hooks returns true, then the event counts as being I<consumed>, and the
250	skipped, 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.
251		151
252	I<< When in doubt, return a false value (preferably C<()>). >>	152	I<< When in doubt, return a false value (preferably C<()>). >>
253		153
254	=over 4	154	=over 4
255		155
256	=item on_init $term	156	=item on_init $term
257		157
258	Called after a new terminal object has been initialized, but before	158	Called after a new terminal object has been initialized, but before
259	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
260	call or deliver senseless data, as terminal size and other characteristics	160	call or deliver senseless data, as terminal size and other characteristics
261	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
262	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).
263		174
264	=item on_reset $term	175	=item on_reset $term
265		176
266	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
267	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
268	variables.	179	variables.
269		180
270	=item on_start $term	181	=item on_child_start $term, $pid
271		182
272	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.
273	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>.
274		189
275	=item on_sel_make $term, $eventtime	190	=item on_sel_make $term, $eventtime
276		191
277	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
278	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
…		…
285		200
286	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
287	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
288	by calling C<< $term->selection >>.	203	by calling C<< $term->selection >>.
289		204
290	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.
291		206
292	=item on_sel_extend $term	207	=item on_sel_extend $term
293		208
294	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
295	click) and is either supposed to return false (normal operation), or	210	click) and is either supposed to return false (normal operation), or
296	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
297	processing. This can happen multiple times, as long as the callback	212	processing. This can happen multiple times, as long as the callback
298	returns true, it will be called on every further click by the user and is	213	returns true, it will be called on every further click by the user and is
299	supposed to enlarge the selection more and more, if possible.	214	supposed to enlarge the selection more and more, if possible.
300		215
301	See the F<selection> example extension.	216	See the F<selection> example extension.
302		217
303	=item on_view_change $term, $offset	218	=item on_view_change $term, $offset
304		219
305	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
306	scrolls. Offset C<0> means display the normal terminal, positive values	221	scrolls. Offset C<0> means display the normal terminal, positive values
307	show this many lines of scrollback.	222	show this many lines of scrollback.
308		223
309	=item on_scroll_back $term, $lines, $saved	224	=item on_scroll_back $term, $lines, $saved
310		225
…		…
314		229
315	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,
316	$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
317	number of lines that will be in the scrollback buffer.	232	number of lines that will be in the scrollback buffer.
318		233
319	=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
320		245
321	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	246	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
322	operating system command) is processed. Cursor position and other state	247	operating system command) is processed. Cursor position and other state
323	information is up-to-date when this happens. For interoperability, the	248	information is up-to-date when this happens. For interoperability, the
324	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,
325	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
326	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	}
327		262
328	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,
329	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
330	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.
331		269
332	=item on_add_lines $term, $string	270	=item on_add_lines $term, $string
333		271
334	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
335	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
…		…
340	=item on_tt_write $term, $octets	278	=item on_tt_write $term, $octets
341		279
342	Called whenever some data is written to the tty/pty and can be used to	280	Called whenever some data is written to the tty/pty and can be used to
343	suppress or filter tty input.	281	suppress or filter tty input.
344		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
345	=item on_line_update $term, $row	290	=item on_line_update $term, $row
346		291
347	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
348	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
349	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,
…		…
356	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
357	you cannot just toggle rendition bits, but only set them.	302	you cannot just toggle rendition bits, but only set them.
358		303
359	=item on_refresh_begin $term	304	=item on_refresh_begin $term
360		305
361	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
362	or similar effects by modify terminal contents in refresh_begin, and	307	similar effects by modifying the terminal contents in refresh_begin, and
363	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
364	code is run after this hook, and takes precedence.	309	code is run after this hook, and takes precedence.
365		310
366	=item on_refresh_end $term	311	=item on_refresh_end $term
367		312
368	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>.
369		314
370	=item on_keyboard_command $term, $string	315	=item on_user_command $term, $string
371		316
372	Called whenever the user presses a key combination that has a	317	Called whenever a user-configured event is being activated (e.g. via
373	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>
374	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.
375		336
376	=item on_x_event $term, $event	337	=item on_x_event $term, $event
377		338
378	Called on every X event received on the vt window (and possibly other	339	Called on every X event received on the vt window (and possibly other
379	windows). Should only be used as a last resort. Most event structure	340	windows). Should only be used as a last resort. Most event structure
380	members are not passed.	341	members are not passed.
381		342
		343	=item on_root_event $term, $event
		344
		345	Like C<on_x_event>, but is called for events on the root window.
		346
382	=item on_focus_in $term	347	=item on_focus_in $term
383		348
384	Called whenever the window gets the keyboard focus, before rxvt-unicode	349	Called whenever the window gets the keyboard focus, before rxvt-unicode
385	does focus in processing.	350	does focus in processing.
386		351
387	=item on_focus_out $term	352	=item on_focus_out $term
388		353
389	Called wheneever the window loses keyboard focus, before rxvt-unicode does	354	Called whenever the window loses keyboard focus, before rxvt-unicode does
390	focus out processing.	355	focus out processing.
391		356
		357	=item on_configure_notify $term, $event
		358
		359	=item on_property_notify $term, $event
		360
392	=item on_key_press $term, $event, $keysym, $octets	361	=item on_key_press $term, $event, $keysym, $octets
393		362
394	=item on_key_release $term, $event, $keysym	363	=item on_key_release $term, $event, $keysym
395		364
396	=item on_button_press $term, $event	365	=item on_button_press $term, $event
…		…
401		370
402	=item on_map_notify $term, $event	371	=item on_map_notify $term, $event
403		372
404	=item on_unmap_notify $term, $event	373	=item on_unmap_notify $term, $event
405		374
406	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
407	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.
408		377
409	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
410	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
411	and column under the mouse cursor.	380	(real, not screen-based) row and column under the mouse cursor.
412		381
413	C<on_key_press> additionally receives the string rxvt-unicode would	382	C<on_key_press> additionally receives the string rxvt-unicode would
414	output, if any, in locale-specific encoding.	383	output, if any, in locale-specific encoding.
415		384
416	subwindow.	385	subwindow.
417		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
418	=back	400	=back
419		401
420	=cut	402	=cut
421		403
422	package urxvt;	404	package urxvt;
423		405
424	use utf8;	406	use utf8;
425	use strict;	407	use strict 'vars';
426	use Carp ();	408	use Carp ();
427	use Scalar::Util ();	409	use Scalar::Util ();
428	use List::Util ();	410	use List::Util ();
429		411
430	our $VERSION = 1;	412	our $VERSION = 1;
431	our $TERM;	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.
432	our @HOOKNAME;	416	our @HOOKNAME;
433	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
434	our %OPTION;	418	our %OPTION;
435		419
436	our $LIBDIR;	420	our $LIBDIR;
437	our $RESNAME;	421	our $RESNAME;
438	our $RESCLASS;	422	our $RESCLASS;
439	our $RXVTNAME;	423	our $RXVTNAME;
440		424
		425	our $NOCHAR = chr 0xffff;
		426
441	=head2 Variables in the C<urxvt> Package	427	=head2 Variables in the C<urxvt> Package
442		428
443	=over 4	429	=over 4
444		430
445	=item $urxvt::LIBDIR	431	=item $urxvt::LIBDIR
…		…
458	=item $urxvt::TERM	444	=item $urxvt::TERM
459		445
460	The current terminal. This variable stores the current C<urxvt::term>	446	The current terminal. This variable stores the current C<urxvt::term>
461	object, whenever a callback/hook is executing.	447	object, whenever a callback/hook is executing.
462		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
463	=back	465	=back
464		466
465	=head2 Functions in the C<urxvt> Package	467	=head2 Functions in the C<urxvt> Package
466		468
467	=over 4	469	=over 4
468		470
469	=item urxvt::fatal $errormessage	471	=item urxvt::fatal $errormessage
470		472
471	Fatally aborts execution with the given error message. Avoid at all	473	Fatally aborts execution with the given error message (which should
472	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
473	starts up.	475	is acceptable (and useful) is in the init hook, where it prevents the
		476	terminal from starting up.
474		477
475	=item urxvt::warn $string	478	=item urxvt::warn $string
476		479
477	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
478	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
479	that calls this function.	482	that calls this function.
480		483
481	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
482	correct place, e.g. on stderr of the connecting urxvtc client.	485	correct place, e.g. on stderr of the connecting urxvtc client.
483		486
484	Messages have a size limit of 1023 bytes currently.	487	Messages have a size limit of 1023 bytes currently.
485		488
486	=item $is_safe = urxvt::safe	489	=item @terms = urxvt::termlist
487		490
488	Returns true when it is safe to do potentially unsafe things, such as	491	Returns all urxvt::term objects that exist in this process, regardless of
489	evaluating perl code specified by the user. This is true when urxvt was	492	whether they are started, being destroyed etc., so be careful. Only term
490	started setuid or setgid.	493	objects that have perl extensions attached will be returned (because there
		494	is no urxvt::term object associated with others).
491		495
492	=item $time = urxvt::NOW	496	=item $time = urxvt::NOW
493		497
494	Returns the "current time" (as per the event loop).	498	Returns the "current time" (as per the event loop).
495		499
…		…
538		542
539	=item $rend = urxvt::OVERLAY_RSTYLE	543	=item $rend = urxvt::OVERLAY_RSTYLE
540		544
541	Return the rendition mask used for overlays by default.	545	Return the rendition mask used for overlays by default.
542		546
543	=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
544		549
545	Return the bit that enabled bold, italic, blink, reverse-video and	550	Return the bit that enabled bold, italic, blink, reverse-video and
546	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
547	the bitset.	552	the bitset.
548		553
…		…
554		559
555	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	560	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
556		561
557	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	562	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
558		563
		564	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		565
559	Replace the foreground/background colour in the rendition mask with the	566	Replace the foreground/background colour in the rendition mask with the
560	specified one.	567	specified one.
561		568
562	=item $value = urxvt::GET_CUSTOM $rend	569	=item $value = urxvt::GET_CUSTOM $rend
563		570
…		…
572	=back	579	=back
573		580
574	=cut	581	=cut
575		582
576	BEGIN {	583	BEGIN {
577	urxvt->bootstrap;
578
579	# overwrite perl's warn	584	# overwrite perl's warn
580	*CORE::GLOBAL::warn = sub {	585	*CORE::GLOBAL::warn = sub {
581	my $msg = join "", @_;	586	my $msg = join "", @_;
582	$msg .= "\n"	587	$msg .= "\n"
583	unless $msg =~ /\n$/;	588	unless $msg =~ /\n$/;
584	urxvt::warn ($msg);	589	urxvt::warn ($msg);
585	};	590	};
		591	}
586		592
587	# %ENV is the original startup environment	593	no warnings 'utf8';
588	delete $ENV{IFS};	594
589	delete $ENV{CDPATH};	595	sub parse_resource {
590	delete $ENV{BASH_ENV};	596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
591	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	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	}
592	}	653	}
593		654
594	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	655	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
595		656
596	sub verbose {	657	sub verbose {
597	my ($level, $msg) = @_;	658	my ($level, $msg) = @_;
598	warn "$msg\n" if $level <= $verbosity;	659	warn "$msg\n" if $level <= $verbosity;
599	}	660	}
600		661
601	my $extension_pkg = "extension0000";
602	my %extension_pkg;	662	my %extension_pkg;
603		663
604	# load a single script into its own package, once only	664	# load a single script into its own package, once only
605	sub extension_package($) {	665	sub extension_package($) {
606	my ($path) = @_;	666	my ($path) = @_;
607		667
608	$extension_pkg{$path} ||= do {	668	$extension_pkg{$path} ||= do {
609	my $pkg = "urxvt::" . ($extension_pkg++);	669	$path =~ /([^\/\\]+)$/;
		670	my $pkg = $1;
		671	$pkg =~ s/[^[:word:]]/_/g;
		672	$pkg = "urxvt::ext::$pkg";
610		673
611	verbose 3, "loading extension '$path' into package '$pkg'";	674	verbose 3, "loading extension '$path' into package '$pkg'";
		675
		676	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
612		677
613	open my $fh, "<:raw", $path	678	open my $fh, "<:raw", $path
614	or die "$path: $!";	679	or die "$path: $!";
615		680
616	my $source = untaint	681	my $source =
617	"package $pkg; use strict; use utf8;\n"	682	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
618	. "use base urxvt::term::extension::;\n"
619	. "#line 1 \"$path\"\n{\n"	683	. "#line 1 \"$path\"\n{\n"
620	. (do { local $/; <$fh> })	684	. (do { local $/; <$fh> })
621	. "\n};\n1";	685	. "\n};\n1";
622		686
623	eval $source	687	eval $source
…		…
633	sub invoke {	697	sub invoke {
634	local $TERM = shift;	698	local $TERM = shift;
635	my $htype = shift;	699	my $htype = shift;
636		700
637	if ($htype == 0) { # INIT	701	if ($htype == 0) { # INIT
638	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	702	my @dirs = $TERM->perl_libdirs;
639		703
640	my %ext_arg;	704	my %ext_arg;
641		705
		706	{
		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	}
		714
		715	for (
		716	@{ delete $TERM->{perl_ext_3} },
642	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	717	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		718	) {
643	if ($_ eq "default") {	719	if ($_ eq "default") {
644	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	720	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
645	} elsif (/^-(.*)$/) {	721	} elsif (/^-(.*)$/) {
646	delete $ext_arg{$1};	722	delete $ext_arg{$1};
647	} elsif (/^([^<]+)<(.*)>$/) {	723	} elsif (/^([^<]+)<(.*)>$/) {
648	push @{ $ext_arg{$1} }, $2;	724	push @{ $ext_arg{$1} }, $2;
649	} else {	725	} else {
650	$ext_arg{$_} ||= [];	726	$ext_arg{$_} ||= [];
651	}	727	}
652	}	728	}
653		729
654	while (my ($ext, $argv) = each %ext_arg) {	730	for my $ext (sort keys %ext_arg) {
655	my @files = grep -f $_, map "$_/$ext", @dirs;	731	my @files = grep -f $_, map "$_/$ext", @dirs;
656		732
657	if (@files) {	733	if (@files) {
658	$TERM->register_package (extension_package $files[0], $argv);	734	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
659	} else {	735	} else {
660	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";
661	}	737	}
662	}	738	}
663		739
…		…
669		745
670	if (my $cb = $TERM->{_hook}[$htype]) {	746	if (my $cb = $TERM->{_hook}[$htype]) {
671	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
672	if $verbosity >= 10;	748	if $verbosity >= 10;
673		749
674	keys %$cb;	750	for my $pkg (keys %$cb) {
675
676	while (my ($pkg, $cb) = each %$cb) {
677	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	751	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
678	and last;	752	$retval ||= $retval_;
679		753
680	if ($@) {	754	if ($@) {
681	$TERM->ungrab; # better to lose the grab than the session	755	$TERM->ungrab; # better to lose the grab than the session
682	warn $@;	756	warn $@;
683	}	757	}
…		…
696	}	770	}
697		771
698	$retval	772	$retval
699	}	773	}
700		774
701	sub exec_async(@) {	775	sub SET_COLOR($$$) {
702	my $pid = fork;	776	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
703
704	return
705	if !defined $pid or $pid;
706
707	%ENV = %{ $TERM->env };
708
709	exec @_;
710	_exit 255;
711	}	777	}
712		778
713	# urxvt::term::extension	779	sub rend2mask {
		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	}
714		803
715	package urxvt::term::extension;	804	package urxvt::term::extension;
716		805
717	sub enable {	806	sub enable {
718	my ($self, %hook) = @_;	807	my ($self, %hook) = @_;
…		…
773		862
774	sub urxvt::destroy_hook(&) {	863	sub urxvt::destroy_hook(&) {
775	bless \shift, urxvt::destroy_hook::	864	bless \shift, urxvt::destroy_hook::
776	}	865	}
777		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
778	package urxvt::anyevent;	879	package urxvt::anyevent;
779		880
780	=head2 The C<urxvt::anyevent> Class	881	=head2 The C<urxvt::anyevent> Class
781		882
782	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
783	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
784	further programming. The only exception is that you cannot wait on	885	further programming. The only exception is that you cannot wait on
785	condition variables, but non-blocking condvar use is ok. What this means	886	condition variables, but non-blocking condvar use is ok.
786	is that you cannot use blocking APIs, but the non-blocking variant should	887
787	work.	888	In practical terms this means is that you cannot use blocking APIs, but
		889	the non-blocking variant should work.
788		890
789	=cut	891	=cut
790		892
791	our $VERSION = 1;	893	our $VERSION = '5.23';
792		894
793	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	895	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
794	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	896	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
795		897
796	sub timer {	898	sub timer {
…		…
798		900
799	my $cb = $arg{cb};	901	my $cb = $arg{cb};
800		902
801	urxvt::timer	903	urxvt::timer
802	->new	904	->new
803	->start (urxvt::NOW + $arg{after})	905	->after ($arg{after}, $arg{interval})
804	->cb (sub {	906	->cb ($arg{interval} ? $cb : sub {
805	$_[0]->stop; # need to cancel manually	907	$_[0]->stop; # need to cancel manually
806	$cb->();	908	$cb->();
807	})	909	})
808	}	910	}
809		911
810	sub io {	912	sub io {
811	my ($class, %arg) = @_;	913	my ($class, %arg) = @_;
812		914
813	my $cb = $arg{cb};	915	my $cb = $arg{cb};
		916	my $fd = fileno $arg{fh};
		917	defined $fd or $fd = $arg{fh};
814		918
815	bless [$arg{fh}, urxvt::iow	919	bless [$arg{fh}, urxvt::iow
816	->new	920	->new
817	->fd (fileno $arg{fh})	921	->fd ($fd)
818	->events (($arg{poll} =~ /r/ ? 1 : 0)	922	->events (($arg{poll} =~ /r/ ? 1 : 0)
819	| ($arg{poll} =~ /w/ ? 2 : 0))	923	| ($arg{poll} =~ /w/ ? 2 : 0))
820	->start	924	->start
821	->cb (sub {	925	->cb ($cb)
822	$cb->(($_[1] & 1 ? 'r' : '')
823	. ($_[1] & 2 ? 'w' : ''));
824	})],
825	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	})
826	}	952	}
827		953
828	sub DESTROY {	954	sub DESTROY {
829	$_[0][1]->stop;	955	$_[0][1]->stop;
830	}	956	}
831		957
832	sub condvar {	958	# only needed for AnyEvent < 6 compatibility
833	bless \my $flag, urxvt::anyevent::condvar::	959	sub one_event {
834	}
835
836	sub urxvt::anyevent::condvar::broadcast {
837	${$_[0]}++;
838	}
839
840	sub urxvt::anyevent::condvar::wait {
841	unless (${$_[0]}) {
842	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";
843	}
844	}	961	}
845		962
846	package urxvt::term;	963	package urxvt::term;
847		964
848	=head2 The C<urxvt::term> Class	965	=head2 The C<urxvt::term> Class
…		…
854	# find on_xxx subs in the package and register them	971	# find on_xxx subs in the package and register them
855	# as hooks	972	# as hooks
856	sub register_package {	973	sub register_package {
857	my ($self, $pkg, $argv) = @_;	974	my ($self, $pkg, $argv) = @_;
858		975
		976	no strict 'refs';
		977
		978	urxvt::verbose 6, "register package $pkg to $self";
		979
		980	@{"$pkg\::ISA"} = urxvt::term::extension::;
		981
859	my $proxy = bless {	982	my $proxy = bless {
860	_pkg => $pkg,	983	_pkg => $pkg,
		984	_name => ${"$pkg\::_NAME"}, # hackish
861	argv => $argv,	985	argv => $argv,
862	}, $pkg;	986	}, $pkg;
863	Scalar::Util::weaken ($proxy->{term} = $self);	987	Scalar::Util::weaken ($proxy->{term} = $self);
864		988
865	$self->{_pkg}{$pkg} = $proxy;	989	$self->{_pkg}{$pkg} = $proxy;
866		990
…		…
869	$proxy->enable ($name => $ref);	993	$proxy->enable ($name => $ref);
870	}	994	}
871	}	995	}
872	}	996	}
873		997
		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	}
		1005
		1006	sub scan_meta {
		1007	my ($self) = @_;
		1008	my @libdirs = perl_libdirs $self;
		1009
		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
874	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1045	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
875		1046
876	Creates a new terminal, very similar as if you had started it with system	1047	Creates a new terminal, very similar as if you had started it with system
877	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1048	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
878	hash which defines the environment of the new terminal.	1049	hash which defines the environment of the new terminal.
879		1050
880	Croaks (and probably outputs an error message) if the new instance	1051	Croaks (and probably outputs an error message) if the new instance
881	couldn't be created. Returns C<undef> if the new instance didn't	1052	couldn't be created. Returns C<undef> if the new instance didn't
882	initialise perl, and the terminal object otherwise. The C<init> and	1053	initialise perl, and the terminal object otherwise. The C<init> and
883	C<start> hooks will be called during this call.	1054	C<start> hooks will be called before this call returns, and are free to
		1055	refer to global data (which is race free).
884		1056
885	=cut	1057	=cut
886		1058
887	sub new {	1059	sub new {
888	my ($class, $env, @args) = @_;	1060	my ($class, $env, @args) = @_;
889		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
890	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1065	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
891	}	1066	}
892		1067
893	=item $term->destroy	1068	=item $term->destroy
894		1069
895	Destroy the terminal object (close the window, free resources	1070	Destroy the terminal object (close the window, free resources
896	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1071	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
897	watchers (timers, io watchers) are still active.	1072	watchers (timers, io watchers) are still active.
898		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	}
		1141
899	=item $isset = $term->option ($optval[, $set])	1142	=item $isset = $term->option ($optval[, $set])
900		1143
901	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
902	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
903	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.
904		1147
905	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
906	source file F</src/optinc.h> to see the actual list:	1149	source file F</src/optinc.h> to see the actual list:
907		1150
908	borderLess console cursorBlink cursorUnderline hold iconic insecure	1151	borderLess buffered console cursorBlink cursorUnderline hold iconic
909	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1152	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1153	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
910	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1154	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
911	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1155	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
912	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1156	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
913	tripleclickwords utmpInhibit visualBell	1157	urgentOnBell utmpInhibit visualBell
914		1158
915	=item $value = $term->resource ($name[, $newval])	1159	=item $value = $term->resource ($name[, $newval])
916		1160
917	Returns the current resource value associated with a given name and	1161	Returns the current resource value associated with a given name and
918	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>
…		…
927	likely change).	1171	likely change).
928		1172
929	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
930	terminal is destroyed, so changing options frequently will eat memory.	1174	terminal is destroyed, so changing options frequently will eat memory.
931		1175
932	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
933	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>
934	to see the actual list:	1178	to see the actual list:
935		1179
936	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1180	answerbackstring backgroundPixmap backspace_key blurradius
937	borderLess color cursorBlink cursorUnderline cutchars delete_key	1181	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
938	display_name embed ext_bwidth fade font geometry hold iconName	1182	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
939	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
940	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1185	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
941	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1186	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
942	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1187	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
943	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1188	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
944	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1189	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
945	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1190	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
946	shade term_name title transparent transparent_all tripleclickwords	1191	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1192	term_name title transient_for transparent tripleclickwords urgentOnBell
947	utmpInhibit visualBell	1193	utmpInhibit visualBell
948		1194
949	=cut	1195	=cut
950		1196
951	sub resource($$;$) {	1197	sub resource($$;$) {
952	my ($self, $name) = (shift, shift);	1198	my ($self, $name) = (shift, shift);
953	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1199	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
954	&urxvt::term::_resource	1200	goto &urxvt::term::_resource
955	}	1201	}
956		1202
957	=item $value = $term->x_resource ($pattern)	1203	=item $value = $term->x_resource ($pattern)
958		1204
959	Returns the X-Resource for the given pattern, excluding the program or	1205	Returns the X-Resource for the given pattern, excluding the program or
960	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1206	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
961	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1207	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
962	resource with that pattern exists.	1208	resource with that pattern exists.
963		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
964	This method should only be called during the C<on_start> hook, as there is	1220	This method should only be called during the C<on_start> hook, as there is
965	only one resource database per display, and later invocations might return	1221	only one resource database per display, and later invocations might return
966	the wrong resources.	1222	the wrong resources.
967		1223
968	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1224	=item $value = $term->x_resource_boolean ($pattern)
969		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
970	Adds a keymap translation exactly as specified via a resource. See the	1242	Adds a key binding exactly as specified via a resource. See the
971	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	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.
972		1251
973	=item $rend = $term->rstyle ([$new_rstyle])	1252	=item $rend = $term->rstyle ([$new_rstyle])
974		1253
975	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
976	the terminal application will use this style.	1255	the terminal application will use this style.
…		…
984		1263
985	=item ($row, $col) = $term->selection_beg ([$row, $col])	1264	=item ($row, $col) = $term->selection_beg ([$row, $col])
986		1265
987	=item ($row, $col) = $term->selection_end ([$row, $col])	1266	=item ($row, $col) = $term->selection_end ([$row, $col])
988		1267
989	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.
990	and optionally set them to new values.	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.
991		1277
992	=item $term->selection_make ($eventtime[, $rectangular])	1278	=item $term->selection_make ($eventtime[, $rectangular])
993		1279
994	Tries to make a selection as set by C<selection_beg> and	1280	Tries to make a selection as set by C<selection_beg> and
995	C<selection_end>. If C<$rectangular> is true (default: false), a	1281	C<selection_end>. If C<$rectangular> is true (default: false), a
996	rectangular selection will be made. This is the prefered function to make	1282	rectangular selection will be made. This is the preferred function to make
997	a selection.	1283	a selection.
998		1284
999	=item $success = $term->selection_grab ($eventtime)	1285	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1000		1286
1001	Try to request the primary selection text from the server (for example, as	1287	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1288	true) selection from the server. The corresponding text can be set
1002	set by the next method). No visual feedback will be given. This function	1289	with the next method. No visual feedback will be given. This function
1003	is mostly useful from within C<on_sel_grab> hooks.	1290	is mostly useful from within C<on_sel_grab> hooks.
1004		1291
1005	=item $oldtext = $term->selection ([$newtext])	1292	=item $oldtext = $term->selection ([$newtext, $clipboard])
1006		1293
1007	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>.
		1296
		1297	=item $term->selection_clear ([$clipboard])
		1298
		1299	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1008		1300
1009	=item $term->overlay_simple ($x, $y, $text)	1301	=item $term->overlay_simple ($x, $y, $text)
1010		1302
1011	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.
1012		1304
…		…
1042		1334
1043	The methods currently supported on C<urxvt::overlay> objects are:	1335	The methods currently supported on C<urxvt::overlay> objects are:
1044		1336
1045	=over 4	1337	=over 4
1046		1338
1047	=item $overlay->set ($x, $y, $text, $rend)	1339	=item $overlay->set ($x, $y, $text[, $rend])
1048		1340
1049	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
1050	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
1051	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.
1052		1346
1053	=item $overlay->hide	1347	=item $overlay->hide
1054		1348
1055	If visible, hide the overlay, but do not destroy it.	1349	If visible, hide the overlay, but do not destroy it.
1056		1350
…		…
1126		1420
1127	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
1128	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
1129	C<on_add_lines> hook, though.	1423	C<on_add_lines> hook, though.
1130		1424
		1425	=item $term->scr_change_screen ($screen)
		1426
		1427	Switch to given screen - 0 primary, 1 secondary.
		1428
1131	=item $term->cmd_parse ($octets)	1429	=item $term->cmd_parse ($octets)
1132		1430
1133	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
1134	locale-specific encoding of the terminal and can contain command sequences	1432	locale-specific encoding of the terminal and can contain command sequences
1135	(escape codes) that will be interpreted.	1433	(escape codes) that will be interpreted.
1136		1434
1137	=item $term->tt_write ($octets)	1435	=item $term->tt_write ($octets)
1138		1436
1139	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
1140	pass characters instead of octets, you should convert your strings first	1438	pass characters instead of octets, you should convert your strings first
1141	to the locale-specific encoding using C<< $term->locale_encode >>.	1439	to the locale-specific encoding using C<< $term->locale_encode >>.
		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.
1142		1446
1143	=item $old_events = $term->pty_ev_events ([$new_events])	1447	=item $old_events = $term->pty_ev_events ([$new_events])
1144		1448
1145	Replaces the event mask of the pty watcher by the given event mask. Can	1449	Replaces the event mask of the pty watcher by the given event mask. Can
1146	be used to suppress input and output handling to the pty/tty. See the	1450	be used to suppress input and output handling to the pty/tty. See the
1147	description of C<< urxvt::timer->events >>. Make sure to always restore	1451	description of C<< urxvt::timer->events >>. Make sure to always restore
1148	the previous value.	1452	the previous value.
1149		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
1150	=item $windowid = $term->parent	1459	=item $windowid = $term->parent
1151		1460
1152	Return the window id of the toplevel window.	1461	Return the window id of the toplevel window.
1153		1462
1154	=item $windowid = $term->vt	1463	=item $windowid = $term->vt
…		…
1160	Adds the specified events to the vt event mask. Useful e.g. when you want	1469	Adds the specified events to the vt event mask. Useful e.g. when you want
1161	to receive pointer events all the times:	1470	to receive pointer events all the times:
1162		1471
1163	$term->vt_emask_add (urxvt::PointerMotionMask);	1472	$term->vt_emask_add (urxvt::PointerMotionMask);
1164		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
1165	=item $window_width = $term->width	1488	=item $window_width = $term->width
1166		1489
1167	=item $window_height = $term->height	1490	=item $window_height = $term->height
1168		1491
1169	=item $font_width = $term->fwidth	1492	=item $font_width = $term->fwidth
…		…
1182		1505
1183	=item $max_scrollback = $term->saveLines	1506	=item $max_scrollback = $term->saveLines
1184		1507
1185	=item $nrow_plus_saveLines = $term->total_rows	1508	=item $nrow_plus_saveLines = $term->total_rows
1186		1509
1187	=item $lines_in_scrollback = $term->nsaved	1510	=item $topmost_scrollback_row = $term->top_row
1188		1511
1189	Return various integers describing terminal characteristics.	1512	Return various integers describing terminal characteristics.
1190		1513
1191	=item $x_display = $term->display_id	1514	=item $x_display = $term->display_id
1192		1515
…		…
1199	=item $env = $term->env	1522	=item $env = $term->env
1200		1523
1201	Returns a copy of the environment in effect for the terminal as a hashref	1524	Returns a copy of the environment in effect for the terminal as a hashref
1202	similar to C<\%ENV>.	1525	similar to C<\%ENV>.
1203		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
1204	=cut	1536	=cut
1205		1537
1206	sub env {	1538	sub env {
1207	if (my $env = $_[0]->_env) {
1208	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1539	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1209	} else {
1210	+{ %ENV }
1211	}
1212	}	1540	}
1213		1541
1214	=item $modifiermask = $term->ModLevel3Mask	1542	=item $modifiermask = $term->ModLevel3Mask
1215		1543
1216	=item $modifiermask = $term->ModMetaMask	1544	=item $modifiermask = $term->ModMetaMask
…		…
1218	=item $modifiermask = $term->ModNumLockMask	1546	=item $modifiermask = $term->ModNumLockMask
1219		1547
1220	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
1221	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.
1222		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
1223	=item $view_start = $term->view_start ([$newvalue])	1559	=item $view_start = $term->view_start ([$newvalue])
1224		1560
1225	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
1226	C<0>, which displays the normal terminal contents. Larger values scroll	1562	C<0>, which displays the normal terminal contents. Lower values scroll
1227	this many lines into the scrollback buffer.	1563	this many lines into the scrollback buffer.
1228		1564
1229	=item $term->want_refresh	1565	=item $term->want_refresh
1230		1566
1231	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1567	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1234		1570
1235	Used after changing terminal contents to display them.	1571	Used after changing terminal contents to display them.
1236		1572
1237	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1573	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1238		1574
1239	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 >>
1240	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
1241	terminal line. The scrollback buffer starts at line C<-1> and extends to
1242	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1577	terminal line. Nothing will be returned if a nonexistent line
1243	is requested.	1578	is requested.
1244		1579
1245	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
1246	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
1247	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
1248	automatically be updated.	1583	automatically be updated.
1249		1584
1250	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
1251	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)
1252	(C<chr 65535>). Characters with combining characters and other characters	1587	characters. Characters with combining characters and other characters that
1253	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
1254	characters in the private use area.	1589	in the private use area.
1255		1590
1256	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
1257	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
1258	characters.	1593	characters.
1259		1594
…		…
1403	where one character corresponds to one screen cell. See	1738	where one character corresponds to one screen cell. See
1404	C<< $term->ROW_t >> for details.	1739	C<< $term->ROW_t >> for details.
1405		1740
1406	=item $string = $term->special_decode $text	1741	=item $string = $term->special_decode $text
1407		1742
1408	Converts rxvt-unicodes text reprsentation into a perl string. See	1743	Converts rxvt-unicodes text representation into a perl string. See
1409	C<< $term->ROW_t >> for details.	1744	C<< $term->ROW_t >> for details.
1410		1745
1411	=item $success = $term->grab_button ($button, $modifiermask)	1746	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1412		1747
		1748	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1749
1413	Registers a synchronous button grab. See the XGrabButton manpage.	1750	Register/unregister a synchronous button grab. See the XGrabButton
		1751	manpage.
1414		1752
1415	=item $success = $term->grab ($eventtime[, $sync])	1753	=item $success = $term->grab ($eventtime[, $sync])
1416		1754
1417	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1755	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1418	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1756	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1419		1757
1420	=item $term->allow_events_async	1758	=item $term->allow_events_async
1421		1759
1422	Calls XAllowEvents with AsyncBoth for the most recent grab.	1760	Calls XAllowEvents with AsyncBoth for the most recent grab.
1423		1761
…		…
1430	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1768	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1431	recent grab.	1769	recent grab.
1432		1770
1433	=item $term->ungrab	1771	=item $term->ungrab
1434		1772
1435	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
1436	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
1437	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.
1438		1810
1439	=back	1811	=back
1440		1812
1441	=cut	1813	=cut
1442		1814
…		…
1506	my ($self, $text, $cb) = @_;	1878	my ($self, $text, $cb) = @_;
1507		1879
1508	$self->add_item ({ type => "button", text => $text, activate => $cb});	1880	$self->add_item ({ type => "button", text => $text, activate => $cb});
1509	}	1881	}
1510		1882
1511	=item $popup->add_toggle ($text, $cb, $initial_value)	1883	=item $popup->add_toggle ($text, $initial_value, $cb)
1512		1884
1513	Adds a toggle/checkbox item to the popup. Teh callback gets called	1885	Adds a toggle/checkbox item to the popup. The callback gets called
1514	whenever it gets toggled, with a boolean indicating its value as its first	1886	whenever it gets toggled, with a boolean indicating its new value as its
1515	argument.	1887	first argument.
1516		1888
1517	=cut	1889	=cut
1518		1890
1519	sub add_toggle {	1891	sub add_toggle {
1520	my ($self, $text, $cb, $value) = @_;	1892	my ($self, $text, $value, $cb) = @_;
1521		1893
1522	my $item; $item = {	1894	my $item; $item = {
1523	type => "button",	1895	type => "button",
1524	text => " $text",	1896	text => " $text",
1525	value => $value,	1897	value => $value,
…		…
1544	my $env = $self->{term}->env;	1916	my $env = $self->{term}->env;
1545	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1917	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1546	delete $env->{LC_ALL};	1918	delete $env->{LC_ALL};
1547	$env->{LC_CTYPE} = $self->{term}->locale;	1919	$env->{LC_CTYPE} = $self->{term}->locale;
1548		1920
1549	urxvt::term->new ($env, $self->{term}->resource ("name"),	1921	my $term = urxvt::term->new (
1550	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1922	$env, "popup",
		1923	"--perl-lib" => "", "--perl-ext-common" => "",
		1924	"-pty-fd" => -1, "-sl" => 0,
		1925	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1551	"--transient-for" => $self->{term}->parent,	1926	"--transient-for" => $self->{term}->parent,
1552	"-display" => $self->{term}->display_id,	1927	"-display" => $self->{term}->display_id,
1553	"-pe" => "urxvt-popup")	1928	"-pe" => "urxvt-popup",
1554	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	}
1555	}	1936	}
1556		1937
1557	sub DESTROY {	1938	sub DESTROY {
1558	my ($self) = @_;	1939	my ($self) = @_;
1559		1940
1560	delete $self->{term}{_destroy}{$self};	1941	delete $self->{term}{_destroy}{$self};
1561	$self->{term}->ungrab;	1942	$self->{term}->ungrab;
1562	}	1943	}
1563		1944
1564	=back	1945	=back
		1946
		1947	=cut
		1948
		1949	package urxvt::watcher;
1565		1950
1566	=head2 The C<urxvt::timer> Class	1951	=head2 The C<urxvt::timer> Class
1567		1952
1568	This class implements timer watchers/events. Time is represented as a	1953	This class implements timer watchers/events. Time is represented as a
1569	fractional number of seconds since the epoch. Example:	1954	fractional number of seconds since the epoch. Example:
…		…
1573	->new	1958	->new
1574	->interval (1)	1959	->interval (1)
1575	->cb (sub {	1960	->cb (sub {
1576	$term->{overlay}->set (0, 0,	1961	$term->{overlay}->set (0, 0,
1577	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1962	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1578	});	1963	});
1579		1964
1580	=over 4	1965	=over 4
1581		1966
1582	=item $timer = new urxvt::timer	1967	=item $timer = new urxvt::timer
1583		1968
…		…
1586		1971
1587	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1972	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1588		1973
1589	Set the callback to be called when the timer triggers.	1974	Set the callback to be called when the timer triggers.
1590		1975
1591	=item $tstamp = $timer->at
1592
1593	Return the time this watcher will fire next.
1594
1595	=item $timer = $timer->set ($tstamp)	1976	=item $timer = $timer->set ($tstamp[, $interval])
1596		1977
1597	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).
1598		1980
1599	=item $timer = $timer->interval ($interval)	1981	=item $timer = $timer->interval ($interval)
1600		1982
1601	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
1602	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
1603	is automatically rescheduled at the given intervals.	1985	is automatically rescheduled at the given intervals.
1604		1986
1605	=item $timer = $timer->start	1987	=item $timer = $timer->start
1606		1988
1607	Start the timer.	1989	Start the timer.
1608		1990
1609	=item $timer = $timer->start ($tstamp)	1991	=item $timer = $timer->start ($tstamp[, $interval])
1610		1992
1611	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>.
1612		1999
1613	=item $timer = $timer->stop	2000	=item $timer = $timer->stop
1614		2001
1615	Stop the timer.	2002	Stop the timer.
1616		2003
…		…
1622		2009
1623	$term->{socket} = ...	2010	$term->{socket} = ...
1624	$term->{iow} = urxvt::iow	2011	$term->{iow} = urxvt::iow
1625	->new	2012	->new
1626	->fd (fileno $term->{socket})	2013	->fd (fileno $term->{socket})
1627	->events (urxvt::EVENT_READ)	2014	->events (urxvt::EV_READ)
1628	->start	2015	->start
1629	->cb (sub {	2016	->cb (sub {
1630	my ($iow, $revents) = @_;	2017	my ($iow, $revents) = @_;
1631	# $revents must be 1 here, no need to check	2018	# $revents must be 1 here, no need to check
1632	sysread $term->{socket}, my $buf, 8192	2019	sysread $term->{socket}, my $buf, 8192
…		…
1645	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>
1646	is a bitset as described in the C<events> method.	2033	is a bitset as described in the C<events> method.
1647		2034
1648	=item $iow = $iow->fd ($fd)	2035	=item $iow = $iow->fd ($fd)
1649		2036
1650	Set the filedescriptor (not handle) to watch.	2037	Set the file descriptor (not handle) to watch.
1651		2038
1652	=item $iow = $iow->events ($eventmask)	2039	=item $iow = $iow->events ($eventmask)
1653		2040
1654	Set the event mask to watch. The only allowed values are	2041	Set the event mask to watch. The only allowed values are
1655	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2042	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1656	together, or C<urxvt::EVENT_NONE>.	2043	together, or C<urxvt::EV_NONE>.
1657		2044
1658	=item $iow = $iow->start	2045	=item $iow = $iow->start
1659		2046
1660	Start watching for requested events on the given handle.	2047	Start watching for requested events on the given handle.
1661		2048
1662	=item $iow = $iow->stop	2049	=item $iow = $iow->stop
1663		2050
1664	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.
1665		2113
1666	=back	2114	=back
1667		2115
1668	=head1 ENVIRONMENT	2116	=head1 ENVIRONMENT
1669		2117
…		…
1678		2126
1679	=item >= 3 - script loading and management	2127	=item >= 3 - script loading and management
1680		2128
1681	=item >=10 - all called hooks	2129	=item >=10 - all called hooks
1682		2130
1683	=item >=11 - hook reutrn values	2131	=item >=11 - hook return values
1684		2132
1685	=back	2133	=back
1686		2134
1687	=head1 AUTHOR	2135	=head1 AUTHOR
1688		2136
1689	Marc Lehmann <pcg@goof.com>	2137	Marc Lehmann <schmorp@schmorp.de>
1690	http://software.schmorp.de/pkg/rxvt-unicode	2138	http://software.schmorp.de/pkg/rxvt-unicode
1691		2139
1692	=cut	2140	=cut
1693		2141
1694	1	2142	1
		2143
		2144	# vim: sw=3:

Diff Legend

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