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

Diff Legend

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