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

Diff Legend

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