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.130 by root, Wed Jan 25 15:32:48 2006 UTC vs.
Revision 1.233 by sf-exg, Fri May 2 20:34:24 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-clipboard
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_user_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
521		287
522	Called whenever the a user-configured event is being activated (e.g. via	288	Called whenever a user-configured event is being activated (e.g. via
523	a C<perl:string> action bound to a key, 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).
525		291
526	The event is simply the action string. This interface is assumed to change	292	The event is simply the action string. This interface is going away in
527	slightly in the future.	293	preference to the C<< ->register_keysym_action >> method.
		294
		295	=item on_resize_all_windows $term, $new_width, $new_height
		296
		297	Called just after the new window size has been calculated, but before
		298	windows are actually being resized or hints are being set. If this hook
		299	returns a true value, setting of the window hints is being skipped.
528		300
529	=item on_x_event $term, $event	301	=item on_x_event $term, $event
530		302
531	Called on every X event received on the vt window (and possibly other	303	Called on every X event received on the vt window (and possibly other
532	windows). Should only be used as a last resort. Most event structure	304	windows). Should only be used as a last resort. Most event structure
533	members are not passed.	305	members are not passed.
534		306
		307	=item on_root_event $term, $event
		308
		309	Like C<on_x_event>, but is called for events on the root window.
		310
535	=item on_focus_in $term	311	=item on_focus_in $term
536		312
537	Called whenever the window gets the keyboard focus, before rxvt-unicode	313	Called whenever the window gets the keyboard focus, before rxvt-unicode
538	does focus in processing.	314	does focus in processing.
539		315
540	=item on_focus_out $term	316	=item on_focus_out $term
541		317
542	Called wheneever the window loses keyboard focus, before rxvt-unicode does	318	Called whenever the window loses keyboard focus, before rxvt-unicode does
543	focus out processing.	319	focus out processing.
544		320
545	=item on_configure_notify $term, $event	321	=item on_configure_notify $term, $event
546		322
547	=item on_property_notify $term, $event	323	=item on_property_notify $term, $event
…		…
558		334
559	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
560		336
561	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
562		338
563	Called whenever the corresponding X event is received for the terminal If	339	Called whenever the corresponding X event is received for the terminal. If
564	the hook returns true, then the even will be ignored by rxvt-unicode.	340	the hook returns true, then the event will be ignored by rxvt-unicode.
565		341
566	The event is a hash with most values as named by Xlib (see the XEvent	342	The event is a hash with most values as named by Xlib (see the XEvent
567	manpage), with the additional members C<row> and C<col>, which are the	343	manpage), with the additional members C<row> and C<col>, which are the
568	(real, not screen-based) row and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
569		345
570	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
571	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
572		348
573	subwindow.
574
575	=item on_client_message $term, $event	349	=item on_client_message $term, $event
576		350
577	=item on_wm_protocols $term, $event	351	=item on_wm_protocols $term, $event
578		352
579	=item on_wm_delete_window $term, $event	353	=item on_wm_delete_window $term, $event
580		354
581	Called when various types of ClientMessage events are received (all with	355	Called when various types of ClientMessage events are received (all with
582	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	356	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
583		357
		358	=item on_bell $term
		359
		360	Called on receipt of a bell character.
		361
584	=back	362	=back
585		363
586	=cut	364	=cut
587		365
588	package urxvt;	366	package urxvt;
589		367
590	use utf8;	368	use utf8;
591	use strict;	369	use strict 'vars';
592	use Carp ();	370	use Carp ();
593	use Scalar::Util ();	371	use Scalar::Util ();
594	use List::Util ();	372	use List::Util ();
595		373
596	our $VERSION = 1;	374	our $VERSION = 1;
597	our $TERM;	375	our $TERM;
598	our @TERM_INIT;	376	our @TERM_INIT; # should go, prevents async I/O etc.
599	our @TERM_EXT;	377	our @TERM_EXT; # should go, prevents async I/O etc.
600	our @HOOKNAME;	378	our @HOOKNAME;
601	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
602	our %OPTION;	380	our %OPTION;
603		381
604	our $LIBDIR;	382	our $LIBDIR;
…		…
630	The current terminal. This variable stores the current C<urxvt::term>	408	The current terminal. This variable stores the current C<urxvt::term>
631	object, whenever a callback/hook is executing.	409	object, whenever a callback/hook is executing.
632		410
633	=item @urxvt::TERM_INIT	411	=item @urxvt::TERM_INIT
634		412
635	All coderefs in this array will be called as methods of the next newly	413	All code references in this array will be called as methods of the next newly
636	created C<urxvt::term> object (during the C<on_init> phase). The array	414	created C<urxvt::term> object (during the C<on_init> phase). The array
637	gets cleared before the codereferences that were in it are being executed,	415	gets cleared before the code references that were in it are being executed,
638	so coderefs can push themselves onto it again if they so desire.	416	so references can push themselves onto it again if they so desire.
639		417
640	This complements to the perl-eval commandline option, but gets executed	418	This complements to the perl-eval command line option, but gets executed
641	first.	419	first.
642		420
643	=item @urxvt::TERM_EXT	421	=item @urxvt::TERM_EXT
644		422
645	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	423	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
652		430
653	=over 4	431	=over 4
654		432
655	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
656		434
657	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
658	costs! The only time this is acceptable is when the terminal process	436	include a trailing newline). Avoid at all costs! The only time this
659	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
660		439
661	=item urxvt::warn $string	440	=item urxvt::warn $string
662		441
663	Calls C<rxvt_warn> with the given string which should not include a	442	Calls C<rxvt_warn> with the given string which should include a trailing
664	newline. The module also overwrites the C<warn> builtin with a function	443	newline. The module also overwrites the C<warn> builtin with a function
665	that calls this function.	444	that calls this function.
666		445
667	Using this function has the advantage that its output ends up in the	446	Using this function has the advantage that its output ends up in the
668	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
669		448
670	Messages have a size limit of 1023 bytes currently.	449	Messages have a size limit of 1023 bytes currently.
		450
		451	=item @terms = urxvt::termlist
		452
		453	Returns all urxvt::term objects that exist in this process, regardless of
		454	whether they are started, being destroyed etc., so be careful. Only term
		455	objects that have perl extensions attached will be returned (because there
		456	is no urxvt::term object associated with others).
671		457
672	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
673		459
674	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
675		461
…		…
718		504
719	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
720		506
721	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
722		508
723	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	509	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		510	urxvt::RS_RVid, urxvt::RS_Uline
724		511
725	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
726	underline, respectively. To enable such a style, just logically OR it into	513	underline, respectively. To enable such a style, just logically OR it into
727	the bitset.	514	the bitset.
728		515
…		…
733	Return the foreground/background colour index, respectively.	520	Return the foreground/background colour index, respectively.
734		521
735	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	522	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
736		523
737	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	524	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		525
		526	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
738		527
739	Replace the foreground/background colour in the rendition mask with the	528	Replace the foreground/background colour in the rendition mask with the
740	specified one.	529	specified one.
741		530
742	=item $value = urxvt::GET_CUSTOM $rend	531	=item $value = urxvt::GET_CUSTOM $rend
…		…
763	};	552	};
764	}	553	}
765		554
766	no warnings 'utf8';	555	no warnings 'utf8';
767		556
		557	sub parse_resource {
		558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		559
		560	$name =~ y/-/./ if $isarg;
		561
		562	$term->scan_meta;
		563
		564	my $r = $term->{meta}{resource};
		565	keys %$r; # reset iterator
		566	while (my ($pattern, $v) = each %$r) {
		567	if (
		568	$pattern =~ /\.$/
		569	? $pattern eq substr $name, 0, length $pattern
		570	: $pattern eq $name
		571	) {
		572	$name = "$urxvt::RESCLASS.$name";
		573
		574	push @{ $term->{perl_ext_3} }, $v->[0];
		575
		576	if ($v->[1] eq "boolean") {
		577	$term->put_option_db ($name, $flag ? "true" : "false");
		578	return 1;
		579	} else {
		580	$term->put_option_db ($name, $value);
		581	return 1 + 2;
		582	}
		583	}
		584	}
		585
		586	0
		587	}
		588
		589	sub usage {
		590	my ($term, $usage_type) = @_;
		591
		592	$term->scan_meta;
		593
		594	my $r = $term->{meta}{resource};
		595
		596	for my $pattern (sort keys %$r) {
		597	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		598
		599	$desc .= " (-pe $ext)";
		600
		601	if ($usage_type == 1) {
		602	$pattern =~ y/./-/;
		603	$pattern =~ s/-$/-.../g;
		604
		605	if ($type eq "boolean") {
		606	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		607	} else {
		608	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		609	}
		610	} else {
		611	$pattern =~ s/\.$/.*/g;
		612	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		613	}
		614	}
		615	}
		616
768	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
769		618
770	sub verbose {	619	sub verbose {
771	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
772	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
…		…
784	$pkg =~ s/[^[:word:]]/_/g;	633	$pkg =~ s/[^[:word:]]/_/g;
785	$pkg = "urxvt::ext::$pkg";	634	$pkg = "urxvt::ext::$pkg";
786		635
787	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
788		637
		638	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		639
789	open my $fh, "<:raw", $path	640	open my $fh, "<:raw", $path
790	or die "$path: $!";	641	or die "$path: $!";
791		642
792	my $source =	643	my $source =
793	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	644	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
794	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
795	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
796	. "\n};\n1";	647	. "\n};\n1";
797		648
798	eval $source	649	eval $source
…		…
807	# called by the rxvt core	658	# called by the rxvt core
808	sub invoke {	659	sub invoke {
809	local $TERM = shift;	660	local $TERM = shift;
810	my $htype = shift;	661	my $htype = shift;
811		662
812	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
813	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = $TERM->perl_libdirs;
814		665
815	my %ext_arg;	666	my %ext_arg;
816		667
817	{	668	{
818	my @init = @TERM_INIT;	669	my @init = @TERM_INIT;
819	@TERM_INIT = ();	670	@TERM_INIT = ();
…		…
821	my @pkg = @TERM_EXT;	672	my @pkg = @TERM_EXT;
822	@TERM_EXT = ();	673	@TERM_EXT = ();
823	$TERM->register_package ($_) for @pkg;	674	$TERM->register_package ($_) for @pkg;
824	}	675	}
825		676
		677	for (
		678	@{ delete $TERM->{perl_ext_3} },
826	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	679	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		680	) {
827	if ($_ eq "default") {	681	if ($_ eq "default") {
828	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	682	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
829	} elsif (/^-(.*)$/) {	683	} elsif (/^-(.*)$/) {
830	delete $ext_arg{$1};	684	delete $ext_arg{$1};
831	} elsif (/^([^<]+)<(.*)>$/) {	685	} elsif (/^([^<]+)<(.*)>$/) {
…		…
833	} else {	687	} else {
834	$ext_arg{$_} ||= [];	688	$ext_arg{$_} ||= [];
835	}	689	}
836	}	690	}
837		691
838	while (my ($ext, $argv) = each %ext_arg) {	692	for my $ext (sort keys %ext_arg) {
839	my @files = grep -f $_, map "$_/$ext", @dirs;	693	my @files = grep -f $_, map "$_/$ext", @dirs;
840		694
841	if (@files) {	695	if (@files) {
842	$TERM->register_package (extension_package $files[0], $argv);	696	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
843	} else {	697	} else {
844	warn "perl extension '$ext' not found in perl library search path\n";	698	warn "perl extension '$ext' not found in perl library search path\n";
845	}	699	}
846	}	700	}
847		701
…		…
853		707
854	if (my $cb = $TERM->{_hook}[$htype]) {	708	if (my $cb = $TERM->{_hook}[$htype]) {
855	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	709	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
856	if $verbosity >= 10;	710	if $verbosity >= 10;
857		711
		712	for my $pkg (
		713	# this hook is only sent to the extension with the name
		714	# matching the first arg
		715	$htype == HOOK_KEYBOARD_DISPATCH
		716	? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
858	keys %$cb;	717	: keys %$cb
859		718	) {
860	while (my ($pkg, $cb) = each %$cb) {
861	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	719	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
862	$retval ||= $retval_;	720	$retval ||= $retval_;
863		721
864	if ($@) {	722	if ($@) {
865	$TERM->ungrab; # better to lose the grab than the session	723	$TERM->ungrab; # better to lose the grab than the session
866	warn $@;	724	warn $@;
…		…
869		727
870	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	728	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
871	if $verbosity >= 11;	729	if $verbosity >= 11;
872	}	730	}
873		731
874	if ($htype == 1) { # DESTROY	732	if ($htype == HOOK_DESTROY) {
875	# clear package objects	733	# clear package objects
876	%$_ = () for values %{ $TERM->{_pkg} };	734	%$_ = () for values %{ $TERM->{_pkg} };
877		735
878	# clear package	736	# clear package
879	%$TERM = ();	737	%$TERM = ();
880	}	738	}
881		739
882	$retval	740	$retval
883	}	741	}
884		742
885	# urxvt::term::extension	743	sub SET_COLOR($$$) {
		744	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		745	}
		746
		747	sub rend2mask {
		748	no strict 'refs';
		749	my ($str, $mask) = (@_, 0);
		750	my %color = ( fg => undef, bg => undef );
		751	my @failed;
		752	for my $spec ( split /\s+/, $str ) {
		753	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		754	$color{lc($1)} = $2;
		755	} else {
		756	my $neg = $spec =~ s/^[-^]//;
		757	unless ( exists &{"RS_$spec"} ) {
		758	push @failed, $spec;
		759	next;
		760	}
		761	my $cur = &{"RS_$spec"};
		762	if ( $neg ) {
		763	$mask &= ~$cur;
		764	} else {
		765	$mask |= $cur;
		766	}
		767	}
		768	}
		769	($mask, @color{qw(fg bg)}, \@failed)
		770	}
886		771
887	package urxvt::term::extension;	772	package urxvt::term::extension;
888		773
889	sub enable {	774	=head2 The C<urxvt::term::extension> class
890	my ($self, %hook) = @_;
891	my $pkg = $self->{_pkg};
892		775
893	while (my ($name, $cb) = each %hook) {	776	Each extension attached to a terminal object is represented by
894	my $htype = $HOOKTYPE{uc $name};	777	a C<urxvt::term::extension> object.
895	defined $htype
896	or Carp::croak "unsupported hook type '$name'";
897		778
898	$self->set_should_invoke ($htype, +1)	779	You can use these objects, which are passed to all callbacks to store any
899	unless exists $self->{term}{_hook}[$htype]{$pkg};	780	state related to the terminal and extension instance.
900		781
901	$self->{term}{_hook}[$htype]{$pkg} = $cb;	782	The methods (And data members) documented below can be called on extension
902	}	783	objects, in addition to call methods documented for the <urxvt::term>
903	}	784	class.
904		785
905	sub disable {	786	=over 4
906	my ($self, @hook) = @_;
907	my $pkg = $self->{_pkg};
908		787
909	for my $name (@hook) {	788	=item $urxvt_term = $self->{term}
910	my $htype = $HOOKTYPE{uc $name};
911	defined $htype
912	or Carp::croak "unsupported hook type '$name'";
913		789
914	$self->set_should_invoke ($htype, -1)	790	Returns the C<urxvt::term> object associated with this instance of the
915	if delete $self->{term}{_hook}[$htype]{$pkg};	791	extension. This member I<must not> be changed in any way.
916	}	792
917	}	793	=cut
918		794
919	our $AUTOLOAD;	795	our $AUTOLOAD;
920		796
921	sub AUTOLOAD {	797	sub AUTOLOAD {
922	$AUTOLOAD =~ /:([^:]+)$/	798	$AUTOLOAD =~ /:([^:]+)$/
…		…
935		811
936	sub DESTROY {	812	sub DESTROY {
937	# nop	813	# nop
938	}	814	}
939		815
940	# urxvt::destroy_hook	816	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
941		817
942	sub urxvt::destroy_hook::DESTROY {	818	sub urxvt::destroy_hook::DESTROY {
943	${$_[0]}->();	819	${$_[0]}->();
944	}	820	}
945		821
946	sub urxvt::destroy_hook(&) {	822	sub urxvt::destroy_hook(&) {
947	bless \shift, urxvt::destroy_hook::	823	bless \shift, urxvt::destroy_hook::
948	}	824	}
		825
		826	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		827
		828	Dynamically enable the given hooks (named without the C<on_> prefix) for
		829	this extension, replacing any hook previously installed via C<enable> in
		830	this extension.
		831
		832	This is useful when you want to overwrite time-critical hooks only
		833	temporarily.
		834
		835	To install additional callbacks for the same hook, you can use the C<on>
		836	method of the C<urxvt::term> class.
		837
		838	=item $self->disable ($hook_name[, $hook_name..])
		839
		840	Dynamically disable the given hooks.
		841
		842	=cut
		843
		844	sub enable {
		845	my ($self, %hook) = @_;
		846	my $pkg = $self->{_pkg};
		847
		848	while (my ($name, $cb) = each %hook) {
		849	my $htype = $HOOKTYPE{uc $name};
		850	defined $htype
		851	or Carp::croak "unsupported hook type '$name'";
		852
		853	$self->set_should_invoke ($htype, +1)
		854	unless exists $self->{term}{_hook}[$htype]{$pkg};
		855
		856	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		857	}
		858	}
		859
		860	sub disable {
		861	my ($self, @hook) = @_;
		862	my $pkg = $self->{_pkg};
		863
		864	for my $name (@hook) {
		865	my $htype = $HOOKTYPE{uc $name};
		866	defined $htype
		867	or Carp::croak "unsupported hook type '$name'";
		868
		869	$self->set_should_invoke ($htype, -1)
		870	if delete $self->{term}{_hook}[$htype]{$pkg};
		871	}
		872	}
		873
		874	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		875
		876	Similar to the C<enable> enable, but installs additional callbacks for
		877	the given hook(s) (that is, it doesn't replace existing callbacks), and
		878	returns a guard object. When the guard object is destroyed the callbacks
		879	are disabled again.
		880
		881	=cut
		882
		883	sub urxvt::extension::on_disable::DESTROY {
		884	my $disable = shift;
		885
		886	my $term = delete $disable->{""};
		887
		888	while (my ($htype, $id) = each %$disable) {
		889	delete $term->{_hook}[$htype]{$id};
		890	$term->set_should_invoke ($htype, -1);
		891	}
		892	}
		893
		894	sub on {
		895	my ($self, %hook) = @_;
		896
		897	my $term = $self->{term};
		898
		899	my %disable = ( "" => $term );
		900
		901	while (my ($name, $cb) = each %hook) {
		902	my $htype = $HOOKTYPE{uc $name};
		903	defined $htype
		904	or Carp::croak "unsupported hook type '$name'";
		905
		906	$term->set_should_invoke ($htype, +1);
		907	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		908	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		909	}
		910
		911	bless \%disable, "urxvt::extension::on_disable"
		912	}
		913
		914	=item $self->x_resource ($pattern)
		915
		916	=item $self->x_resource_boolean ($pattern)
		917
		918	These methods support an additional C<%> prefix when called on an
		919	extension object - see the description of these methods in the
		920	C<urxvt::term> class for details.
		921
		922	=cut
		923
		924	sub x_resource {
		925	my ($self, $name) = @_;
		926	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		927	$self->{term}->x_resource ($name)
		928	}
		929
		930	sub x_resource_boolean {
		931	my ($self, $name) = @_;
		932	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		933	$self->{term}->x_resource_boolean ($name)
		934	}
		935
		936	=back
		937
		938	=cut
949		939
950	package urxvt::anyevent;	940	package urxvt::anyevent;
951		941
952	=head2 The C<urxvt::anyevent> Class	942	=head2 The C<urxvt::anyevent> Class
953		943
954	The sole purpose of this class is to deliver an interface to the	944	The sole purpose of this class is to deliver an interface to the
955	C<AnyEvent> module - any module using it will work inside urxvt without	945	C<AnyEvent> module - any module using it will work inside urxvt without
956	further programming. The only exception is that you cannot wait on	946	further programming. The only exception is that you cannot wait on
957	condition variables, but non-blocking condvar use is ok. What this means	947	condition variables, but non-blocking condvar use is ok.
958	is that you cannot use blocking APIs, but the non-blocking variant should
959	work.
960		948
961	=cut	949	In practical terms this means is that you cannot use blocking APIs, but
		950	the non-blocking variant should work.
962		951
		952	=cut
		953
963	our $VERSION = 1;	954	our $VERSION = '5.23';
964		955
965	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	956	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
966	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	957	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
967		958
968	sub timer {	959	sub timer {
…		…
970		961
971	my $cb = $arg{cb};	962	my $cb = $arg{cb};
972		963
973	urxvt::timer	964	urxvt::timer
974	->new	965	->new
975	->start (urxvt::NOW + $arg{after})	966	->after ($arg{after}, $arg{interval})
976	->cb (sub {	967	->cb ($arg{interval} ? $cb : sub {
977	$_[0]->stop; # need to cancel manually	968	$_[0]->stop; # need to cancel manually
978	$cb->();	969	$cb->();
979	})	970	})
980	}	971	}
981		972
982	sub io {	973	sub io {
983	my ($class, %arg) = @_;	974	my ($class, %arg) = @_;
984		975
985	my $cb = $arg{cb};	976	my $cb = $arg{cb};
		977	my $fd = fileno $arg{fh};
		978	defined $fd or $fd = $arg{fh};
986		979
987	bless [$arg{fh}, urxvt::iow	980	bless [$arg{fh}, urxvt::iow
988	->new	981	->new
989	->fd (fileno $arg{fh})	982	->fd ($fd)
990	->events (($arg{poll} =~ /r/ ? 1 : 0)	983	->events (($arg{poll} =~ /r/ ? 1 : 0)
991	| ($arg{poll} =~ /w/ ? 2 : 0))	984	| ($arg{poll} =~ /w/ ? 2 : 0))
992	->start	985	->start
993	->cb (sub {	986	->cb ($cb)
994	$cb->(($_[1] & 1 ? 'r' : '')
995	. ($_[1] & 2 ? 'w' : ''));
996	})],
997	urxvt::anyevent::	987	], urxvt::anyevent::
		988	}
		989
		990	sub idle {
		991	my ($class, %arg) = @_;
		992
		993	my $cb = $arg{cb};
		994
		995	urxvt::iw
		996	->new
		997	->start
		998	->cb ($cb)
		999	}
		1000
		1001	sub child {
		1002	my ($class, %arg) = @_;
		1003
		1004	my $cb = $arg{cb};
		1005
		1006	urxvt::pw
		1007	->new
		1008	->start ($arg{pid})
		1009	->cb (sub {
		1010	$_[0]->stop; # need to cancel manually
		1011	$cb->($_[0]->rpid, $_[0]->rstatus);
		1012	})
998	}	1013	}
999		1014
1000	sub DESTROY {	1015	sub DESTROY {
1001	$_[0][1]->stop;	1016	$_[0][1]->stop;
1002	}	1017	}
1003		1018
1004	sub condvar {	1019	# only needed for AnyEvent < 6 compatibility
1005	bless \my $flag, urxvt::anyevent::condvar::	1020	sub one_event {
1006	}
1007
1008	sub urxvt::anyevent::condvar::broadcast {
1009	${$_[0]}++;
1010	}
1011
1012	sub urxvt::anyevent::condvar::wait {
1013	unless (${$_[0]}) {
1014	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1021	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1015	}
1016	}	1022	}
1017		1023
1018	package urxvt::term;	1024	package urxvt::term;
1019		1025
1020	=head2 The C<urxvt::term> Class	1026	=head2 The C<urxvt::term> Class
…		…
1033	urxvt::verbose 6, "register package $pkg to $self";	1039	urxvt::verbose 6, "register package $pkg to $self";
1034		1040
1035	@{"$pkg\::ISA"} = urxvt::term::extension::;	1041	@{"$pkg\::ISA"} = urxvt::term::extension::;
1036		1042
1037	my $proxy = bless {	1043	my $proxy = bless {
1038	_pkg => $pkg,	1044	_pkg => $pkg,
		1045	_name => ${"$pkg\::_NAME"}, # hackish
1039	argv => $argv,	1046	argv => $argv,
1040	}, $pkg;	1047	}, $pkg;
1041	Scalar::Util::weaken ($proxy->{term} = $self);	1048	Scalar::Util::weaken ($proxy->{term} = $self);
1042		1049
1043	$self->{_pkg}{$pkg} = $proxy;	1050	$self->{_pkg}{$pkg} = $proxy;
1044		1051
…		…
1047	$proxy->enable ($name => $ref);	1054	$proxy->enable ($name => $ref);
1048	}	1055	}
1049	}	1056	}
1050	}	1057	}
1051		1058
		1059	sub perl_libdirs {
		1060	map { split /:/ }
		1061	$_[0]->resource ("perl_lib"),
		1062	$ENV{URXVT_PERL_LIB},
		1063	"$ENV{HOME}/.urxvt/ext",
		1064	"$LIBDIR/perl"
		1065	}
		1066
		1067	sub scan_meta {
		1068	my ($self) = @_;
		1069	my @libdirs = perl_libdirs $self;
		1070
		1071	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1072
		1073	my %meta;
		1074
		1075	$self->{meta_libdirs} = join "\x00", @libdirs;
		1076	$self->{meta} = \%meta;
		1077
		1078	for my $dir (reverse @libdirs) {
		1079	opendir my $fh, $dir
		1080	or next;
		1081	for my $ext (readdir $fh) {
		1082	$ext !~ /^\./
		1083	and open my $fh, "<", "$dir/$ext"
		1084	or next;
		1085
		1086	while (<$fh>) {
		1087	if (/^#:META:X_RESOURCE:(.*)/) {
		1088	my ($pattern, $type, $desc) = split /:/, $1;
		1089	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1090	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1091	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1092	} else {
		1093	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1094	}
		1095	} elsif (/^\s*(?:#|$)/) {
		1096	# skip other comments and empty lines
		1097	} else {
		1098	last; # stop parsing on first non-empty non-comment line
		1099	}
		1100	}
		1101	}
		1102	}
		1103	}
		1104
1052	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1105	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1053		1106
1054	Creates a new terminal, very similar as if you had started it with system	1107	Creates a new terminal, very similar as if you had started it with system
1055	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1108	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1056	hash which defines the environment of the new terminal.	1109	hash which defines the environment of the new terminal.
1057		1110
1058	Croaks (and probably outputs an error message) if the new instance	1111	Croaks (and probably outputs an error message) if the new instance
1059	couldn't be created. Returns C<undef> if the new instance didn't	1112	couldn't be created. Returns C<undef> if the new instance didn't
1060	initialise perl, and the terminal object otherwise. The C<init> and	1113	initialise perl, and the terminal object otherwise. The C<init> and
1061	C<start> hooks will be called during this call.	1114	C<start> hooks will be called before this call returns, and are free to
		1115	refer to global data (which is race free).
1062		1116
1063	=cut	1117	=cut
1064		1118
1065	sub new {	1119	sub new {
1066	my ($class, $env, @args) = @_;	1120	my ($class, $env, @args) = @_;
1067		1121
		1122	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1123	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1124
1068	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1125	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1069	}	1126	}
1070		1127
1071	=item $term->destroy	1128	=item $term->destroy
1072		1129
1073	Destroy the terminal object (close the window, free resources	1130	Destroy the terminal object (close the window, free resources
1074	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1131	etc.). Please note that urxvt will not exit as long as any event
1075	watchers (timers, io watchers) are still active.	1132	watchers (timers, io watchers) are still active.
1076		1133
1077	=item $term->exec_async ($cmd[, @args])	1134	=item $term->exec_async ($cmd[, @args])
1078		1135
1079	Works like the combination of the C<fork>/C<exec> builtins, which executes	1136	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1103		1160
1104	Returns true if the option specified by C<$optval> is enabled, and	1161	Returns true if the option specified by C<$optval> is enabled, and
1105	optionally change it. All option values are stored by name in the hash	1162	optionally change it. All option values are stored by name in the hash
1106	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1163	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1107		1164
1108	Here is a a likely non-exhaustive list of option names, please see the	1165	Here is a likely non-exhaustive list of option names, please see the
1109	source file F</src/optinc.h> to see the actual list:	1166	source file F</src/optinc.h> to see the actual list:
1110		1167
1111	borderLess console cursorBlink cursorUnderline hold iconic insecure	1168	borderLess buffered console cursorBlink cursorUnderline hold iconic
1112	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1169	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1113	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1170	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1114	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1171	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1115	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1172	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1116	transparent tripleclickwords utmpInhibit visualBell	1173	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1174	urgentOnBell utmpInhibit visualBell
1117		1175
1118	=item $value = $term->resource ($name[, $newval])	1176	=item $value = $term->resource ($name[, $newval])
1119		1177
1120	Returns the current resource value associated with a given name and	1178	Returns the current resource value associated with a given name and
1121	optionally sets a new value. Setting values is most useful in the C<init>	1179	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1130	likely change).	1188	likely change).
1131		1189
1132	Please note that resource strings will currently only be freed when the	1190	Please note that resource strings will currently only be freed when the
1133	terminal is destroyed, so changing options frequently will eat memory.	1191	terminal is destroyed, so changing options frequently will eat memory.
1134		1192
1135	Here is a a likely non-exhaustive list of resource names, not all of which	1193	Here is a likely non-exhaustive list of resource names, not all of which
1136	are supported in every build, please see the source file F</src/rsinc.h>	1194	are supported in every build, please see the source file F</src/rsinc.h>
1137	to see the actual list:	1195	to see the actual list:
1138		1196
1139	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1197	answerbackstring backgroundPixmap backspace_key blurradius
1140	borderLess color cursorBlink cursorUnderline cutchars delete_key	1198	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1141	display_name embed ext_bwidth fade font geometry hold iconName	1199	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1142	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1200	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1201	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1143	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1202	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1144	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1203	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1145	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1204	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1146	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1205	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1147	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1206	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1148	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1207	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1149	secondaryScreen secondaryScroll selectstyle shade term_name title	1208	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1150	transient_for transparent transparent_all tripleclickwords utmpInhibit	1209	term_name title transient_for transparent tripleclickwords urgentOnBell
1151	visualBell	1210	utmpInhibit visualBell
1152		1211
1153	=cut	1212	=cut
1154		1213
1155	sub resource($$;$) {	1214	sub resource($$;$) {
1156	my ($self, $name) = (shift, shift);	1215	my ($self, $name) = (shift, shift);
1157	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1216	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1158	&urxvt::term::_resource	1217	goto &urxvt::term::_resource
1159	}	1218	}
1160		1219
1161	=item $value = $term->x_resource ($pattern)	1220	=item $value = $term->x_resource ($pattern)
1162		1221
1163	Returns the X-Resource for the given pattern, excluding the program or	1222	Returns the X-Resource for the given pattern, excluding the program or
1164	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1223	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1165	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1224	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1166	resource with that pattern exists.	1225	resource with that pattern exists.
1167		1226
		1227	Extensions that define extra resource or command line arguments also need
		1228	to call this method to access their values.
		1229
		1230	If the method is called on an extension object (basically, from an
		1231	extension), then the special prefix C<%.> will be replaced by the name of
		1232	the extension and a dot, and the lone string C<%> will be replaced by the
		1233	extension name itself. This makes it possible to code extensions so you
		1234	can rename them and get a new set of commandline switches and resources
		1235	without having to change the actual code.
		1236
1168	This method should only be called during the C<on_start> hook, as there is	1237	This method should only be called during the C<on_start> hook, as there is
1169	only one resource database per display, and later invocations might return	1238	only one resource database per display, and later invocations might return
1170	the wrong resources.	1239	the wrong resources.
1171		1240
1172	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1241	=item $value = $term->x_resource_boolean ($pattern)
1173		1242
		1243	Like C<x_resource>, above, but interprets the string value as a boolean
		1244	and returns C<1> for true values, C<0> for false values and C<undef> if
		1245	the resource or option isn't specified.
		1246
		1247	You should always use this method to parse boolean resources.
		1248
		1249	=cut
		1250
		1251	sub x_resource_boolean {
		1252	my $res = &x_resource;
		1253
		1254	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1255	}
		1256
		1257	=item $success = $term->bind_action ($key, $octets)
		1258
1174	Adds a keymap translation exactly as specified via a resource. See the	1259	Adds a key binding exactly as specified via a resource. See the
1175	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1260	C<keysym> resource in the urxvt(1) manpage.
1176		1261
1177	=item $rend = $term->rstyle ([$new_rstyle])	1262	=item $rend = $term->rstyle ([$new_rstyle])
1178		1263
1179	Return and optionally change the current rendition. Text that is output by	1264	Return and optionally change the current rendition. Text that is output by
1180	the terminal application will use this style.	1265	the terminal application will use this style.
…		…
1188		1273
1189	=item ($row, $col) = $term->selection_beg ([$row, $col])	1274	=item ($row, $col) = $term->selection_beg ([$row, $col])
1190		1275
1191	=item ($row, $col) = $term->selection_end ([$row, $col])	1276	=item ($row, $col) = $term->selection_end ([$row, $col])
1192		1277
1193	Return the current values of the selection mark, begin or end positions,	1278	Return the current values of the selection mark, begin or end positions.
1194	and optionally set them to new values.	1279
		1280	When arguments are given, then the selection coordinates are set to
		1281	C<$row> and C<$col>, and the selection screen is set to the current
		1282	screen.
		1283
		1284	=item $screen = $term->selection_screen ([$screen])
		1285
		1286	Returns the current selection screen, and then optionally sets it.
1195		1287
1196	=item $term->selection_make ($eventtime[, $rectangular])	1288	=item $term->selection_make ($eventtime[, $rectangular])
1197		1289
1198	Tries to make a selection as set by C<selection_beg> and	1290	Tries to make a selection as set by C<selection_beg> and
1199	C<selection_end>. If C<$rectangular> is true (default: false), a	1291	C<selection_end>. If C<$rectangular> is true (default: false), a
1200	rectangular selection will be made. This is the prefered function to make	1292	rectangular selection will be made. This is the preferred function to make
1201	a selection.	1293	a selection.
1202		1294
1203	=item $success = $term->selection_grab ($eventtime)	1295	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1204		1296
1205	Try to request the primary selection text from the server (for example, as	1297	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1298	true) selection from the server. The corresponding text can be set
1206	set by the next method). No visual feedback will be given. This function	1299	with the next method. No visual feedback will be given. This function
1207	is mostly useful from within C<on_sel_grab> hooks.	1300	is mostly useful from within C<on_sel_grab> hooks.
1208		1301
1209	=item $oldtext = $term->selection ([$newtext])	1302	=item $oldtext = $term->selection ([$newtext, $clipboard])
1210		1303
1211	Return the current selection text and optionally replace it by C<$newtext>.	1304	Return the current selection (clipboard if C<$clipboard> is true) text
		1305	and optionally replace it by C<$newtext>.
		1306
		1307	=item $term->selection_clear ([$clipboard])
		1308
		1309	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1212		1310
1213	=item $term->overlay_simple ($x, $y, $text)	1311	=item $term->overlay_simple ($x, $y, $text)
1214		1312
1215	Create a simple multi-line overlay box. See the next method for details.	1313	Create a simple multi-line overlay box. See the next method for details.
1216		1314
…		…
1246		1344
1247	The methods currently supported on C<urxvt::overlay> objects are:	1345	The methods currently supported on C<urxvt::overlay> objects are:
1248		1346
1249	=over 4	1347	=over 4
1250		1348
1251	=item $overlay->set ($x, $y, $text, $rend)	1349	=item $overlay->set ($x, $y, $text[, $rend])
1252		1350
1253	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1351	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1254	text in rxvt-unicode's special encoding and an array of rendition values	1352	text in rxvt-unicode's special encoding and an array of rendition values
1255	at a specific position inside the overlay.	1353	at a specific position inside the overlay.
		1354
		1355	If C<$rend> is missing, then the rendition will not be changed.
1256		1356
1257	=item $overlay->hide	1357	=item $overlay->hide
1258		1358
1259	If visible, hide the overlay, but do not destroy it.	1359	If visible, hide the overlay, but do not destroy it.
1260		1360
…		…
1342	locale-specific encoding of the terminal and can contain command sequences	1442	locale-specific encoding of the terminal and can contain command sequences
1343	(escape codes) that will be interpreted.	1443	(escape codes) that will be interpreted.
1344		1444
1345	=item $term->tt_write ($octets)	1445	=item $term->tt_write ($octets)
1346		1446
1347	Write the octets given in C<$data> to the tty (i.e. as program input). To	1447	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1348	pass characters instead of octets, you should convert your strings first	1448	pass characters instead of octets, you should convert your strings first
1349	to the locale-specific encoding using C<< $term->locale_encode >>.	1449	to the locale-specific encoding using C<< $term->locale_encode >>.
		1450
		1451	=item $term->tt_paste ($octets)
		1452
		1453	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1454	CR and bracketing the data with control sequences if bracketed paste mode
		1455	is set.
1350		1456
1351	=item $old_events = $term->pty_ev_events ([$new_events])	1457	=item $old_events = $term->pty_ev_events ([$new_events])
1352		1458
1353	Replaces the event mask of the pty watcher by the given event mask. Can	1459	Replaces the event mask of the pty watcher by the given event mask. Can
1354	be used to suppress input and output handling to the pty/tty. See the	1460	be used to suppress input and output handling to the pty/tty. See the
…		…
1373	Adds the specified events to the vt event mask. Useful e.g. when you want	1479	Adds the specified events to the vt event mask. Useful e.g. when you want
1374	to receive pointer events all the times:	1480	to receive pointer events all the times:
1375		1481
1376	$term->vt_emask_add (urxvt::PointerMotionMask);	1482	$term->vt_emask_add (urxvt::PointerMotionMask);
1377		1483
		1484	=item $term->set_urgency ($set)
		1485
		1486	Enable/disable the urgency hint on the toplevel window.
		1487
		1488	=item $term->focus_in
		1489
		1490	=item $term->focus_out
		1491
		1492	=item $term->key_press ($state, $keycode[, $time])
		1493
		1494	=item $term->key_release ($state, $keycode[, $time])
		1495
		1496	Deliver various fake events to to terminal.
		1497
1378	=item $window_width = $term->width	1498	=item $window_width = $term->width
1379		1499
1380	=item $window_height = $term->height	1500	=item $window_height = $term->height
1381		1501
1382	=item $font_width = $term->fwidth	1502	=item $font_width = $term->fwidth
…		…
1412	=item $env = $term->env	1532	=item $env = $term->env
1413		1533
1414	Returns a copy of the environment in effect for the terminal as a hashref	1534	Returns a copy of the environment in effect for the terminal as a hashref
1415	similar to C<\%ENV>.	1535	similar to C<\%ENV>.
1416		1536
		1537	=item @envv = $term->envv
		1538
		1539	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1540
		1541	=item @argv = $term->argv
		1542
		1543	Return the argument vector as this terminal, similar to @ARGV, but
		1544	includes the program name as first element.
		1545
1417	=cut	1546	=cut
1418		1547
1419	sub env {	1548	sub env {
1420	if (my $env = $_[0]->_env) {
1421	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1549	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1422	} else {
1423	+{ %ENV }
1424	}
1425	}	1550	}
1426		1551
1427	=item $modifiermask = $term->ModLevel3Mask	1552	=item $modifiermask = $term->ModLevel3Mask
1428		1553
1429	=item $modifiermask = $term->ModMetaMask	1554	=item $modifiermask = $term->ModMetaMask
…		…
1437		1562
1438	Returns the currently displayed screen (0 primary, 1 secondary).	1563	Returns the currently displayed screen (0 primary, 1 secondary).
1439		1564
1440	=item $cursor_is_hidden = $term->hidden_cursor	1565	=item $cursor_is_hidden = $term->hidden_cursor
1441		1566
1442	Returns wether the cursor is currently hidden or not.	1567	Returns whether the cursor is currently hidden or not.
1443		1568
1444	=item $view_start = $term->view_start ([$newvalue])	1569	=item $view_start = $term->view_start ([$newvalue])
1445		1570
1446	Returns the row number of the topmost displayed line. Maximum value is	1571	Returns the row number of the topmost displayed line. Maximum value is
1447	C<0>, which displays the normal terminal contents. Lower values scroll	1572	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1455		1580
1456	Used after changing terminal contents to display them.	1581	Used after changing terminal contents to display them.
1457		1582
1458	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1583	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1459		1584
1460	Returns the text of the entire row with number C<$row_number>. Row C<0>	1585	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1461	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1586	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1462	terminal line. The scrollback buffer starts at line C<-1> and extends to
1463	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1587	terminal line. Nothing will be returned if a nonexistent line
1464	is requested.	1588	is requested.
1465		1589
1466	If C<$new_text> is specified, it will replace characters in the current	1590	If C<$new_text> is specified, it will replace characters in the current
1467	line, starting at column C<$start_col> (default C<0>), which is useful	1591	line, starting at column C<$start_col> (default C<0>), which is useful
1468	to replace only parts of a line. The font index in the rendition will	1592	to replace only parts of a line. The font index in the rendition will
1469	automatically be updated.	1593	automatically be updated.
1470		1594
1471	C<$text> is in a special encoding: tabs and wide characters that use more	1595	C<$text> is in a special encoding: tabs and wide characters that use more
1472	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1596	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1473	characters. Characters with combining characters and other characters that	1597	characters. Characters with combining characters and other characters that
1474	do not fit into the normal tetx encoding will be replaced with characters	1598	do not fit into the normal text encoding will be replaced with characters
1475	in the private use area.	1599	in the private use area.
1476		1600
1477	You have to obey this encoding when changing text. The advantage is	1601	You have to obey this encoding when changing text. The advantage is
1478	that C<substr> and similar functions work on screen cells and not on	1602	that C<substr> and similar functions work on screen cells and not on
1479	characters.	1603	characters.
…		…
1564	}	1688	}
1565		1689
1566	sub urxvt::line::t {	1690	sub urxvt::line::t {
1567	my ($self) = @_;	1691	my ($self) = @_;
1568		1692
1569	if (@_ > 1)	1693	if (@_ > 1) {
1570	{
1571	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1694	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1572	for $self->{beg} .. $self->{end};	1695	for $self->{beg} .. $self->{end};
1573	}	1696	}
1574		1697
1575	defined wantarray &&	1698	defined wantarray &&
1576	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1699	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1577	0, $self->{len}	1700	0, $self->{len}
1578	}	1701	}
1579		1702
1580	sub urxvt::line::r {	1703	sub urxvt::line::r {
1581	my ($self) = @_;	1704	my ($self) = @_;
1582		1705
1583	if (@_ > 1)	1706	if (@_ > 1) {
1584	{
1585	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1707	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1586	for $self->{beg} .. $self->{end};	1708	for $self->{beg} .. $self->{end};
1587	}	1709	}
1588		1710
1589	if (defined wantarray) {	1711	if (defined wantarray) {
1590	my $rend = [	1712	my $rend = [
1591	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1713	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1592	];	1714	];
…		…
1624	where one character corresponds to one screen cell. See	1746	where one character corresponds to one screen cell. See
1625	C<< $term->ROW_t >> for details.	1747	C<< $term->ROW_t >> for details.
1626		1748
1627	=item $string = $term->special_decode $text	1749	=item $string = $term->special_decode $text
1628		1750
1629	Converts rxvt-unicodes text reprsentation into a perl string. See	1751	Converts rxvt-unicodes text representation into a perl string. See
1630	C<< $term->ROW_t >> for details.	1752	C<< $term->ROW_t >> for details.
1631		1753
1632	=item $success = $term->grab_button ($button, $modifiermask)	1754	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1633		1755
		1756	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1757
1634	Registers a synchronous button grab. See the XGrabButton manpage.	1758	Register/unregister a synchronous button grab. See the XGrabButton
		1759	manpage.
1635		1760
1636	=item $success = $term->grab ($eventtime[, $sync])	1761	=item $success = $term->grab ($eventtime[, $sync])
1637		1762
1638	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1763	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1639	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1764	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1640		1765
1641	=item $term->allow_events_async	1766	=item $term->allow_events_async
1642		1767
1643	Calls XAllowEvents with AsyncBoth for the most recent grab.	1768	Calls XAllowEvents with AsyncBoth for the most recent grab.
1644		1769
…		…
1651	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1776	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1652	recent grab.	1777	recent grab.
1653		1778
1654	=item $term->ungrab	1779	=item $term->ungrab
1655		1780
1656	Calls XUngrab for the most recent grab. Is called automatically on	1781	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1657	evaluation errors, as it is better to lose the grab in the error case as	1782	evaluation errors, as it is better to lose the grab in the error case as
1658	the session.	1783	the session.
1659		1784
1660	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1785	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1661		1786
…		…
1663		1788
1664	=item @atoms = $term->XListProperties ($window)	1789	=item @atoms = $term->XListProperties ($window)
1665		1790
1666	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1791	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1667		1792
1668	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1793	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1669		1794
1670	=item $term->XDeleteProperty ($window, $property)	1795	=item $term->XDeleteProperty ($window, $property)
1671		1796
1672	=item $window = $term->DefaultRootWindow	1797	=item $window = $term->DefaultRootWindow
1673		1798
…		…
1680	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1805	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1681		1806
1682	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1807	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1683		1808
1684	=item $term->XChangeInput ($window, $add_events[, $del_events])	1809	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1810
		1811	=item $keysym = $term->XStringToKeysym ($string)
		1812
		1813	=item $string = $term->XKeysymToString ($keysym)
1685		1814
1686	Various X or X-related functions. The C<$term> object only serves as	1815	Various X or X-related functions. The C<$term> object only serves as
1687	the source of the display, otherwise those functions map more-or-less	1816	the source of the display, otherwise those functions map more-or-less
1688	directory onto the X functions of the same name.	1817	directly onto the X functions of the same name.
1689		1818
1690	=back	1819	=back
1691		1820
1692	=cut	1821	=cut
1693		1822
…		…
1757	my ($self, $text, $cb) = @_;	1886	my ($self, $text, $cb) = @_;
1758		1887
1759	$self->add_item ({ type => "button", text => $text, activate => $cb});	1888	$self->add_item ({ type => "button", text => $text, activate => $cb});
1760	}	1889	}
1761		1890
1762	=item $popup->add_toggle ($text, $cb, $initial_value)	1891	=item $popup->add_toggle ($text, $initial_value, $cb)
1763		1892
1764	Adds a toggle/checkbox item to the popup. Teh callback gets called	1893	Adds a toggle/checkbox item to the popup. The callback gets called
1765	whenever it gets toggled, with a boolean indicating its value as its first	1894	whenever it gets toggled, with a boolean indicating its new value as its
1766	argument.	1895	first argument.
1767		1896
1768	=cut	1897	=cut
1769		1898
1770	sub add_toggle {	1899	sub add_toggle {
1771	my ($self, $text, $cb, $value) = @_;	1900	my ($self, $text, $value, $cb) = @_;
1772		1901
1773	my $item; $item = {	1902	my $item; $item = {
1774	type => "button",	1903	type => "button",
1775	text => " $text",	1904	text => " $text",
1776	value => $value,	1905	value => $value,
…		…
1795	my $env = $self->{term}->env;	1924	my $env = $self->{term}->env;
1796	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1925	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1797	delete $env->{LC_ALL};	1926	delete $env->{LC_ALL};
1798	$env->{LC_CTYPE} = $self->{term}->locale;	1927	$env->{LC_CTYPE} = $self->{term}->locale;
1799		1928
1800	urxvt::term->new ($env, "popup",	1929	my $term = urxvt::term->new (
		1930	$env, "popup",
1801	"--perl-lib" => "", "--perl-ext-common" => "",	1931	"--perl-lib" => "", "--perl-ext-common" => "",
1802	"-pty-fd" => -1, "-sl" => 0,	1932	"-pty-fd" => -1, "-sl" => 0,
1803	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1933	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1804	"--transient-for" => $self->{term}->parent,	1934	"--transient-for" => $self->{term}->parent,
1805	"-display" => $self->{term}->display_id,	1935	"-display" => $self->{term}->display_id,
1806	"-pe" => "urxvt-popup")	1936	"-pe" => "urxvt-popup",
1807	or die "unable to create popup window\n";	1937	) or die "unable to create popup window\n";
		1938
		1939	unless (delete $term->{urxvt_popup_init_done}) {
		1940	$term->ungrab;
		1941	$term->destroy;
		1942	die "unable to initialise popup window\n";
		1943	}
1808	}	1944	}
1809		1945
1810	sub DESTROY {	1946	sub DESTROY {
1811	my ($self) = @_;	1947	my ($self) = @_;
1812		1948
…		…
1817	=back	1953	=back
1818		1954
1819	=cut	1955	=cut
1820		1956
1821	package urxvt::watcher;	1957	package urxvt::watcher;
1822
1823	@urxvt::timer::ISA = __PACKAGE__;
1824	@urxvt::iow::ISA = __PACKAGE__;
1825	@urxvt::pw::ISA = __PACKAGE__;
1826	@urxvt::iw::ISA = __PACKAGE__;
1827		1958
1828	=head2 The C<urxvt::timer> Class	1959	=head2 The C<urxvt::timer> Class
1829		1960
1830	This class implements timer watchers/events. Time is represented as a	1961	This class implements timer watchers/events. Time is represented as a
1831	fractional number of seconds since the epoch. Example:	1962	fractional number of seconds since the epoch. Example:
…		…
1835	->new	1966	->new
1836	->interval (1)	1967	->interval (1)
1837	->cb (sub {	1968	->cb (sub {
1838	$term->{overlay}->set (0, 0,	1969	$term->{overlay}->set (0, 0,
1839	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1970	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1840	});	1971	});
1841		1972
1842	=over 4	1973	=over 4
1843		1974
1844	=item $timer = new urxvt::timer	1975	=item $timer = new urxvt::timer
1845		1976
…		…
1848		1979
1849	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1980	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1850		1981
1851	Set the callback to be called when the timer triggers.	1982	Set the callback to be called when the timer triggers.
1852		1983
1853	=item $tstamp = $timer->at
1854
1855	Return the time this watcher will fire next.
1856
1857	=item $timer = $timer->set ($tstamp)	1984	=item $timer = $timer->set ($tstamp[, $interval])
1858		1985
1859	Set the time the event is generated to $tstamp.	1986	Set the time the event is generated to $tstamp (and optionally specifies a
		1987	new $interval).
1860		1988
1861	=item $timer = $timer->interval ($interval)	1989	=item $timer = $timer->interval ($interval)
1862		1990
1863	Normally (and when C<$interval> is C<0>), the timer will automatically	1991	By default (and when C<$interval> is C<0>), the timer will automatically
1864	stop after it has fired once. If C<$interval> is non-zero, then the timer	1992	stop after it has fired once. If C<$interval> is non-zero, then the timer
1865	is automatically rescheduled at the given intervals.	1993	is automatically rescheduled at the given intervals.
1866		1994
1867	=item $timer = $timer->start	1995	=item $timer = $timer->start
1868		1996
1869	Start the timer.	1997	Start the timer.
1870		1998
1871	=item $timer = $timer->start ($tstamp)	1999	=item $timer = $timer->start ($tstamp[, $interval])
1872		2000
1873	Set the event trigger time to C<$tstamp> and start the timer.	2001	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2002	also replaces the interval.
1874		2003
1875	=item $timer = $timer->after ($delay)	2004	=item $timer = $timer->after ($delay[, $interval])
1876		2005
1877	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2006	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1878		2007
1879	=item $timer = $timer->stop	2008	=item $timer = $timer->stop
1880		2009
…		…
1888		2017
1889	$term->{socket} = ...	2018	$term->{socket} = ...
1890	$term->{iow} = urxvt::iow	2019	$term->{iow} = urxvt::iow
1891	->new	2020	->new
1892	->fd (fileno $term->{socket})	2021	->fd (fileno $term->{socket})
1893	->events (urxvt::EVENT_READ)	2022	->events (urxvt::EV_READ)
1894	->start	2023	->start
1895	->cb (sub {	2024	->cb (sub {
1896	my ($iow, $revents) = @_;	2025	my ($iow, $revents) = @_;
1897	# $revents must be 1 here, no need to check	2026	# $revents must be 1 here, no need to check
1898	sysread $term->{socket}, my $buf, 8192	2027	sysread $term->{socket}, my $buf, 8192
…		…
1911	Set the callback to be called when io events are triggered. C<$reventmask>	2040	Set the callback to be called when io events are triggered. C<$reventmask>
1912	is a bitset as described in the C<events> method.	2041	is a bitset as described in the C<events> method.
1913		2042
1914	=item $iow = $iow->fd ($fd)	2043	=item $iow = $iow->fd ($fd)
1915		2044
1916	Set the filedescriptor (not handle) to watch.	2045	Set the file descriptor (not handle) to watch.
1917		2046
1918	=item $iow = $iow->events ($eventmask)	2047	=item $iow = $iow->events ($eventmask)
1919		2048
1920	Set the event mask to watch. The only allowed values are	2049	Set the event mask to watch. The only allowed values are
1921	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2050	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1922	together, or C<urxvt::EVENT_NONE>.	2051	together, or C<urxvt::EV_NONE>.
1923		2052
1924	=item $iow = $iow->start	2053	=item $iow = $iow->start
1925		2054
1926	Start watching for requested events on the given handle.	2055	Start watching for requested events on the given handle.
1927		2056
1928	=item $iow = $iow->stop	2057	=item $iow = $iow->stop
1929		2058
1930	Stop watching for events on the given filehandle.	2059	Stop watching for events on the given file handle.
1931		2060
1932	=back	2061	=back
1933		2062
1934	=head2 The C<urxvt::iw> Class	2063	=head2 The C<urxvt::iw> Class
1935		2064
…		…
1968	->new	2097	->new
1969	->start ($pid)	2098	->start ($pid)
1970	->cb (sub {	2099	->cb (sub {
1971	my ($pw, $exit_status) = @_;	2100	my ($pw, $exit_status) = @_;
1972	...	2101	...
1973	});	2102	});
1974		2103
1975	=over 4	2104	=over 4
1976		2105
1977	=item $pw = new urxvt::pw	2106	=item $pw = new urxvt::pw
1978		2107
…		…
1982		2111
1983	Set the callback to be called when the timer triggers.	2112	Set the callback to be called when the timer triggers.
1984		2113
1985	=item $pw = $timer->start ($pid)	2114	=item $pw = $timer->start ($pid)
1986		2115
1987	Tells the wqtcher to start watching for process C<$pid>.	2116	Tells the watcher to start watching for process C<$pid>.
1988		2117
1989	=item $pw = $pw->stop	2118	=item $pw = $pw->stop
1990		2119
1991	Stop the watcher.	2120	Stop the watcher.
1992		2121
…		…
2005		2134
2006	=item >= 3 - script loading and management	2135	=item >= 3 - script loading and management
2007		2136
2008	=item >=10 - all called hooks	2137	=item >=10 - all called hooks
2009		2138
2010	=item >=11 - hook reutrn values	2139	=item >=11 - hook return values
2011		2140
2012	=back	2141	=back
2013		2142
2014	=head1 AUTHOR	2143	=head1 AUTHOR
2015		2144
2016	Marc Lehmann <pcg@goof.com>	2145	Marc Lehmann <schmorp@schmorp.de>
2017	http://software.schmorp.de/pkg/rxvt-unicode	2146	http://software.schmorp.de/pkg/rxvt-unicode
2018		2147
2019	=cut	2148	=cut
2020		2149
2021	1	2150	1
		2151
		2152	# vim: sw=3:

Diff Legend

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