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

Diff Legend

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