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.95 by elmex, Tue Jan 17 13:19:45 2006 UTC vs.
Revision 1.238 by root, Sun May 18 18:15:04 2014 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --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 urxvtd, 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<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	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	urxvt -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 following bindable keyboard commands:
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	=item remote-pastebin
82
83	Upload the selection as textfile to a remote site.
84
85	URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87	To set the command to upload the file set this resource:
88
89	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92	md5 sum of the selection.
93	After an successful upload the selection will be replaced by the following url
94	(the % is the placeholder for the filename):
95
96	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
97
98	=back
99
100	=item option-popup (enabled by default)
101
102	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
103	runtime.
104
105	=item selection-popup (enabled by default)
106
107	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
108	text into various other formats/action (such as uri unescaping, perl
109	evalution, web-browser starting etc.), depending on content.
110
111	=item searchable-scrollback<hotkey> (enabled by default)
112
113	Adds regex search functionality to the scrollback buffer, triggered
114	by a hotkey (default: C<M-s>). While in search mode, normal terminal
115	input/output is suspended and a regex is displayed at the bottom of the
116	screen.
117
118	Inputting characters appends them to the regex and continues incremental
119	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
120	search upwards/downwards in the scrollback buffer, C<End> jumps to the
121	bottom. C<Escape> leaves search mode and returns to the point where search
122	was started, while C<Enter> or C<Return> stay at the current position and
123	additionally stores the first match in the current line into the primary
124	selection.
125
126	=item selection-autotransform
127
128	This selection allows you to do automatic transforms on a selection
129	whenever a selection is made.
130
131	It works by specifying perl snippets (most useful is a single C<s///>
132	operator) that modify C<$_> as resources:
133
134	URxvt.selection-autotransform.0: transform
135	URxvt.selection-autotransform.1: transform
136	...
137
138	For example, the following will transform selections of the form
139	C<filename:number>, often seen in compiler messages, into C<vi +$filename
140	$word>:
141
142	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
143
144	And this example matches the same,but replaces it with vi-commands you can
145	paste directly into your (vi :) editor:
146
147	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
148
149	Of course, this can be modified to suit your needs and your editor :)
150
151	To expand the example above to typical perl error messages ("XXX at
152	FILENAME line YYY."), you need a slightly more elaborate solution:
153
154	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
155	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
156
157	The first line tells the selection code to treat the unchanging part of
158	every error message as a selection pattern, and the second line transforms
159	the message into vi commands to load the file.
160
161	=item mark-urls
162
163	Uses per-line display filtering (C<on_line_update>) to underline urls and
164	make them clickable. When middle-clicked, the program specified in the
165	resource C<urlLauncher> (default C<x-www-browser>) will be started with
166	the URL as first argument.
167
168	=item block-graphics-to-ascii
169
170	A not very useful example of filtering all text output to the terminal,
171	by replacing all line-drawing characters (U+2500 .. U+259F) by a
172	similar-looking ascii character.
173
174	=item digital-clock
175
176	Displays a digital clock using the built-in overlay.
177
178	=item example-refresh-hooks
179
180	Displays a very simple digital clock in the upper right corner of the
181	window. Illustrates overwriting the refresh callbacks to create your own
182	overlays or changes.
183
184	=back
185		50
186	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
187		52
188	=head2 General API Considerations	53	=head2 General API Considerations
189		54
…		…
203		68
204	=over 4	69	=over 4
205		70
206	=item $text	71	=item $text
207		72
208	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
209	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.
210		75
211	=item $string	76	=item $string
212		77
213	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
…		…
217	=item $octets	82	=item $octets
218		83
219	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
220	locale-specific way.	85	locale-specific way.
221		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
222	=back	93	=back
223		94
224	=head2 Extension Objects	95	=head2 Extension Objects
225		96
226	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
227	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,
228	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
229	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
230	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
231	use.	103	internal use.
232		104
233	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
234	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
235		107
236	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
237		109	the C<urxvt::extension> section below.
238	=over 4
239
240	=item $urxvt_term = $self->{term}
241
242	Returns the C<urxvt::term> object associated with this instance of the
243	extension. This member I<must not> be changed in any way.
244
245	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
246
247	Dynamically enable the given hooks (named without the C<on_> prefix) for
248	this extension, replacing any previous hook. This is useful when you want
249	to overwrite time-critical hooks only temporarily.
250
251	=item $self->disable ($hook_name[, $hook_name..])
252
253	Dynamically disable the given hooks.
254
255	=back
256		110
257	=head2 Hooks	111	=head2 Hooks
258		112
259	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
260	called whenever the relevant event happens.	114	called whenever the relevant event happens.
261		115
262	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
263	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
264		118
265	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
266	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
267	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.
268		122
269	I<< When in doubt, return a false value (preferably C<()>). >>	123	I<< When in doubt, return a false value (preferably C<()>). >>
270		124
271	=over 4	125	=over 4
272		126
273	=item on_init $term	127	=item on_init $term
274		128
275	Called after a new terminal object has been initialized, but before	129	Called after a new terminal object has been initialized, but before
276	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
277	call or deliver senseless data, as terminal size and other characteristics	131	call or deliver senseless data, as terminal size and other characteristics
278	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
279	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).
280		145
281	=item on_reset $term	146	=item on_reset $term
282		147
283	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
284	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
285	variables.	150	variables.
286		151
287	=item on_start $term	152	=item on_child_start $term, $pid
288		153
289	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.
290	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>.
291		160
292	=item on_sel_make $term, $eventtime	161	=item on_sel_make $term, $eventtime
293		162
294	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
295	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
…		…
302		171
303	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
304	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
305	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
306		175
307	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.
308		177
309	=item on_sel_extend $term	178	=item on_sel_extend $term
310		179
311	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
312	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
313	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
314	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
315	returns true, it will be called on every further click by the user and is	184	returns true, it will be called on every further click by the user and is
316	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
317		186
318	See the F<selection> example extension.	187	See the F<selection> example extension.
319		188
320	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
321		190
322	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
323	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
324	show this many lines of scrollback.	193	show this many lines of scrollback.
325		194
326	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
327		196
…		…
331		200
332	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,
333	$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
334	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
335		204
336	=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
337		216
338	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
339	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
340	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
341	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,
342	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
343	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	}
344		233
345	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,
346	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
347	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.
348		240
349	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
350		242
351	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
352	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
…		…
357	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
358		250
359	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
360	suppress or filter tty input.	252	suppress or filter tty input.
361		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
362	=item on_line_update $term, $row	261	=item on_line_update $term, $row
363		262
364	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
365	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
366	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,
…		…
373	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
374	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
375		274
376	=item on_refresh_begin $term	275	=item on_refresh_begin $term
377		276
378	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
379	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
380	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
381	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
382		281
383	=item on_refresh_end $term	282	=item on_refresh_end $term
384		283
385	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>.
386		285
387	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
388		287
389	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
390	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>
391	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
		291
		292	The event is simply the action string. This interface is going away in
		293	preference to the C<on_action> hook.
		294
		295	=item on_resize_all_windows $term, $new_width, $new_height
		296
		297	Called just after the new window size has been calculated, but before
		298	windows are actually being resized or hints are being set. If this hook
		299	returns a true value, setting of the window hints is being skipped.
392		300
393	=item on_x_event $term, $event	301	=item on_x_event $term, $event
394		302
395	Called on every X event received on the vt window (and possibly other	303	Called on every X event received on the vt window (and possibly other
396	windows). Should only be used as a last resort. Most event structure	304	windows). Should only be used as a last resort. Most event structure
397	members are not passed.	305	members are not passed.
398		306
		307	=item on_root_event $term, $event
		308
		309	Like C<on_x_event>, but is called for events on the root window.
		310
399	=item on_focus_in $term	311	=item on_focus_in $term
400		312
401	Called whenever the window gets the keyboard focus, before rxvt-unicode	313	Called whenever the window gets the keyboard focus, before rxvt-unicode
402	does focus in processing.	314	does focus in processing.
403		315
404	=item on_focus_out $term	316	=item on_focus_out $term
405		317
406	Called wheneever the window loses keyboard focus, before rxvt-unicode does	318	Called whenever the window loses keyboard focus, before rxvt-unicode does
407	focus out processing.	319	focus out processing.
408		320
		321	=item on_configure_notify $term, $event
		322
		323	=item on_property_notify $term, $event
		324
409	=item on_key_press $term, $event, $keysym, $octets	325	=item on_key_press $term, $event, $keysym, $octets
410		326
411	=item on_key_release $term, $event, $keysym	327	=item on_key_release $term, $event, $keysym
412		328
413	=item on_button_press $term, $event	329	=item on_button_press $term, $event
…		…
418		334
419	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
420		336
421	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
422		338
423	Called whenever the corresponding X event is received for the terminal If	339	Called whenever the corresponding X event is received for the terminal. If
424	the hook returns true, then the even will be ignored by rxvt-unicode.	340	the hook returns true, then the event will be ignored by rxvt-unicode.
425		341
426	The event is a hash with most values as named by Xlib (see the XEvent	342	The event is a hash with most values as named by Xlib (see the XEvent
427	manpage), with the additional members C<row> and C<col>, which are the row	343	manpage), with the additional members C<row> and C<col>, which are the
428	and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
429		345
430	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
431	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
432		348
433	subwindow.	349	=item on_client_message $term, $event
		350
		351	=item on_wm_protocols $term, $event
		352
		353	=item on_wm_delete_window $term, $event
		354
		355	Called when various types of ClientMessage events are received (all with
		356	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		357
		358	=item on_bell $term
		359
		360	Called on receipt of a bell character.
434		361
435	=back	362	=back
436		363
437	=cut	364	=cut
438		365
439	package urxvt;	366	package urxvt;
440		367
441	use utf8;	368	use utf8;
442	use strict;	369	use strict 'vars';
443	use Carp ();	370	use Carp ();
444	use Scalar::Util ();	371	use Scalar::Util ();
445	use List::Util ();	372	use List::Util ();
446		373
447	our $VERSION = 1;	374	our $VERSION = 1;
448	our $TERM;	375	our $TERM;
		376	our @TERM_INIT; # should go, prevents async I/O etc.
		377	our @TERM_EXT; # should go, prevents async I/O etc.
449	our @HOOKNAME;	378	our @HOOKNAME;
450	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451	our %OPTION;	380	our %OPTION;
452		381
453	our $LIBDIR;	382	our $LIBDIR;
454	our $RESNAME;	383	our $RESNAME;
455	our $RESCLASS;	384	our $RESCLASS;
456	our $RXVTNAME;	385	our $RXVTNAME;
457		386
		387	our $NOCHAR = chr 0xffff;
		388
458	=head2 Variables in the C<urxvt> Package	389	=head2 Variables in the C<urxvt> Package
459		390
460	=over 4	391	=over 4
461		392
462	=item $urxvt::LIBDIR	393	=item $urxvt::LIBDIR
…		…
475	=item $urxvt::TERM	406	=item $urxvt::TERM
476		407
477	The current terminal. This variable stores the current C<urxvt::term>	408	The current terminal. This variable stores the current C<urxvt::term>
478	object, whenever a callback/hook is executing.	409	object, whenever a callback/hook is executing.
479		410
		411	=item @urxvt::TERM_INIT
		412
		413	All code references in this array will be called as methods of the next newly
		414	created C<urxvt::term> object (during the C<on_init> phase). The array
		415	gets cleared before the code references that were in it are being executed,
		416	so references can push themselves onto it again if they so desire.
		417
		418	This complements to the perl-eval command line option, but gets executed
		419	first.
		420
		421	=item @urxvt::TERM_EXT
		422
		423	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		424	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		425	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		426
480	=back	427	=back
481		428
482	=head2 Functions in the C<urxvt> Package	429	=head2 Functions in the C<urxvt> Package
483		430
484	=over 4	431	=over 4
485		432
486	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
487		434
488	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
489	costs! The only time this is acceptable is when the terminal process	436	include a trailing newline). Avoid at all costs! The only time this
490	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
491		439
492	=item urxvt::warn $string	440	=item urxvt::warn $string
493		441
494	Calls C<rxvt_warn> with the given string which should not include a	442	Calls C<rxvt_warn> with the given string which should include a trailing
495	newline. The module also overwrites the C<warn> builtin with a function	443	newline. The module also overwrites the C<warn> builtin with a function
496	that calls this function.	444	that calls this function.
497		445
498	Using this function has the advantage that its output ends up in the	446	Using this function has the advantage that its output ends up in the
499	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
500		448
501	Messages have a size limit of 1023 bytes currently.	449	Messages have a size limit of 1023 bytes currently.
502		450
503	=item $is_safe = urxvt::safe	451	=item @terms = urxvt::termlist
504		452
505	Returns true when it is safe to do potentially unsafe things, such as	453	Returns all urxvt::term objects that exist in this process, regardless of
506	evaluating perl code specified by the user. This is true when urxvt was	454	whether they are started, being destroyed etc., so be careful. Only term
507	started setuid or setgid.	455	objects that have perl extensions attached will be returned (because there
		456	is no urxvt::term object associated with others).
508		457
509	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
510		459
511	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
512		461
…		…
555		504
556	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
557		506
558	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
559		508
560	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	509	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		510	urxvt::RS_RVid, urxvt::RS_Uline
561		511
562	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
563	underline, respectively. To enable such a style, just logically OR it into	513	underline, respectively. To enable such a style, just logically OR it into
564	the bitset.	514	the bitset.
565		515
…		…
571		521
572	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	522	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
573		523
574	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	524	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
575		525
		526	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		527
576	Replace the foreground/background colour in the rendition mask with the	528	Replace the foreground/background colour in the rendition mask with the
577	specified one.	529	specified one.
578		530
579	=item $value = urxvt::GET_CUSTOM $rend	531	=item $value = urxvt::GET_CUSTOM $rend
580		532
…		…
589	=back	541	=back
590		542
591	=cut	543	=cut
592		544
593	BEGIN {	545	BEGIN {
594	urxvt->bootstrap;
595
596	# overwrite perl's warn	546	# overwrite perl's warn
597	*CORE::GLOBAL::warn = sub {	547	*CORE::GLOBAL::warn = sub {
598	my $msg = join "", @_;	548	my $msg = join "", @_;
599	$msg .= "\n"	549	$msg .= "\n"
600	unless $msg =~ /\n$/;	550	unless $msg =~ /\n$/;
601	urxvt::warn ($msg);	551	urxvt::warn ($msg);
602	};	552	};
		553	}
603		554
604	# %ENV is the original startup environment	555	no warnings 'utf8';
605	delete $ENV{IFS};	556
606	delete $ENV{CDPATH};	557	sub parse_resource {
607	delete $ENV{BASH_ENV};	558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
608	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	559
		560	$name =~ y/-/./ if $isarg;
		561
		562	$term->scan_extensions;
		563
		564	my $r = $term->{meta}{resource};
		565	keys %$r; # reset iterator
		566	while (my ($pattern, $v) = each %$r) {
		567	if (
		568	$pattern =~ /\.$/
		569	? $pattern eq substr $name, 0, length $pattern
		570	: $pattern eq $name
		571	) {
		572	$name = "$urxvt::RESCLASS.$name";
		573
		574	push @{ $term->{perl_ext_3} }, $v->[0];
		575
		576	if ($v->[1] eq "boolean") {
		577	$term->put_option_db ($name, $flag ? "true" : "false");
		578	return 1;
		579	} else {
		580	$term->put_option_db ($name, $value);
		581	return 1 + 2;
		582	}
		583	}
		584	}
		585
		586	0
		587	}
		588
		589	sub usage {
		590	my ($term, $usage_type) = @_;
		591
		592	$term->scan_extensions;
		593
		594	my $r = $term->{meta}{resource};
		595
		596	for my $pattern (sort keys %$r) {
		597	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		598
		599	$desc .= " (-pe $ext)";
		600
		601	if ($usage_type == 1) {
		602	$pattern =~ y/./-/;
		603	$pattern =~ s/-$/-.../g;
		604
		605	if ($type eq "boolean") {
		606	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		607	} else {
		608	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		609	}
		610	} else {
		611	$pattern =~ s/\.$/.*/g;
		612	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		613	}
		614	}
609	}	615	}
610		616
611	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
612		618
613	sub verbose {	619	sub verbose {
614	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
615	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
616	}	622	}
617		623
618	my $extension_pkg = "extension0000";
619	my %extension_pkg;	624	my %extension_pkg;
620		625
621	# load a single script into its own package, once only	626	# load a single script into its own package, once only
622	sub extension_package($) {	627	sub extension_package($) {
623	my ($path) = @_;	628	my ($path) = @_;
624		629
625	$extension_pkg{$path} ||= do {	630	$extension_pkg{$path} ||= do {
626	my $pkg = "urxvt::" . ($extension_pkg++);	631	$path =~ /([^\/\\]+)$/;
		632	my $pkg = $1;
		633	$pkg =~ s/[^[:word:]]/_/g;
		634	$pkg = "urxvt::ext::$pkg";
627		635
628	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
		637
		638	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
629		639
630	open my $fh, "<:raw", $path	640	open my $fh, "<:raw", $path
631	or die "$path: $!";	641	or die "$path: $!";
632		642
633	my $source = untaint	643	my $source =
634	"package $pkg; use strict; use utf8;\n"	644	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
635	. "use base urxvt::term::extension::;\n"
636	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
637	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
638	. "\n};\n1";	647	. "\n};\n1";
639		648
640	eval $source	649	eval $source
…		…
649	# called by the rxvt core	658	# called by the rxvt core
650	sub invoke {	659	sub invoke {
651	local $TERM = shift;	660	local $TERM = shift;
652	my $htype = shift;	661	my $htype = shift;
653		662
654	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
655	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = $TERM->perl_libdirs;
656		665
		666	$TERM->scan_extensions;
		667
657	my %ext_arg;	668	my %ext_arg;
658		669
		670	{
		671	my @init = @TERM_INIT;
		672	@TERM_INIT = ();
		673	$_->($TERM) for @init;
		674	my @pkg = @TERM_EXT;
		675	@TERM_EXT = ();
		676	$TERM->register_package ($_) for @pkg;
		677	}
		678
		679	for (
659	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	680	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		681	) {
660	if ($_ eq "default") {	682	if ($_ eq "default") {
661	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	683
		684	$ext_arg{$_} = []
		685	for
		686	qw(selection option-popup selection-popup readline),
		687	map $_->[0], values %{ $TERM->{meta}{binding} },
		688	@{ delete $TERM->{perl_ext_3} };
		689
		690	for ($TERM->_keysym_resources) {
		691	next if /^(?:string|command|builtin|builtin-string|perl)/;
		692	next unless /^([A-Za-z0-9_\-]+):/;
		693
		694	my $ext = $1;
		695	$ext =~ y/-/_/;
		696
		697	$ext_arg{$ext} = [];
		698	}
		699
662	} elsif (/^-(.*)$/) {	700	} elsif (/^-(.*)$/) {
663	delete $ext_arg{$1};	701	delete $ext_arg{$1};
		702
664	} elsif (/^([^<]+)<(.*)>$/) {	703	} elsif (/^([^<]+)<(.*)>$/) {
665	push @{ $ext_arg{$1} }, $2;	704	push @{ $ext_arg{$1} }, $2;
		705
666	} else {	706	} else {
667	$ext_arg{$_} ||= [];	707	$ext_arg{$_} ||= [];
668	}	708	}
669	}	709	}
670		710
671	while (my ($ext, $argv) = each %ext_arg) {	711	# now register default key bindings
		712	for my $ext (sort keys %ext_arg) {
		713	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		714	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
		715	}
		716	}
		717
		718	for my $ext (sort keys %ext_arg) {
672	my @files = grep -f $_, map "$_/$ext", @dirs;	719	my @files = grep -f $_, map "$_/$ext", @dirs;
673		720
674	if (@files) {	721	if (@files) {
675	$TERM->register_package (extension_package $files[0], $argv);	722	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
676	} else {	723	} else {
677	warn "perl extension '$ext' not found in perl library search path\n";	724	warn "perl extension '$ext' not found in perl library search path\n";
678	}	725	}
679	}	726	}
680		727
…		…
686		733
687	if (my $cb = $TERM->{_hook}[$htype]) {	734	if (my $cb = $TERM->{_hook}[$htype]) {
688	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	735	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
689	if $verbosity >= 10;	736	if $verbosity >= 10;
690		737
691	keys %$cb;	738	if ($htype == HOOK_ACTION) {
		739	# this hook is only sent to the extension with the name
		740	# matching the first arg
		741	my $pkg = shift;
		742	$pkg =~ y/-/_/;
		743	$pkg = "urxvt::ext::$pkg";
692		744
693	while (my ($pkg, $cb) = each %$cb) {	745	$cb = $cb->{$pkg}
		746	or return undef; #TODO: maybe warn user?
		747
		748	$cb = { $pkg => $cb };
		749	}
		750
		751	for my $pkg (keys %$cb) {
694	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	752	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
695	and last;	753	$retval ||= $retval_;
696		754
697	if ($@) {	755	if ($@) {
698	$TERM->ungrab; # better to lose the grab than the session	756	$TERM->ungrab; # better to lose the grab than the session
699	warn $@;	757	warn $@;
700	}	758	}
…		…
702		760
703	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	761	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
704	if $verbosity >= 11;	762	if $verbosity >= 11;
705	}	763	}
706		764
707	if ($htype == 1) { # DESTROY	765	if ($htype == HOOK_DESTROY) {
708	# clear package objects	766	# clear package objects
709	%$_ = () for values %{ $TERM->{_pkg} };	767	%$_ = () for values %{ $TERM->{_pkg} };
710		768
711	# clear package	769	# clear package
712	%$TERM = ();	770	%$TERM = ();
713	}	771	}
714		772
715	$retval	773	$retval
716	}	774	}
717		775
718	sub exec_async(@) {	776	sub SET_COLOR($$$) {
719	my $pid = fork;	777	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
720
721	return
722	if !defined $pid or $pid;
723
724	%ENV = %{ $TERM->env };
725
726	exec @_;
727	_exit 255;
728	}	778	}
729		779
730	# urxvt::term::extension	780	sub rend2mask {
		781	no strict 'refs';
		782	my ($str, $mask) = (@_, 0);
		783	my %color = ( fg => undef, bg => undef );
		784	my @failed;
		785	for my $spec ( split /\s+/, $str ) {
		786	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		787	$color{lc($1)} = $2;
		788	} else {
		789	my $neg = $spec =~ s/^[-^]//;
		790	unless ( exists &{"RS_$spec"} ) {
		791	push @failed, $spec;
		792	next;
		793	}
		794	my $cur = &{"RS_$spec"};
		795	if ( $neg ) {
		796	$mask &= ~$cur;
		797	} else {
		798	$mask |= $cur;
		799	}
		800	}
		801	}
		802	($mask, @color{qw(fg bg)}, \@failed)
		803	}
731		804
732	package urxvt::term::extension;	805	package urxvt::term::extension;
733		806
734	sub enable {	807	=head2 The C<urxvt::term::extension> class
735	my ($self, %hook) = @_;
736	my $pkg = $self->{_pkg};
737		808
738	while (my ($name, $cb) = each %hook) {	809	Each extension attached to a terminal object is represented by
739	my $htype = $HOOKTYPE{uc $name};	810	a C<urxvt::term::extension> object.
740	defined $htype
741	or Carp::croak "unsupported hook type '$name'";
742		811
743	$self->set_should_invoke ($htype, +1)	812	You can use these objects, which are passed to all callbacks to store any
744	unless exists $self->{term}{_hook}[$htype]{$pkg};	813	state related to the terminal and extension instance.
745		814
746	$self->{term}{_hook}[$htype]{$pkg} = $cb;	815	The methods (And data members) documented below can be called on extension
747	}	816	objects, in addition to call methods documented for the <urxvt::term>
748	}	817	class.
749		818
750	sub disable {	819	=over 4
751	my ($self, @hook) = @_;
752	my $pkg = $self->{_pkg};
753		820
754	for my $name (@hook) {	821	=item $urxvt_term = $self->{term}
755	my $htype = $HOOKTYPE{uc $name};
756	defined $htype
757	or Carp::croak "unsupported hook type '$name'";
758		822
759	$self->set_should_invoke ($htype, -1)	823	Returns the C<urxvt::term> object associated with this instance of the
760	if delete $self->{term}{_hook}[$htype]{$pkg};	824	extension. This member I<must not> be changed in any way.
761	}	825
762	}	826	=cut
763		827
764	our $AUTOLOAD;	828	our $AUTOLOAD;
765		829
766	sub AUTOLOAD {	830	sub AUTOLOAD {
767	$AUTOLOAD =~ /:([^:]+)$/	831	$AUTOLOAD =~ /:([^:]+)$/
…		…
780		844
781	sub DESTROY {	845	sub DESTROY {
782	# nop	846	# nop
783	}	847	}
784		848
785	# urxvt::destroy_hook	849	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
786		850
787	sub urxvt::destroy_hook::DESTROY {	851	sub urxvt::destroy_hook::DESTROY {
788	${$_[0]}->();	852	${$_[0]}->();
789	}	853	}
790		854
791	sub urxvt::destroy_hook(&) {	855	sub urxvt::destroy_hook(&) {
792	bless \shift, urxvt::destroy_hook::	856	bless \shift, urxvt::destroy_hook::
793	}	857	}
		858
		859	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		860
		861	Dynamically enable the given hooks (named without the C<on_> prefix) for
		862	this extension, replacing any hook previously installed via C<enable> in
		863	this extension.
		864
		865	This is useful when you want to overwrite time-critical hooks only
		866	temporarily.
		867
		868	To install additional callbacks for the same hook, you can use the C<on>
		869	method of the C<urxvt::term> class.
		870
		871	=item $self->disable ($hook_name[, $hook_name..])
		872
		873	Dynamically disable the given hooks.
		874
		875	=cut
		876
		877	sub enable {
		878	my ($self, %hook) = @_;
		879	my $pkg = $self->{_pkg};
		880
		881	while (my ($name, $cb) = each %hook) {
		882	my $htype = $HOOKTYPE{uc $name};
		883	defined $htype
		884	or Carp::croak "unsupported hook type '$name'";
		885
		886	$self->set_should_invoke ($htype, +1)
		887	unless exists $self->{term}{_hook}[$htype]{$pkg};
		888
		889	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		890	}
		891	}
		892
		893	sub disable {
		894	my ($self, @hook) = @_;
		895	my $pkg = $self->{_pkg};
		896
		897	for my $name (@hook) {
		898	my $htype = $HOOKTYPE{uc $name};
		899	defined $htype
		900	or Carp::croak "unsupported hook type '$name'";
		901
		902	$self->set_should_invoke ($htype, -1)
		903	if delete $self->{term}{_hook}[$htype]{$pkg};
		904	}
		905	}
		906
		907	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		908
		909	Similar to the C<enable> enable, but installs additional callbacks for
		910	the given hook(s) (that is, it doesn't replace existing callbacks), and
		911	returns a guard object. When the guard object is destroyed the callbacks
		912	are disabled again.
		913
		914	=cut
		915
		916	sub urxvt::extension::on_disable::DESTROY {
		917	my $disable = shift;
		918
		919	my $term = delete $disable->{""};
		920
		921	while (my ($htype, $id) = each %$disable) {
		922	delete $term->{_hook}[$htype]{$id};
		923	$term->set_should_invoke ($htype, -1);
		924	}
		925	}
		926
		927	sub on {
		928	my ($self, %hook) = @_;
		929
		930	my $term = $self->{term};
		931
		932	my %disable = ( "" => $term );
		933
		934	while (my ($name, $cb) = each %hook) {
		935	my $htype = $HOOKTYPE{uc $name};
		936	defined $htype
		937	or Carp::croak "unsupported hook type '$name'";
		938
		939	$term->set_should_invoke ($htype, +1);
		940	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		941	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		942	}
		943
		944	bless \%disable, "urxvt::extension::on_disable"
		945	}
		946
		947	=item $self->x_resource ($pattern)
		948
		949	=item $self->x_resource_boolean ($pattern)
		950
		951	These methods support an additional C<%> prefix when called on an
		952	extension object - see the description of these methods in the
		953	C<urxvt::term> class for details.
		954
		955	=cut
		956
		957	sub x_resource {
		958	my ($self, $name) = @_;
		959	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		960	$self->{term}->x_resource ($name)
		961	}
		962
		963	sub x_resource_boolean {
		964	my ($self, $name) = @_;
		965	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		966	$self->{term}->x_resource_boolean ($name)
		967	}
		968
		969	=back
		970
		971	=cut
794		972
795	package urxvt::anyevent;	973	package urxvt::anyevent;
796		974
797	=head2 The C<urxvt::anyevent> Class	975	=head2 The C<urxvt::anyevent> Class
798		976
799	The sole purpose of this class is to deliver an interface to the	977	The sole purpose of this class is to deliver an interface to the
800	C<AnyEvent> module - any module using it will work inside urxvt without	978	C<AnyEvent> module - any module using it will work inside urxvt without
801	further programming. The only exception is that you cannot wait on	979	further programming. The only exception is that you cannot wait on
802	condition variables, but non-blocking condvar use is ok. What this means	980	condition variables, but non-blocking condvar use is ok.
803	is that you cannot use blocking APIs, but the non-blocking variant should
804	work.
805		981
806	=cut	982	In practical terms this means is that you cannot use blocking APIs, but
		983	the non-blocking variant should work.
807		984
		985	=cut
		986
808	our $VERSION = 1;	987	our $VERSION = '5.23';
809		988
810	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	989	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
811	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	990	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
812		991
813	sub timer {	992	sub timer {
…		…
815		994
816	my $cb = $arg{cb};	995	my $cb = $arg{cb};
817		996
818	urxvt::timer	997	urxvt::timer
819	->new	998	->new
820	->start (urxvt::NOW + $arg{after})	999	->after ($arg{after}, $arg{interval})
821	->cb (sub {	1000	->cb ($arg{interval} ? $cb : sub {
822	$_[0]->stop; # need to cancel manually	1001	$_[0]->stop; # need to cancel manually
823	$cb->();	1002	$cb->();
824	})	1003	})
825	}	1004	}
826		1005
827	sub io {	1006	sub io {
828	my ($class, %arg) = @_;	1007	my ($class, %arg) = @_;
829		1008
830	my $cb = $arg{cb};	1009	my $cb = $arg{cb};
		1010	my $fd = fileno $arg{fh};
		1011	defined $fd or $fd = $arg{fh};
831		1012
832	bless [$arg{fh}, urxvt::iow	1013	bless [$arg{fh}, urxvt::iow
833	->new	1014	->new
834	->fd (fileno $arg{fh})	1015	->fd ($fd)
835	->events (($arg{poll} =~ /r/ ? 1 : 0)	1016	->events (($arg{poll} =~ /r/ ? 1 : 0)
836	| ($arg{poll} =~ /w/ ? 2 : 0))	1017	| ($arg{poll} =~ /w/ ? 2 : 0))
837	->start	1018	->start
838	->cb (sub {	1019	->cb ($cb)
839	$cb->(($_[1] & 1 ? 'r' : '')
840	. ($_[1] & 2 ? 'w' : ''));
841	})],
842	urxvt::anyevent::	1020	], urxvt::anyevent::
		1021	}
		1022
		1023	sub idle {
		1024	my ($class, %arg) = @_;
		1025
		1026	my $cb = $arg{cb};
		1027
		1028	urxvt::iw
		1029	->new
		1030	->start
		1031	->cb ($cb)
		1032	}
		1033
		1034	sub child {
		1035	my ($class, %arg) = @_;
		1036
		1037	my $cb = $arg{cb};
		1038
		1039	urxvt::pw
		1040	->new
		1041	->start ($arg{pid})
		1042	->cb (sub {
		1043	$_[0]->stop; # need to cancel manually
		1044	$cb->($_[0]->rpid, $_[0]->rstatus);
		1045	})
843	}	1046	}
844		1047
845	sub DESTROY {	1048	sub DESTROY {
846	$_[0][1]->stop;	1049	$_[0][1]->stop;
847	}	1050	}
848		1051
849	sub condvar {	1052	# only needed for AnyEvent < 6 compatibility
850	bless \my $flag, urxvt::anyevent::condvar::	1053	sub one_event {
851	}
852
853	sub urxvt::anyevent::condvar::broadcast {
854	${$_[0]}++;
855	}
856
857	sub urxvt::anyevent::condvar::wait {
858	unless (${$_[0]}) {
859	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1054	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
860	}
861	}	1055	}
862		1056
863	package urxvt::term;	1057	package urxvt::term;
864		1058
865	=head2 The C<urxvt::term> Class	1059	=head2 The C<urxvt::term> Class
…		…
871	# find on_xxx subs in the package and register them	1065	# find on_xxx subs in the package and register them
872	# as hooks	1066	# as hooks
873	sub register_package {	1067	sub register_package {
874	my ($self, $pkg, $argv) = @_;	1068	my ($self, $pkg, $argv) = @_;
875		1069
		1070	no strict 'refs';
		1071
		1072	urxvt::verbose 6, "register package $pkg to $self";
		1073
		1074	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1075
876	my $proxy = bless {	1076	my $proxy = bless {
877	_pkg => $pkg,	1077	_pkg => $pkg,
		1078	_name => ${"$pkg\::_NAME"}, # hackish
878	argv => $argv,	1079	argv => $argv,
879	}, $pkg;	1080	}, $pkg;
880	Scalar::Util::weaken ($proxy->{term} = $self);	1081	Scalar::Util::weaken ($proxy->{term} = $self);
881		1082
882	$self->{_pkg}{$pkg} = $proxy;	1083	$self->{_pkg}{$pkg} = $proxy;
883		1084
…		…
886	$proxy->enable ($name => $ref);	1087	$proxy->enable ($name => $ref);
887	}	1088	}
888	}	1089	}
889	}	1090	}
890		1091
		1092	sub perl_libdirs {
		1093	map { split /:/ }
		1094	$_[0]->resource ("perl_lib"),
		1095	$ENV{URXVT_PERL_LIB},
		1096	"$ENV{HOME}/.urxvt/ext",
		1097	"$LIBDIR/perl"
		1098	}
		1099
		1100	# scan for available extensions and collect their metadata
		1101	sub scan_extensions {
		1102	my ($self) = @_;
		1103
		1104	return if exists $self->{meta};
		1105
		1106	my @libdirs = perl_libdirs $self;
		1107
		1108	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1109
		1110	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1111	$self->{meta} = \my %meta;
		1112
		1113	# first gather extensions
		1114	for my $dir (reverse @libdirs) {
		1115	opendir my $fh, $dir
		1116	or next;
		1117	for my $ext (readdir $fh) {
		1118	$ext !~ /^\./
		1119	and open my $fh, "<", "$dir/$ext"
		1120	or next;
		1121
		1122	my %ext = (dir => $dir);
		1123
		1124	while (<$fh>) {
		1125	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1126	my ($pattern, $type, $desc) = split /:/, $1;
		1127	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1128	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1129	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1130	} else {
		1131	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1132	}
		1133	} elsif (/^#:META:BINDING:(.*)/) {
		1134	my ($keysym, $action) = split /:/, $1;
		1135	$ext{binding}{$keysym} = [$ext, $action];
		1136	} elsif (/^\s*(?:#|$)/) {
		1137	# skip other comments and empty lines
		1138	} else {
		1139	last; # stop parsing on first non-empty non-comment line
		1140	}
		1141	}
		1142
		1143	$meta{ext}{$ext} = \%ext;
		1144	}
		1145	}
		1146
		1147	# and now merge resources and bindings
		1148	while (my ($k, $v) = each %{ $meta{ext} }) {
		1149	#TODO: should check for extensions overriding each other
		1150	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1151	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1152	}
		1153	}
		1154
891	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1155	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
892		1156
893	Creates a new terminal, very similar as if you had started it with system	1157	Creates a new terminal, very similar as if you had started it with system
894	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1158	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
895	hash which defines the environment of the new terminal.	1159	hash which defines the environment of the new terminal.
896		1160
897	Croaks (and probably outputs an error message) if the new instance	1161	Croaks (and probably outputs an error message) if the new instance
898	couldn't be created. Returns C<undef> if the new instance didn't	1162	couldn't be created. Returns C<undef> if the new instance didn't
899	initialise perl, and the terminal object otherwise. The C<init> and	1163	initialise perl, and the terminal object otherwise. The C<init> and
900	C<start> hooks will be called during this call.	1164	C<start> hooks will be called before this call returns, and are free to
		1165	refer to global data (which is race free).
901		1166
902	=cut	1167	=cut
903		1168
904	sub new {	1169	sub new {
905	my ($class, $env, @args) = @_;	1170	my ($class, $env, @args) = @_;
906		1171
		1172	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1173	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1174
907	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1175	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
908	}	1176	}
909		1177
910	=item $term->destroy	1178	=item $term->destroy
911		1179
912	Destroy the terminal object (close the window, free resources	1180	Destroy the terminal object (close the window, free resources
913	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1181	etc.). Please note that urxvt will not exit as long as any event
914	watchers (timers, io watchers) are still active.	1182	watchers (timers, io watchers) are still active.
		1183
		1184	=item $term->exec_async ($cmd[, @args])
		1185
		1186	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1187	("starts") programs in the background. This function takes care of setting
		1188	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1189	be preferred over explicit calls to C<exec> or C<system>.
		1190
		1191	Returns the pid of the subprocess or C<undef> on error.
		1192
		1193	=cut
		1194
		1195	sub exec_async {
		1196	my $self = shift;
		1197
		1198	my $pid = fork;
		1199
		1200	return $pid
		1201	if !defined $pid or $pid;
		1202
		1203	%ENV = %{ $self->env };
		1204
		1205	exec @_;
		1206	urxvt::_exit 255;
		1207	}
915		1208
916	=item $isset = $term->option ($optval[, $set])	1209	=item $isset = $term->option ($optval[, $set])
917		1210
918	Returns true if the option specified by C<$optval> is enabled, and	1211	Returns true if the option specified by C<$optval> is enabled, and
919	optionally change it. All option values are stored by name in the hash	1212	optionally change it. All option values are stored by name in the hash
920	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1213	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
921		1214
922	Here is a a likely non-exhaustive list of option names, please see the	1215	Here is a likely non-exhaustive list of option names, please see the
923	source file F</src/optinc.h> to see the actual list:	1216	source file F</src/optinc.h> to see the actual list:
924		1217
925	borderLess console cursorBlink cursorUnderline hold iconic insecure	1218	borderLess buffered console cursorBlink cursorUnderline hold iconic
926	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1219	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1220	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
927	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1221	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
928	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1222	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
929	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1223	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
930	tripleclickwords utmpInhibit visualBell	1224	urgentOnBell utmpInhibit visualBell
931		1225
932	=item $value = $term->resource ($name[, $newval])	1226	=item $value = $term->resource ($name[, $newval])
933		1227
934	Returns the current resource value associated with a given name and	1228	Returns the current resource value associated with a given name and
935	optionally sets a new value. Setting values is most useful in the C<init>	1229	optionally sets a new value. Setting values is most useful in the C<init>
…		…
944	likely change).	1238	likely change).
945		1239
946	Please note that resource strings will currently only be freed when the	1240	Please note that resource strings will currently only be freed when the
947	terminal is destroyed, so changing options frequently will eat memory.	1241	terminal is destroyed, so changing options frequently will eat memory.
948		1242
949	Here is a a likely non-exhaustive list of resource names, not all of which	1243	Here is a likely non-exhaustive list of resource names, not all of which
950	are supported in every build, please see the source file F</src/rsinc.h>	1244	are supported in every build, please see the source file F</src/rsinc.h>
951	to see the actual list:	1245	to see the actual list:
952		1246
953	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1247	answerbackstring backgroundPixmap backspace_key blurradius
954	borderLess color cursorBlink cursorUnderline cutchars delete_key	1248	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
955	display_name embed ext_bwidth fade font geometry hold iconName	1249	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
956	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1250	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1251	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
957	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1252	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
958	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1253	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
959	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1254	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
960	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1255	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
961	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1256	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
962	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1257	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
963	shade term_name title transparent transparent_all tripleclickwords	1258	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1259	term_name title transient_for transparent tripleclickwords urgentOnBell
964	utmpInhibit visualBell	1260	utmpInhibit visualBell
965		1261
966	=cut	1262	=cut
967		1263
968	sub resource($$;$) {	1264	sub resource($$;$) {
969	my ($self, $name) = (shift, shift);	1265	my ($self, $name) = (shift, shift);
970	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1266	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
971	&urxvt::term::_resource	1267	goto &urxvt::term::_resource
972	}	1268	}
973		1269
974	=item $value = $term->x_resource ($pattern)	1270	=item $value = $term->x_resource ($pattern)
975		1271
976	Returns the X-Resource for the given pattern, excluding the program or	1272	Returns the X-Resource for the given pattern, excluding the program or
977	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1273	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
978	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1274	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
979	resource with that pattern exists.	1275	resource with that pattern exists.
980		1276
		1277	Extensions that define extra resource or command line arguments also need
		1278	to call this method to access their values.
		1279
		1280	If the method is called on an extension object (basically, from an
		1281	extension), then the special prefix C<%.> will be replaced by the name of
		1282	the extension and a dot, and the lone string C<%> will be replaced by the
		1283	extension name itself. This makes it possible to code extensions so you
		1284	can rename them and get a new set of commandline switches and resources
		1285	without having to change the actual code.
		1286
981	This method should only be called during the C<on_start> hook, as there is	1287	This method should only be called during the C<on_start> hook, as there is
982	only one resource database per display, and later invocations might return	1288	only one resource database per display, and later invocations might return
983	the wrong resources.	1289	the wrong resources.
984		1290
985	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1291	=item $value = $term->x_resource_boolean ($pattern)
986		1292
		1293	Like C<x_resource>, above, but interprets the string value as a boolean
		1294	and returns C<1> for true values, C<0> for false values and C<undef> if
		1295	the resource or option isn't specified.
		1296
		1297	You should always use this method to parse boolean resources.
		1298
		1299	=cut
		1300
		1301	sub x_resource_boolean {
		1302	my $res = &x_resource;
		1303
		1304	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1305	}
		1306
		1307	=item $success = $term->bind_action ($key, $octets)
		1308
987	Adds a keymap translation exactly as specified via a resource. See the	1309	Adds a key binding exactly as specified via a C<keysym> resource. See the
988	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1310	C<keysym> resource in the urxvt(1) manpage.
989		1311
990	=item $rend = $term->rstyle ([$new_rstyle])	1312	=item $rend = $term->rstyle ([$new_rstyle])
991		1313
992	Return and optionally change the current rendition. Text that is output by	1314	Return and optionally change the current rendition. Text that is output by
993	the terminal application will use this style.	1315	the terminal application will use this style.
…		…
1001		1323
1002	=item ($row, $col) = $term->selection_beg ([$row, $col])	1324	=item ($row, $col) = $term->selection_beg ([$row, $col])
1003		1325
1004	=item ($row, $col) = $term->selection_end ([$row, $col])	1326	=item ($row, $col) = $term->selection_end ([$row, $col])
1005		1327
1006	Return the current values of the selection mark, begin or end positions,	1328	Return the current values of the selection mark, begin or end positions.
1007	and optionally set them to new values.	1329
		1330	When arguments are given, then the selection coordinates are set to
		1331	C<$row> and C<$col>, and the selection screen is set to the current
		1332	screen.
		1333
		1334	=item $screen = $term->selection_screen ([$screen])
		1335
		1336	Returns the current selection screen, and then optionally sets it.
1008		1337
1009	=item $term->selection_make ($eventtime[, $rectangular])	1338	=item $term->selection_make ($eventtime[, $rectangular])
1010		1339
1011	Tries to make a selection as set by C<selection_beg> and	1340	Tries to make a selection as set by C<selection_beg> and
1012	C<selection_end>. If C<$rectangular> is true (default: false), a	1341	C<selection_end>. If C<$rectangular> is true (default: false), a
1013	rectangular selection will be made. This is the prefered function to make	1342	rectangular selection will be made. This is the preferred function to make
1014	a selection.	1343	a selection.
1015		1344
1016	=item $success = $term->selection_grab ($eventtime)	1345	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1017		1346
1018	Try to request the primary selection text from the server (for example, as	1347	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1348	true) selection from the server. The corresponding text can be set
1019	set by the next method). No visual feedback will be given. This function	1349	with the next method. No visual feedback will be given. This function
1020	is mostly useful from within C<on_sel_grab> hooks.	1350	is mostly useful from within C<on_sel_grab> hooks.
1021		1351
1022	=item $oldtext = $term->selection ([$newtext])	1352	=item $oldtext = $term->selection ([$newtext, $clipboard])
1023		1353
1024	Return the current selection text and optionally replace it by C<$newtext>.	1354	Return the current selection (clipboard if C<$clipboard> is true) text
		1355	and optionally replace it by C<$newtext>.
		1356
		1357	=item $term->selection_clear ([$clipboard])
		1358
		1359	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1025		1360
1026	=item $term->overlay_simple ($x, $y, $text)	1361	=item $term->overlay_simple ($x, $y, $text)
1027		1362
1028	Create a simple multi-line overlay box. See the next method for details.	1363	Create a simple multi-line overlay box. See the next method for details.
1029		1364
…		…
1059		1394
1060	The methods currently supported on C<urxvt::overlay> objects are:	1395	The methods currently supported on C<urxvt::overlay> objects are:
1061		1396
1062	=over 4	1397	=over 4
1063		1398
1064	=item $overlay->set ($x, $y, $text, $rend)	1399	=item $overlay->set ($x, $y, $text[, $rend])
1065		1400
1066	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1401	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1067	text in rxvt-unicode's special encoding and an array of rendition values	1402	text in rxvt-unicode's special encoding and an array of rendition values
1068	at a specific position inside the overlay.	1403	at a specific position inside the overlay.
		1404
		1405	If C<$rend> is missing, then the rendition will not be changed.
1069		1406
1070	=item $overlay->hide	1407	=item $overlay->hide
1071		1408
1072	If visible, hide the overlay, but do not destroy it.	1409	If visible, hide the overlay, but do not destroy it.
1073		1410
…		…
1143		1480
1144	Normally its not a good idea to use this function, as programs might be	1481	Normally its not a good idea to use this function, as programs might be
1145	confused by changes in cursor position or scrolling. Its useful inside a	1482	confused by changes in cursor position or scrolling. Its useful inside a
1146	C<on_add_lines> hook, though.	1483	C<on_add_lines> hook, though.
1147		1484
		1485	=item $term->scr_change_screen ($screen)
		1486
		1487	Switch to given screen - 0 primary, 1 secondary.
		1488
1148	=item $term->cmd_parse ($octets)	1489	=item $term->cmd_parse ($octets)
1149		1490
1150	Similar to C<scr_add_lines>, but the argument must be in the	1491	Similar to C<scr_add_lines>, but the argument must be in the
1151	locale-specific encoding of the terminal and can contain command sequences	1492	locale-specific encoding of the terminal and can contain command sequences
1152	(escape codes) that will be interpreted.	1493	(escape codes) that will be interpreted.
1153		1494
1154	=item $term->tt_write ($octets)	1495	=item $term->tt_write ($octets)
1155		1496
1156	Write the octets given in C<$data> to the tty (i.e. as program input). To	1497	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1157	pass characters instead of octets, you should convert your strings first	1498	pass characters instead of octets, you should convert your strings first
1158	to the locale-specific encoding using C<< $term->locale_encode >>.	1499	to the locale-specific encoding using C<< $term->locale_encode >>.
		1500
		1501	=item $term->tt_write_user_input ($octets)
		1502
		1503	Like C<tt_write>, but should be used when writing strings in response to
		1504	the user pressing a key, to invokes the additional actions requested by
		1505	the user for that case (C<tt_write> doesn't do that).
		1506
		1507	The typical use case would be inside C<on_action> hooks.
		1508
		1509	=item $term->tt_paste ($octets)
		1510
		1511	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1512	CR and bracketing the data with control sequences if bracketed paste mode
		1513	is set.
1159		1514
1160	=item $old_events = $term->pty_ev_events ([$new_events])	1515	=item $old_events = $term->pty_ev_events ([$new_events])
1161		1516
1162	Replaces the event mask of the pty watcher by the given event mask. Can	1517	Replaces the event mask of the pty watcher by the given event mask. Can
1163	be used to suppress input and output handling to the pty/tty. See the	1518	be used to suppress input and output handling to the pty/tty. See the
1164	description of C<< urxvt::timer->events >>. Make sure to always restore	1519	description of C<< urxvt::timer->events >>. Make sure to always restore
1165	the previous value.	1520	the previous value.
1166		1521
		1522	=item $fd = $term->pty_fd
		1523
		1524	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1525	is used.
		1526
1167	=item $windowid = $term->parent	1527	=item $windowid = $term->parent
1168		1528
1169	Return the window id of the toplevel window.	1529	Return the window id of the toplevel window.
1170		1530
1171	=item $windowid = $term->vt	1531	=item $windowid = $term->vt
…		…
1177	Adds the specified events to the vt event mask. Useful e.g. when you want	1537	Adds the specified events to the vt event mask. Useful e.g. when you want
1178	to receive pointer events all the times:	1538	to receive pointer events all the times:
1179		1539
1180	$term->vt_emask_add (urxvt::PointerMotionMask);	1540	$term->vt_emask_add (urxvt::PointerMotionMask);
1181		1541
		1542	=item $term->set_urgency ($set)
		1543
		1544	Enable/disable the urgency hint on the toplevel window.
		1545
		1546	=item $term->focus_in
		1547
		1548	=item $term->focus_out
		1549
		1550	=item $term->key_press ($state, $keycode[, $time])
		1551
		1552	=item $term->key_release ($state, $keycode[, $time])
		1553
		1554	Deliver various fake events to to terminal.
		1555
1182	=item $window_width = $term->width	1556	=item $window_width = $term->width
1183		1557
1184	=item $window_height = $term->height	1558	=item $window_height = $term->height
1185		1559
1186	=item $font_width = $term->fwidth	1560	=item $font_width = $term->fwidth
…		…
1216	=item $env = $term->env	1590	=item $env = $term->env
1217		1591
1218	Returns a copy of the environment in effect for the terminal as a hashref	1592	Returns a copy of the environment in effect for the terminal as a hashref
1219	similar to C<\%ENV>.	1593	similar to C<\%ENV>.
1220		1594
		1595	=item @envv = $term->envv
		1596
		1597	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1598
		1599	=item @argv = $term->argv
		1600
		1601	Return the argument vector as this terminal, similar to @ARGV, but
		1602	includes the program name as first element.
		1603
1221	=cut	1604	=cut
1222		1605
1223	sub env {	1606	sub env {
1224	if (my $env = $_[0]->_env) {
1225	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1607	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1226	} else {
1227	+{ %ENV }
1228	}
1229	}	1608	}
1230		1609
1231	=item $modifiermask = $term->ModLevel3Mask	1610	=item $modifiermask = $term->ModLevel3Mask
1232		1611
1233	=item $modifiermask = $term->ModMetaMask	1612	=item $modifiermask = $term->ModMetaMask
1234		1613
1235	=item $modifiermask = $term->ModNumLockMask	1614	=item $modifiermask = $term->ModNumLockMask
1236		1615
1237	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1616	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1238	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1617	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1618
		1619	=item $screen = $term->current_screen
		1620
		1621	Returns the currently displayed screen (0 primary, 1 secondary).
		1622
		1623	=item $cursor_is_hidden = $term->hidden_cursor
		1624
		1625	Returns whether the cursor is currently hidden or not.
1239		1626
1240	=item $view_start = $term->view_start ([$newvalue])	1627	=item $view_start = $term->view_start ([$newvalue])
1241		1628
1242	Returns the row number of the topmost displayed line. Maximum value is	1629	Returns the row number of the topmost displayed line. Maximum value is
1243	C<0>, which displays the normal terminal contents. Lower values scroll	1630	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1251		1638
1252	Used after changing terminal contents to display them.	1639	Used after changing terminal contents to display them.
1253		1640
1254	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1641	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1255		1642
1256	Returns the text of the entire row with number C<$row_number>. Row C<0>	1643	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1257	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1644	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1258	terminal line. The scrollback buffer starts at line C<-1> and extends to
1259	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1645	terminal line. Nothing will be returned if a nonexistent line
1260	is requested.	1646	is requested.
1261		1647
1262	If C<$new_text> is specified, it will replace characters in the current	1648	If C<$new_text> is specified, it will replace characters in the current
1263	line, starting at column C<$start_col> (default C<0>), which is useful	1649	line, starting at column C<$start_col> (default C<0>), which is useful
1264	to replace only parts of a line. The font index in the rendition will	1650	to replace only parts of a line. The font index in the rendition will
1265	automatically be updated.	1651	automatically be updated.
1266		1652
1267	C<$text> is in a special encoding: tabs and wide characters that use more	1653	C<$text> is in a special encoding: tabs and wide characters that use more
1268	than one cell when displayed are padded with urxvt::NOCHAR characters	1654	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1269	(C<chr 65535>). Characters with combining characters and other characters	1655	characters. Characters with combining characters and other characters that
1270	that do not fit into the normal tetx encoding will be replaced with	1656	do not fit into the normal text encoding will be replaced with characters
1271	characters in the private use area.	1657	in the private use area.
1272		1658
1273	You have to obey this encoding when changing text. The advantage is	1659	You have to obey this encoding when changing text. The advantage is
1274	that C<substr> and similar functions work on screen cells and not on	1660	that C<substr> and similar functions work on screen cells and not on
1275	characters.	1661	characters.
1276		1662
…		…
1360	}	1746	}
1361		1747
1362	sub urxvt::line::t {	1748	sub urxvt::line::t {
1363	my ($self) = @_;	1749	my ($self) = @_;
1364		1750
1365	if (@_ > 1)	1751	if (@_ > 1) {
1366	{
1367	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1752	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1368	for $self->{beg} .. $self->{end};	1753	for $self->{beg} .. $self->{end};
1369	}	1754	}
1370		1755
1371	defined wantarray &&	1756	defined wantarray &&
1372	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1757	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1373	0, $self->{len}	1758	0, $self->{len}
1374	}	1759	}
1375		1760
1376	sub urxvt::line::r {	1761	sub urxvt::line::r {
1377	my ($self) = @_;	1762	my ($self) = @_;
1378		1763
1379	if (@_ > 1)	1764	if (@_ > 1) {
1380	{
1381	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1765	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1382	for $self->{beg} .. $self->{end};	1766	for $self->{beg} .. $self->{end};
1383	}	1767	}
1384		1768
1385	if (defined wantarray) {	1769	if (defined wantarray) {
1386	my $rend = [	1770	my $rend = [
1387	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1771	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1388	];	1772	];
…		…
1420	where one character corresponds to one screen cell. See	1804	where one character corresponds to one screen cell. See
1421	C<< $term->ROW_t >> for details.	1805	C<< $term->ROW_t >> for details.
1422		1806
1423	=item $string = $term->special_decode $text	1807	=item $string = $term->special_decode $text
1424		1808
1425	Converts rxvt-unicodes text reprsentation into a perl string. See	1809	Converts rxvt-unicodes text representation into a perl string. See
1426	C<< $term->ROW_t >> for details.	1810	C<< $term->ROW_t >> for details.
1427		1811
1428	=item $success = $term->grab_button ($button, $modifiermask)	1812	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1429		1813
		1814	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1815
1430	Registers a synchronous button grab. See the XGrabButton manpage.	1816	Register/unregister a synchronous button grab. See the XGrabButton
		1817	manpage.
1431		1818
1432	=item $success = $term->grab ($eventtime[, $sync])	1819	=item $success = $term->grab ($eventtime[, $sync])
1433		1820
1434	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1821	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1435	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1822	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1436		1823
1437	=item $term->allow_events_async	1824	=item $term->allow_events_async
1438		1825
1439	Calls XAllowEvents with AsyncBoth for the most recent grab.	1826	Calls XAllowEvents with AsyncBoth for the most recent grab.
1440		1827
…		…
1447	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1834	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1448	recent grab.	1835	recent grab.
1449		1836
1450	=item $term->ungrab	1837	=item $term->ungrab
1451		1838
1452	Calls XUngrab for the most recent grab. Is called automatically on	1839	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1453	evaluation errors, as it is better to lose the grab in the error case as	1840	evaluation errors, as it is better to lose the grab in the error case as
1454	the session.	1841	the session.
		1842
		1843	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1844
		1845	=item $atom_name = $term->XGetAtomName ($atom)
		1846
		1847	=item @atoms = $term->XListProperties ($window)
		1848
		1849	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1850
		1851	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1852
		1853	=item $term->XDeleteProperty ($window, $property)
		1854
		1855	=item $window = $term->DefaultRootWindow
		1856
		1857	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1858
		1859	=item $term->XMapWindow ($window)
		1860
		1861	=item $term->XUnmapWindow ($window)
		1862
		1863	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1864
		1865	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1866
		1867	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1868
		1869	=item $keysym = $term->XStringToKeysym ($string)
		1870
		1871	=item $string = $term->XKeysymToString ($keysym)
		1872
		1873	Various X or X-related functions. The C<$term> object only serves as
		1874	the source of the display, otherwise those functions map more-or-less
		1875	directly onto the X functions of the same name.
1455		1876
1456	=back	1877	=back
1457		1878
1458	=cut	1879	=cut
1459		1880
…		…
1523	my ($self, $text, $cb) = @_;	1944	my ($self, $text, $cb) = @_;
1524		1945
1525	$self->add_item ({ type => "button", text => $text, activate => $cb});	1946	$self->add_item ({ type => "button", text => $text, activate => $cb});
1526	}	1947	}
1527		1948
1528	=item $popup->add_toggle ($text, $cb, $initial_value)	1949	=item $popup->add_toggle ($text, $initial_value, $cb)
1529		1950
1530	Adds a toggle/checkbox item to the popup. Teh callback gets called	1951	Adds a toggle/checkbox item to the popup. The callback gets called
1531	whenever it gets toggled, with a boolean indicating its value as its first	1952	whenever it gets toggled, with a boolean indicating its new value as its
1532	argument.	1953	first argument.
1533		1954
1534	=cut	1955	=cut
1535		1956
1536	sub add_toggle {	1957	sub add_toggle {
1537	my ($self, $text, $cb, $value) = @_;	1958	my ($self, $text, $value, $cb) = @_;
1538		1959
1539	my $item; $item = {	1960	my $item; $item = {
1540	type => "button",	1961	type => "button",
1541	text => " $text",	1962	text => " $text",
1542	value => $value,	1963	value => $value,
…		…
1561	my $env = $self->{term}->env;	1982	my $env = $self->{term}->env;
1562	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1983	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1563	delete $env->{LC_ALL};	1984	delete $env->{LC_ALL};
1564	$env->{LC_CTYPE} = $self->{term}->locale;	1985	$env->{LC_CTYPE} = $self->{term}->locale;
1565		1986
1566	urxvt::term->new ($env, $self->{term}->resource ("name"),	1987	my $term = urxvt::term->new (
1567	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1988	$env, "popup",
		1989	"--perl-lib" => "", "--perl-ext-common" => "",
		1990	"-pty-fd" => -1, "-sl" => 0,
		1991	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1568	"--transient-for" => $self->{term}->parent,	1992	"--transient-for" => $self->{term}->parent,
1569	"-display" => $self->{term}->display_id,	1993	"-display" => $self->{term}->display_id,
1570	"-pe" => "urxvt-popup")	1994	"-pe" => "urxvt-popup",
1571	or die "unable to create popup window\n";	1995	) or die "unable to create popup window\n";
		1996
		1997	unless (delete $term->{urxvt_popup_init_done}) {
		1998	$term->ungrab;
		1999	$term->destroy;
		2000	die "unable to initialise popup window\n";
		2001	}
1572	}	2002	}
1573		2003
1574	sub DESTROY {	2004	sub DESTROY {
1575	my ($self) = @_;	2005	my ($self) = @_;
1576		2006
1577	delete $self->{term}{_destroy}{$self};	2007	delete $self->{term}{_destroy}{$self};
1578	$self->{term}->ungrab;	2008	$self->{term}->ungrab;
1579	}	2009	}
1580		2010
1581	=back	2011	=back
		2012
		2013	=cut
		2014
		2015	package urxvt::watcher;
1582		2016
1583	=head2 The C<urxvt::timer> Class	2017	=head2 The C<urxvt::timer> Class
1584		2018
1585	This class implements timer watchers/events. Time is represented as a	2019	This class implements timer watchers/events. Time is represented as a
1586	fractional number of seconds since the epoch. Example:	2020	fractional number of seconds since the epoch. Example:
…		…
1590	->new	2024	->new
1591	->interval (1)	2025	->interval (1)
1592	->cb (sub {	2026	->cb (sub {
1593	$term->{overlay}->set (0, 0,	2027	$term->{overlay}->set (0, 0,
1594	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2028	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1595	});	2029	});
1596		2030
1597	=over 4	2031	=over 4
1598		2032
1599	=item $timer = new urxvt::timer	2033	=item $timer = new urxvt::timer
1600		2034
…		…
1603		2037
1604	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2038	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1605		2039
1606	Set the callback to be called when the timer triggers.	2040	Set the callback to be called when the timer triggers.
1607		2041
1608	=item $tstamp = $timer->at
1609
1610	Return the time this watcher will fire next.
1611
1612	=item $timer = $timer->set ($tstamp)	2042	=item $timer = $timer->set ($tstamp[, $interval])
1613		2043
1614	Set the time the event is generated to $tstamp.	2044	Set the time the event is generated to $tstamp (and optionally specifies a
		2045	new $interval).
1615		2046
1616	=item $timer = $timer->interval ($interval)	2047	=item $timer = $timer->interval ($interval)
1617		2048
1618	Normally (and when C<$interval> is C<0>), the timer will automatically	2049	By default (and when C<$interval> is C<0>), the timer will automatically
1619	stop after it has fired once. If C<$interval> is non-zero, then the timer	2050	stop after it has fired once. If C<$interval> is non-zero, then the timer
1620	is automatically rescheduled at the given intervals.	2051	is automatically rescheduled at the given intervals.
1621		2052
1622	=item $timer = $timer->start	2053	=item $timer = $timer->start
1623		2054
1624	Start the timer.	2055	Start the timer.
1625		2056
1626	=item $timer = $timer->start ($tstamp)	2057	=item $timer = $timer->start ($tstamp[, $interval])
1627		2058
1628	Set the event trigger time to C<$tstamp> and start the timer.	2059	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2060	also replaces the interval.
		2061
		2062	=item $timer = $timer->after ($delay[, $interval])
		2063
		2064	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1629		2065
1630	=item $timer = $timer->stop	2066	=item $timer = $timer->stop
1631		2067
1632	Stop the timer.	2068	Stop the timer.
1633		2069
…		…
1639		2075
1640	$term->{socket} = ...	2076	$term->{socket} = ...
1641	$term->{iow} = urxvt::iow	2077	$term->{iow} = urxvt::iow
1642	->new	2078	->new
1643	->fd (fileno $term->{socket})	2079	->fd (fileno $term->{socket})
1644	->events (urxvt::EVENT_READ)	2080	->events (urxvt::EV_READ)
1645	->start	2081	->start
1646	->cb (sub {	2082	->cb (sub {
1647	my ($iow, $revents) = @_;	2083	my ($iow, $revents) = @_;
1648	# $revents must be 1 here, no need to check	2084	# $revents must be 1 here, no need to check
1649	sysread $term->{socket}, my $buf, 8192	2085	sysread $term->{socket}, my $buf, 8192
…		…
1662	Set the callback to be called when io events are triggered. C<$reventmask>	2098	Set the callback to be called when io events are triggered. C<$reventmask>
1663	is a bitset as described in the C<events> method.	2099	is a bitset as described in the C<events> method.
1664		2100
1665	=item $iow = $iow->fd ($fd)	2101	=item $iow = $iow->fd ($fd)
1666		2102
1667	Set the filedescriptor (not handle) to watch.	2103	Set the file descriptor (not handle) to watch.
1668		2104
1669	=item $iow = $iow->events ($eventmask)	2105	=item $iow = $iow->events ($eventmask)
1670		2106
1671	Set the event mask to watch. The only allowed values are	2107	Set the event mask to watch. The only allowed values are
1672	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2108	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1673	together, or C<urxvt::EVENT_NONE>.	2109	together, or C<urxvt::EV_NONE>.
1674		2110
1675	=item $iow = $iow->start	2111	=item $iow = $iow->start
1676		2112
1677	Start watching for requested events on the given handle.	2113	Start watching for requested events on the given handle.
1678		2114
1679	=item $iow = $iow->stop	2115	=item $iow = $iow->stop
1680		2116
1681	Stop watching for events on the given filehandle.	2117	Stop watching for events on the given file handle.
		2118
		2119	=back
		2120
		2121	=head2 The C<urxvt::iw> Class
		2122
		2123	This class implements idle watchers, that get called automatically when
		2124	the process is idle. They should return as fast as possible, after doing
		2125	some useful work.
		2126
		2127	=over 4
		2128
		2129	=item $iw = new urxvt::iw
		2130
		2131	Create a new idle watcher object in stopped state.
		2132
		2133	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2134
		2135	Set the callback to be called when the watcher triggers.
		2136
		2137	=item $timer = $timer->start
		2138
		2139	Start the watcher.
		2140
		2141	=item $timer = $timer->stop
		2142
		2143	Stop the watcher.
		2144
		2145	=back
		2146
		2147	=head2 The C<urxvt::pw> Class
		2148
		2149	This class implements process watchers. They create an event whenever a
		2150	process exits, after which they stop automatically.
		2151
		2152	my $pid = fork;
		2153	...
		2154	$term->{pw} = urxvt::pw
		2155	->new
		2156	->start ($pid)
		2157	->cb (sub {
		2158	my ($pw, $exit_status) = @_;
		2159	...
		2160	});
		2161
		2162	=over 4
		2163
		2164	=item $pw = new urxvt::pw
		2165
		2166	Create a new process watcher in stopped state.
		2167
		2168	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2169
		2170	Set the callback to be called when the timer triggers.
		2171
		2172	=item $pw = $timer->start ($pid)
		2173
		2174	Tells the watcher to start watching for process C<$pid>.
		2175
		2176	=item $pw = $pw->stop
		2177
		2178	Stop the watcher.
1682		2179
1683	=back	2180	=back
1684		2181
1685	=head1 ENVIRONMENT	2182	=head1 ENVIRONMENT
1686		2183
…		…
1695		2192
1696	=item >= 3 - script loading and management	2193	=item >= 3 - script loading and management
1697		2194
1698	=item >=10 - all called hooks	2195	=item >=10 - all called hooks
1699		2196
1700	=item >=11 - hook reutrn values	2197	=item >=11 - hook return values
1701		2198
1702	=back	2199	=back
1703		2200
1704	=head1 AUTHOR	2201	=head1 AUTHOR
1705		2202
1706	Marc Lehmann <pcg@goof.com>	2203	Marc Lehmann <schmorp@schmorp.de>
1707	http://software.schmorp.de/pkg/rxvt-unicode	2204	http://software.schmorp.de/pkg/rxvt-unicode
1708		2205
1709	=cut	2206	=cut
1710		2207
1711	1	2208	1
		2209
		2210	# vim: sw=3:

Diff Legend

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