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.122 by root, Sat Jan 21 08:07:38 2006 UTC vs.
Revision 1.243 by sf-exg, Sat Oct 11 22:02:50 2014 UTC

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

Diff Legend

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