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.131 by root, Sun Jan 29 20:51:28 2006 UTC vs.
Revision 1.226 by root, Sat Sep 22 14:35:55 2012 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
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 assumed to change
527	slightly in the future.	293	slightly in the future.
		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 TRUE the binding is not
		299	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 TRUE, setting of the window hints is being skipped.
528		307
529	=item on_x_event $term, $event	308	=item on_x_event $term, $event
530		309
531	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
532	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
533	members are not passed.	312	members are not passed.
534		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
535	=item on_focus_in $term	318	=item on_focus_in $term
536		319
537	Called whenever the window gets the keyboard focus, before rxvt-unicode	320	Called whenever the window gets the keyboard focus, before rxvt-unicode
538	does focus in processing.	321	does focus in processing.
539		322
540	=item on_focus_out $term	323	=item on_focus_out $term
541		324
542	Called wheneever the window loses keyboard focus, before rxvt-unicode does	325	Called whenever the window loses keyboard focus, before rxvt-unicode does
543	focus out processing.	326	focus out processing.
544		327
545	=item on_configure_notify $term, $event	328	=item on_configure_notify $term, $event
546		329
547	=item on_property_notify $term, $event	330	=item on_property_notify $term, $event
…		…
558		341
559	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
560		343
561	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
562		345
563	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
564	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.
565		348
566	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
567	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
568	(real, not screen-based) row and column under the mouse cursor.	351	(real, not screen-based) row and column under the mouse cursor.
569		352
…		…
579	=item on_wm_delete_window $term, $event	362	=item on_wm_delete_window $term, $event
580		363
581	Called when various types of ClientMessage events are received (all with	364	Called when various types of ClientMessage events are received (all with
582	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	365	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
583		366
		367	=item on_bell $term
		368
		369	Called on receipt of a bell character.
		370
584	=back	371	=back
585		372
586	=cut	373	=cut
587		374
588	package urxvt;	375	package urxvt;
589		376
590	use utf8;	377	use utf8;
591	use strict;	378	use strict 'vars';
592	use Carp ();	379	use Carp ();
593	use Scalar::Util ();	380	use Scalar::Util ();
594	use List::Util ();	381	use List::Util ();
595		382
596	our $VERSION = 1;	383	our $VERSION = 1;
597	our $TERM;	384	our $TERM;
598	our @TERM_INIT;	385	our @TERM_INIT; # should go, prevents async I/O etc.
599	our @TERM_EXT;	386	our @TERM_EXT; # should go, prevents async I/O etc.
600	our @HOOKNAME;	387	our @HOOKNAME;
601	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	388	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
602	our %OPTION;	389	our %OPTION;
603		390
604	our $LIBDIR;	391	our $LIBDIR;
…		…
630	The current terminal. This variable stores the current C<urxvt::term>	417	The current terminal. This variable stores the current C<urxvt::term>
631	object, whenever a callback/hook is executing.	418	object, whenever a callback/hook is executing.
632		419
633	=item @urxvt::TERM_INIT	420	=item @urxvt::TERM_INIT
634		421
635	All coderefs in this array will be called as methods of the next newly	422	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	423	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,	424	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.	425	so references can push themselves onto it again if they so desire.
639		426
640	This complements to the perl-eval commandline option, but gets executed	427	This complements to the perl-eval command line option, but gets executed
641	first.	428	first.
642		429
643	=item @urxvt::TERM_EXT	430	=item @urxvt::TERM_EXT
644		431
645	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	432	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
652		439
653	=over 4	440	=over 4
654		441
655	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
656		443
657	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
658	costs! The only time this is acceptable is when the terminal process	445	include a trailing newline). Avoid at all costs! The only time this
659	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
660		448
661	=item urxvt::warn $string	449	=item urxvt::warn $string
662		450
663	Calls C<rxvt_warn> with the given string which should not include a	451	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	452	newline. The module also overwrites the C<warn> builtin with a function
665	that calls this function.	453	that calls this function.
666		454
667	Using this function has the advantage that its output ends up in the	455	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.	456	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
670	Messages have a size limit of 1023 bytes currently.	458	Messages have a size limit of 1023 bytes currently.
671		459
672	=item @terms = urxvt::termlist	460	=item @terms = urxvt::termlist
673		461
674	Returns all urxvt::term objects that exist in this process, regardless of	462	Returns all urxvt::term objects that exist in this process, regardless of
675	wether they are started, being destroyed etc., so be careful. Only term	463	whether they are started, being destroyed etc., so be careful. Only term
676	objects that have perl extensions attached will be returned (because there	464	objects that have perl extensions attached will be returned (because there
677	is no urxvt::term objet associated with others).	465	is no urxvt::term object associated with others).
678		466
679	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
680		468
681	Returns the "current time" (as per the event loop).	469	Returns the "current time" (as per the event loop).
682		470
…		…
725		513
726	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
727		515
728	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
729		517
730	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	518	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		519	urxvt::RS_RVid, urxvt::RS_Uline
731		520
732	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
733	underline, respectively. To enable such a style, just logically OR it into	522	underline, respectively. To enable such a style, just logically OR it into
734	the bitset.	523	the bitset.
735		524
…		…
740	Return the foreground/background colour index, respectively.	529	Return the foreground/background colour index, respectively.
741		530
742	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	531	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
743		532
744	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	533	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		534
		535	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
745		536
746	Replace the foreground/background colour in the rendition mask with the	537	Replace the foreground/background colour in the rendition mask with the
747	specified one.	538	specified one.
748		539
749	=item $value = urxvt::GET_CUSTOM $rend	540	=item $value = urxvt::GET_CUSTOM $rend
…		…
770	};	561	};
771	}	562	}
772		563
773	no warnings 'utf8';	564	no warnings 'utf8';
774		565
		566	sub parse_resource {
		567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		568
		569	$name =~ y/-/./ if $isarg;
		570
		571	$term->scan_meta;
		572
		573	my $r = $term->{meta}{resource};
		574	keys %$r; # reste iterator
		575	while (my ($pattern, $v) = each %$r) {
		576	if (
		577	$pattern =~ /\.$/
		578	? $pattern eq substr $name, 0, length $pattern
		579	: $pattern eq $name
		580	) {
		581	$name = "$urxvt::RESCLASS.$name";
		582
		583	push @{ $term->{perl_ext_3} }, $v->[0];
		584
		585	if ($v->[1] eq "boolean") {
		586	$term->put_option_db ($name, $flag ? "true" : "false");
		587	return 1;
		588	} else {
		589	$term->put_option_db ($name, $value);
		590	return 1 + 2;
		591	}
		592	}
		593	}
		594
		595	0
		596	}
		597
		598	sub usage {
		599	my ($term, $usage_type) = @_;
		600
		601	$term->scan_meta;
		602
		603	my $r = $term->{meta}{resource};
		604
		605	for my $pattern (sort keys %$r) {
		606	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		607
		608	$desc .= " (-pe $ext)";
		609
		610	if ($usage_type == 1) {
		611	$pattern =~ y/./-/;
		612	$pattern =~ s/-$/-.../g;
		613
		614	if ($type eq "boolean") {
		615	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		616	} else {
		617	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		618	}
		619	} else {
		620	$pattern =~ s/\.$/.*/g;
		621	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		622	}
		623	}
		624	}
		625
775	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
776		627
777	sub verbose {	628	sub verbose {
778	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
779	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
…		…
791	$pkg =~ s/[^[:word:]]/_/g;	642	$pkg =~ s/[^[:word:]]/_/g;
792	$pkg = "urxvt::ext::$pkg";	643	$pkg = "urxvt::ext::$pkg";
793		644
794	verbose 3, "loading extension '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
795		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		648
796	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
797	or die "$path: $!";	650	or die "$path: $!";
798		651
799	my $source =	652	my $source =
800	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
801	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
802	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
803	. "\n};\n1";	656	. "\n};\n1";
804		657
805	eval $source	658	eval $source
…		…
815	sub invoke {	668	sub invoke {
816	local $TERM = shift;	669	local $TERM = shift;
817	my $htype = shift;	670	my $htype = shift;
818		671
819	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
820	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
821		674
822	my %ext_arg;	675	my %ext_arg;
823		676
824	{	677	{
825	my @init = @TERM_INIT;	678	my @init = @TERM_INIT;
826	@TERM_INIT = ();	679	@TERM_INIT = ();
…		…
828	my @pkg = @TERM_EXT;	681	my @pkg = @TERM_EXT;
829	@TERM_EXT = ();	682	@TERM_EXT = ();
830	$TERM->register_package ($_) for @pkg;	683	$TERM->register_package ($_) for @pkg;
831	}	684	}
832		685
		686	for (
		687	@{ delete $TERM->{perl_ext_3} },
833	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		689	) {
834	if ($_ eq "default") {	690	if ($_ eq "default") {
835	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	691	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
836	} elsif (/^-(.*)$/) {	692	} elsif (/^-(.*)$/) {
837	delete $ext_arg{$1};	693	delete $ext_arg{$1};
838	} elsif (/^([^<]+)<(.*)>$/) {	694	} elsif (/^([^<]+)<(.*)>$/) {
…		…
840	} else {	696	} else {
841	$ext_arg{$_} ||= [];	697	$ext_arg{$_} ||= [];
842	}	698	}
843	}	699	}
844		700
845	while (my ($ext, $argv) = each %ext_arg) {	701	for my $ext (sort keys %ext_arg) {
846	my @files = grep -f $_, map "$_/$ext", @dirs;	702	my @files = grep -f $_, map "$_/$ext", @dirs;
847		703
848	if (@files) {	704	if (@files) {
849	$TERM->register_package (extension_package $files[0], $argv);	705	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
850	} else {	706	} else {
851	warn "perl extension '$ext' not found in perl library search path\n";	707	warn "perl extension '$ext' not found in perl library search path\n";
852	}	708	}
853	}	709	}
854		710
…		…
860		716
861	if (my $cb = $TERM->{_hook}[$htype]) {	717	if (my $cb = $TERM->{_hook}[$htype]) {
862	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
863	if $verbosity >= 10;	719	if $verbosity >= 10;
864		720
865	keys %$cb;	721	for my $pkg (keys %$cb) {
866
867	while (my ($pkg, $cb) = each %$cb) {
868	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
869	$retval ||= $retval_;	723	$retval ||= $retval_;
870		724
871	if ($@) {	725	if ($@) {
872	$TERM->ungrab; # better to lose the grab than the session	726	$TERM->ungrab; # better to lose the grab than the session
873	warn $@;	727	warn $@;
…		…
887	}	741	}
888		742
889	$retval	743	$retval
890	}	744	}
891		745
892	# urxvt::term::extension	746	sub SET_COLOR($$$) {
		747	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		748	}
		749
		750	sub rend2mask {
		751	no strict 'refs';
		752	my ($str, $mask) = (@_, 0);
		753	my %color = ( fg => undef, bg => undef );
		754	my @failed;
		755	for my $spec ( split /\s+/, $str ) {
		756	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		757	$color{lc($1)} = $2;
		758	} else {
		759	my $neg = $spec =~ s/^[-^]//;
		760	unless ( exists &{"RS_$spec"} ) {
		761	push @failed, $spec;
		762	next;
		763	}
		764	my $cur = &{"RS_$spec"};
		765	if ( $neg ) {
		766	$mask &= ~$cur;
		767	} else {
		768	$mask |= $cur;
		769	}
		770	}
		771	}
		772	($mask, @color{qw(fg bg)}, \@failed)
		773	}
893		774
894	package urxvt::term::extension;	775	package urxvt::term::extension;
895		776
896	sub enable {	777	=head2 The C<urxvt::term::extension> class
897	my ($self, %hook) = @_;
898	my $pkg = $self->{_pkg};
899		778
900	while (my ($name, $cb) = each %hook) {	779	Each extension attached to a terminal object is represented by
901	my $htype = $HOOKTYPE{uc $name};	780	a C<urxvt::term::extension> object.
902	defined $htype
903	or Carp::croak "unsupported hook type '$name'";
904		781
905	$self->set_should_invoke ($htype, +1)	782	You can use these objects, which are passed to all callbacks to store any
906	unless exists $self->{term}{_hook}[$htype]{$pkg};	783	state related to the terminal and extension instance.
907		784
908	$self->{term}{_hook}[$htype]{$pkg} = $cb;	785	The methods (And data members) documented below can be called on extension
909	}	786	objects, in addition to call methods documented for the <urxvt::term>
910	}	787	class.
911		788
912	sub disable {	789	=over 4
913	my ($self, @hook) = @_;
914	my $pkg = $self->{_pkg};
915		790
916	for my $name (@hook) {	791	=item $urxvt_term = $self->{term}
917	my $htype = $HOOKTYPE{uc $name};
918	defined $htype
919	or Carp::croak "unsupported hook type '$name'";
920		792
921	$self->set_should_invoke ($htype, -1)	793	Returns the C<urxvt::term> object associated with this instance of the
922	if delete $self->{term}{_hook}[$htype]{$pkg};	794	extension. This member I<must not> be changed in any way.
923	}	795
924	}	796	=cut
925		797
926	our $AUTOLOAD;	798	our $AUTOLOAD;
927		799
928	sub AUTOLOAD {	800	sub AUTOLOAD {
929	$AUTOLOAD =~ /:([^:]+)$/	801	$AUTOLOAD =~ /:([^:]+)$/
…		…
942		814
943	sub DESTROY {	815	sub DESTROY {
944	# nop	816	# nop
945	}	817	}
946		818
947	# urxvt::destroy_hook	819	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
948		820
949	sub urxvt::destroy_hook::DESTROY {	821	sub urxvt::destroy_hook::DESTROY {
950	${$_[0]}->();	822	${$_[0]}->();
951	}	823	}
952		824
953	sub urxvt::destroy_hook(&) {	825	sub urxvt::destroy_hook(&) {
954	bless \shift, urxvt::destroy_hook::	826	bless \shift, urxvt::destroy_hook::
955	}	827	}
		828
		829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		830
		831	Dynamically enable the given hooks (named without the C<on_> prefix) for
		832	this extension, replacing any previous hook. This is useful when you want
		833	to overwrite time-critical hooks only 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
956		939
957	package urxvt::anyevent;	940	package urxvt::anyevent;
958		941
959	=head2 The C<urxvt::anyevent> Class	942	=head2 The C<urxvt::anyevent> Class
960		943
961	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
962	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
963	further programming. The only exception is that you cannot wait on	946	further programming. The only exception is that you cannot wait on
964	condition variables, but non-blocking condvar use is ok. What this means	947	condition variables, but non-blocking condvar use is ok.
965	is that you cannot use blocking APIs, but the non-blocking variant should
966	work.
967		948
968	=cut	949	In practical terms this means is that you cannot use blocking APIs, but
		950	the non-blocking variant should work.
969		951
		952	=cut
		953
970	our $VERSION = 1;	954	our $VERSION = '5.23';
971		955
972	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	956	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
973	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	957	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
974		958
975	sub timer {	959	sub timer {
…		…
977		961
978	my $cb = $arg{cb};	962	my $cb = $arg{cb};
979		963
980	urxvt::timer	964	urxvt::timer
981	->new	965	->new
982	->start (urxvt::NOW + $arg{after})	966	->after ($arg{after}, $arg{interval})
983	->cb (sub {	967	->cb ($arg{interval} ? $cb : sub {
984	$_[0]->stop; # need to cancel manually	968	$_[0]->stop; # need to cancel manually
985	$cb->();	969	$cb->();
986	})	970	})
987	}	971	}
988		972
989	sub io {	973	sub io {
990	my ($class, %arg) = @_;	974	my ($class, %arg) = @_;
991		975
992	my $cb = $arg{cb};	976	my $cb = $arg{cb};
		977	my $fd = fileno $arg{fh};
		978	defined $fd or $fd = $arg{fh};
993		979
994	bless [$arg{fh}, urxvt::iow	980	bless [$arg{fh}, urxvt::iow
995	->new	981	->new
996	->fd (fileno $arg{fh})	982	->fd ($fd)
997	->events (($arg{poll} =~ /r/ ? 1 : 0)	983	->events (($arg{poll} =~ /r/ ? 1 : 0)
998	| ($arg{poll} =~ /w/ ? 2 : 0))	984	| ($arg{poll} =~ /w/ ? 2 : 0))
999	->start	985	->start
1000	->cb (sub {	986	->cb ($cb)
1001	$cb->(($_[1] & 1 ? 'r' : '')
1002	. ($_[1] & 2 ? 'w' : ''));
1003	})],
1004	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	})
1005	}	1013	}
1006		1014
1007	sub DESTROY {	1015	sub DESTROY {
1008	$_[0][1]->stop;	1016	$_[0][1]->stop;
1009	}	1017	}
1010		1018
1011	sub condvar {	1019	# only needed for AnyEvent < 6 compatibility
1012	bless \my $flag, urxvt::anyevent::condvar::	1020	sub one_event {
1013	}
1014
1015	sub urxvt::anyevent::condvar::broadcast {
1016	${$_[0]}++;
1017	}
1018
1019	sub urxvt::anyevent::condvar::wait {
1020	unless (${$_[0]}) {
1021	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";
1022	}
1023	}	1022	}
1024		1023
1025	package urxvt::term;	1024	package urxvt::term;
1026		1025
1027	=head2 The C<urxvt::term> Class	1026	=head2 The C<urxvt::term> Class
…		…
1040	urxvt::verbose 6, "register package $pkg to $self";	1039	urxvt::verbose 6, "register package $pkg to $self";
1041		1040
1042	@{"$pkg\::ISA"} = urxvt::term::extension::;	1041	@{"$pkg\::ISA"} = urxvt::term::extension::;
1043		1042
1044	my $proxy = bless {	1043	my $proxy = bless {
1045	_pkg => $pkg,	1044	_pkg => $pkg,
		1045	_name => ${"$pkg\::_NAME"}, # hackish
1046	argv => $argv,	1046	argv => $argv,
1047	}, $pkg;	1047	}, $pkg;
1048	Scalar::Util::weaken ($proxy->{term} = $self);	1048	Scalar::Util::weaken ($proxy->{term} = $self);
1049		1049
1050	$self->{_pkg}{$pkg} = $proxy;	1050	$self->{_pkg}{$pkg} = $proxy;
1051		1051
…		…
1054	$proxy->enable ($name => $ref);	1054	$proxy->enable ($name => $ref);
1055	}	1055	}
1056	}	1056	}
1057	}	1057	}
1058		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
1059	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1105	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1060		1106
1061	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
1062	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
1063	hash which defines the environment of the new terminal.	1109	hash which defines the environment of the new terminal.
…		…
1080	}	1126	}
1081		1127
1082	=item $term->destroy	1128	=item $term->destroy
1083		1129
1084	Destroy the terminal object (close the window, free resources	1130	Destroy the terminal object (close the window, free resources
1085	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
1086	watchers (timers, io watchers) are still active.	1132	watchers (timers, io watchers) are still active.
1087		1133
1088	=item $term->exec_async ($cmd[, @args])	1134	=item $term->exec_async ($cmd[, @args])
1089		1135
1090	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
…		…
1114		1160
1115	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
1116	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
1117	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.
1118		1164
1119	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
1120	source file F</src/optinc.h> to see the actual list:	1166	source file F</src/optinc.h> to see the actual list:
1121		1167
1122	borderLess console cursorBlink cursorUnderline hold iconic insecure	1168	borderLess buffered console cursorBlink cursorUnderline hold iconic
1123	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1169	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1124	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1170	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1125	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1171	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1126	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1172	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1127	transparent tripleclickwords utmpInhibit visualBell	1173	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1174	urgentOnBell utmpInhibit visualBell
1128		1175
1129	=item $value = $term->resource ($name[, $newval])	1176	=item $value = $term->resource ($name[, $newval])
1130		1177
1131	Returns the current resource value associated with a given name and	1178	Returns the current resource value associated with a given name and
1132	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>
…		…
1141	likely change).	1188	likely change).
1142		1189
1143	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
1144	terminal is destroyed, so changing options frequently will eat memory.	1191	terminal is destroyed, so changing options frequently will eat memory.
1145		1192
1146	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
1147	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>
1148	to see the actual list:	1195	to see the actual list:
1149		1196
1150	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1197	answerbackstring backgroundPixmap backspace_key blurradius
1151	borderLess color cursorBlink cursorUnderline cutchars delete_key	1198	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1152	display_name embed ext_bwidth fade font geometry hold iconName	1199	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1153	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
1154	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1202	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1155	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1203	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1156	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1204	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1157	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1205	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1158	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1206	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1159	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1207	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1160	secondaryScreen secondaryScroll selectstyle shade term_name title	1208	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1161	transient_for transparent transparent_all tripleclickwords utmpInhibit	1209	term_name title transient_for transparent tripleclickwords urgentOnBell
1162	visualBell	1210	utmpInhibit visualBell
1163		1211
1164	=cut	1212	=cut
1165		1213
1166	sub resource($$;$) {	1214	sub resource($$;$) {
1167	my ($self, $name) = (shift, shift);	1215	my ($self, $name) = (shift, shift);
1168	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1216	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1169	&urxvt::term::_resource	1217	goto &urxvt::term::_resource
1170	}	1218	}
1171		1219
1172	=item $value = $term->x_resource ($pattern)	1220	=item $value = $term->x_resource ($pattern)
1173		1221
1174	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
1175	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
1176	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
1177	resource with that pattern exists.	1225	resource with that pattern exists.
1178		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
1179	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
1180	only one resource database per display, and later invocations might return	1238	only one resource database per display, and later invocations might return
1181	the wrong resources.	1239	the wrong resources.
1182		1240
1183	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1241	=item $value = $term->x_resource_boolean ($pattern)
1184		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->parse_keysym ($key, $octets)
		1258
1185	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
1186	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1260	C<keysym> resource in the urxvt(1) manpage.
		1261
		1262	=item $term->register_command ($keysym, $modifiermask, $string)
		1263
		1264	Adds a key binding. This is a lower level api compared to
		1265	C<parse_keysym>, as it expects a parsed key description, and can be
		1266	used only inside either the C<on_init> hook, to add a binding, or the
		1267	C<on_register_command> hook, to modify a parsed binding.
1187		1268
1188	=item $rend = $term->rstyle ([$new_rstyle])	1269	=item $rend = $term->rstyle ([$new_rstyle])
1189		1270
1190	Return and optionally change the current rendition. Text that is output by	1271	Return and optionally change the current rendition. Text that is output by
1191	the terminal application will use this style.	1272	the terminal application will use this style.
…		…
1199		1280
1200	=item ($row, $col) = $term->selection_beg ([$row, $col])	1281	=item ($row, $col) = $term->selection_beg ([$row, $col])
1201		1282
1202	=item ($row, $col) = $term->selection_end ([$row, $col])	1283	=item ($row, $col) = $term->selection_end ([$row, $col])
1203		1284
1204	Return the current values of the selection mark, begin or end positions,	1285	Return the current values of the selection mark, begin or end positions.
1205	and optionally set them to new values.	1286
		1287	When arguments are given, then the selection coordinates are set to
		1288	C<$row> and C<$col>, and the selection screen is set to the current
		1289	screen.
		1290
		1291	=item $screen = $term->selection_screen ([$screen])
		1292
		1293	Returns the current selection screen, and then optionally sets it.
1206		1294
1207	=item $term->selection_make ($eventtime[, $rectangular])	1295	=item $term->selection_make ($eventtime[, $rectangular])
1208		1296
1209	Tries to make a selection as set by C<selection_beg> and	1297	Tries to make a selection as set by C<selection_beg> and
1210	C<selection_end>. If C<$rectangular> is true (default: false), a	1298	C<selection_end>. If C<$rectangular> is true (default: false), a
1211	rectangular selection will be made. This is the prefered function to make	1299	rectangular selection will be made. This is the preferred function to make
1212	a selection.	1300	a selection.
1213		1301
1214	=item $success = $term->selection_grab ($eventtime)	1302	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1215		1303
1216	Try to request the primary selection text from the server (for example, as	1304	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1305	true) selection from the server. The corresponding text can be set
1217	set by the next method). No visual feedback will be given. This function	1306	with the next method. No visual feedback will be given. This function
1218	is mostly useful from within C<on_sel_grab> hooks.	1307	is mostly useful from within C<on_sel_grab> hooks.
1219		1308
1220	=item $oldtext = $term->selection ([$newtext])	1309	=item $oldtext = $term->selection ([$newtext, $clipboard])
1221		1310
1222	Return the current selection text and optionally replace it by C<$newtext>.	1311	Return the current selection (clipboard if C<$clipboard> is true) text
		1312	and optionally replace it by C<$newtext>.
		1313
		1314	=item $term->selection_clear ([$clipboard])
		1315
		1316	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1223		1317
1224	=item $term->overlay_simple ($x, $y, $text)	1318	=item $term->overlay_simple ($x, $y, $text)
1225		1319
1226	Create a simple multi-line overlay box. See the next method for details.	1320	Create a simple multi-line overlay box. See the next method for details.
1227		1321
…		…
1257		1351
1258	The methods currently supported on C<urxvt::overlay> objects are:	1352	The methods currently supported on C<urxvt::overlay> objects are:
1259		1353
1260	=over 4	1354	=over 4
1261		1355
1262	=item $overlay->set ($x, $y, $text, $rend)	1356	=item $overlay->set ($x, $y, $text[, $rend])
1263		1357
1264	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1358	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1265	text in rxvt-unicode's special encoding and an array of rendition values	1359	text in rxvt-unicode's special encoding and an array of rendition values
1266	at a specific position inside the overlay.	1360	at a specific position inside the overlay.
		1361
		1362	If C<$rend> is missing, then the rendition will not be changed.
1267		1363
1268	=item $overlay->hide	1364	=item $overlay->hide
1269		1365
1270	If visible, hide the overlay, but do not destroy it.	1366	If visible, hide the overlay, but do not destroy it.
1271		1367
…		…
1353	locale-specific encoding of the terminal and can contain command sequences	1449	locale-specific encoding of the terminal and can contain command sequences
1354	(escape codes) that will be interpreted.	1450	(escape codes) that will be interpreted.
1355		1451
1356	=item $term->tt_write ($octets)	1452	=item $term->tt_write ($octets)
1357		1453
1358	Write the octets given in C<$data> to the tty (i.e. as program input). To	1454	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1359	pass characters instead of octets, you should convert your strings first	1455	pass characters instead of octets, you should convert your strings first
1360	to the locale-specific encoding using C<< $term->locale_encode >>.	1456	to the locale-specific encoding using C<< $term->locale_encode >>.
		1457
		1458	=item $term->tt_paste ($octets)
		1459
		1460	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1461	CR and bracketing the data with control sequences if bracketed paste mode
		1462	is set.
1361		1463
1362	=item $old_events = $term->pty_ev_events ([$new_events])	1464	=item $old_events = $term->pty_ev_events ([$new_events])
1363		1465
1364	Replaces the event mask of the pty watcher by the given event mask. Can	1466	Replaces the event mask of the pty watcher by the given event mask. Can
1365	be used to suppress input and output handling to the pty/tty. See the	1467	be used to suppress input and output handling to the pty/tty. See the
…		…
1384	Adds the specified events to the vt event mask. Useful e.g. when you want	1486	Adds the specified events to the vt event mask. Useful e.g. when you want
1385	to receive pointer events all the times:	1487	to receive pointer events all the times:
1386		1488
1387	$term->vt_emask_add (urxvt::PointerMotionMask);	1489	$term->vt_emask_add (urxvt::PointerMotionMask);
1388		1490
		1491	=item $term->set_urgency ($set)
		1492
		1493	Enable/disable the urgency hint on the toplevel window.
		1494
		1495	=item $term->focus_in
		1496
		1497	=item $term->focus_out
		1498
		1499	=item $term->key_press ($state, $keycode[, $time])
		1500
		1501	=item $term->key_release ($state, $keycode[, $time])
		1502
		1503	Deliver various fake events to to terminal.
		1504
1389	=item $window_width = $term->width	1505	=item $window_width = $term->width
1390		1506
1391	=item $window_height = $term->height	1507	=item $window_height = $term->height
1392		1508
1393	=item $font_width = $term->fwidth	1509	=item $font_width = $term->fwidth
…		…
1423	=item $env = $term->env	1539	=item $env = $term->env
1424		1540
1425	Returns a copy of the environment in effect for the terminal as a hashref	1541	Returns a copy of the environment in effect for the terminal as a hashref
1426	similar to C<\%ENV>.	1542	similar to C<\%ENV>.
1427		1543
		1544	=item @envv = $term->envv
		1545
		1546	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1547
		1548	=item @argv = $term->argv
		1549
		1550	Return the argument vector as this terminal, similar to @ARGV, but
		1551	includes the program name as first element.
		1552
1428	=cut	1553	=cut
1429		1554
1430	sub env {	1555	sub env {
1431	if (my $env = $_[0]->_env) {
1432	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1556	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1433	} else {
1434	+{ %ENV }
1435	}
1436	}	1557	}
1437		1558
1438	=item $modifiermask = $term->ModLevel3Mask	1559	=item $modifiermask = $term->ModLevel3Mask
1439		1560
1440	=item $modifiermask = $term->ModMetaMask	1561	=item $modifiermask = $term->ModMetaMask
…		…
1448		1569
1449	Returns the currently displayed screen (0 primary, 1 secondary).	1570	Returns the currently displayed screen (0 primary, 1 secondary).
1450		1571
1451	=item $cursor_is_hidden = $term->hidden_cursor	1572	=item $cursor_is_hidden = $term->hidden_cursor
1452		1573
1453	Returns wether the cursor is currently hidden or not.	1574	Returns whether the cursor is currently hidden or not.
1454		1575
1455	=item $view_start = $term->view_start ([$newvalue])	1576	=item $view_start = $term->view_start ([$newvalue])
1456		1577
1457	Returns the row number of the topmost displayed line. Maximum value is	1578	Returns the row number of the topmost displayed line. Maximum value is
1458	C<0>, which displays the normal terminal contents. Lower values scroll	1579	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1466		1587
1467	Used after changing terminal contents to display them.	1588	Used after changing terminal contents to display them.
1468		1589
1469	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1590	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1470		1591
1471	Returns the text of the entire row with number C<$row_number>. Row C<0>	1592	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1472	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1593	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1473	terminal line. The scrollback buffer starts at line C<-1> and extends to
1474	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1594	terminal line. Nothing will be returned if a nonexistent line
1475	is requested.	1595	is requested.
1476		1596
1477	If C<$new_text> is specified, it will replace characters in the current	1597	If C<$new_text> is specified, it will replace characters in the current
1478	line, starting at column C<$start_col> (default C<0>), which is useful	1598	line, starting at column C<$start_col> (default C<0>), which is useful
1479	to replace only parts of a line. The font index in the rendition will	1599	to replace only parts of a line. The font index in the rendition will
1480	automatically be updated.	1600	automatically be updated.
1481		1601
1482	C<$text> is in a special encoding: tabs and wide characters that use more	1602	C<$text> is in a special encoding: tabs and wide characters that use more
1483	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1603	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1484	characters. Characters with combining characters and other characters that	1604	characters. Characters with combining characters and other characters that
1485	do not fit into the normal tetx encoding will be replaced with characters	1605	do not fit into the normal text encoding will be replaced with characters
1486	in the private use area.	1606	in the private use area.
1487		1607
1488	You have to obey this encoding when changing text. The advantage is	1608	You have to obey this encoding when changing text. The advantage is
1489	that C<substr> and similar functions work on screen cells and not on	1609	that C<substr> and similar functions work on screen cells and not on
1490	characters.	1610	characters.
…		…
1635	where one character corresponds to one screen cell. See	1755	where one character corresponds to one screen cell. See
1636	C<< $term->ROW_t >> for details.	1756	C<< $term->ROW_t >> for details.
1637		1757
1638	=item $string = $term->special_decode $text	1758	=item $string = $term->special_decode $text
1639		1759
1640	Converts rxvt-unicodes text reprsentation into a perl string. See	1760	Converts rxvt-unicodes text representation into a perl string. See
1641	C<< $term->ROW_t >> for details.	1761	C<< $term->ROW_t >> for details.
1642		1762
1643	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1763	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1644		1764
1645	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1765	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1648	manpage.	1768	manpage.
1649		1769
1650	=item $success = $term->grab ($eventtime[, $sync])	1770	=item $success = $term->grab ($eventtime[, $sync])
1651		1771
1652	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1772	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1653	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1773	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1654		1774
1655	=item $term->allow_events_async	1775	=item $term->allow_events_async
1656		1776
1657	Calls XAllowEvents with AsyncBoth for the most recent grab.	1777	Calls XAllowEvents with AsyncBoth for the most recent grab.
1658		1778
…		…
1665	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1785	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1666	recent grab.	1786	recent grab.
1667		1787
1668	=item $term->ungrab	1788	=item $term->ungrab
1669		1789
1670	Calls XUngrab for the most recent grab. Is called automatically on	1790	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1671	evaluation errors, as it is better to lose the grab in the error case as	1791	evaluation errors, as it is better to lose the grab in the error case as
1672	the session.	1792	the session.
1673		1793
1674	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1794	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1675		1795
…		…
1677		1797
1678	=item @atoms = $term->XListProperties ($window)	1798	=item @atoms = $term->XListProperties ($window)
1679		1799
1680	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1800	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1681		1801
1682	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1802	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1683		1803
1684	=item $term->XDeleteProperty ($window, $property)	1804	=item $term->XDeleteProperty ($window, $property)
1685		1805
1686	=item $window = $term->DefaultRootWindow	1806	=item $window = $term->DefaultRootWindow
1687		1807
…		…
1694	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1814	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1695		1815
1696	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1816	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1697		1817
1698	=item $term->XChangeInput ($window, $add_events[, $del_events])	1818	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1819
		1820	=item $keysym = $term->XStringToKeysym ($string)
		1821
		1822	=item $string = $term->XKeysymToString ($keysym)
1699		1823
1700	Various X or X-related functions. The C<$term> object only serves as	1824	Various X or X-related functions. The C<$term> object only serves as
1701	the source of the display, otherwise those functions map more-or-less	1825	the source of the display, otherwise those functions map more-or-less
1702	directory onto the X functions of the same name.	1826	directly onto the X functions of the same name.
1703		1827
1704	=back	1828	=back
1705		1829
1706	=cut	1830	=cut
1707		1831
…		…
1771	my ($self, $text, $cb) = @_;	1895	my ($self, $text, $cb) = @_;
1772		1896
1773	$self->add_item ({ type => "button", text => $text, activate => $cb});	1897	$self->add_item ({ type => "button", text => $text, activate => $cb});
1774	}	1898	}
1775		1899
1776	=item $popup->add_toggle ($text, $cb, $initial_value)	1900	=item $popup->add_toggle ($text, $initial_value, $cb)
1777		1901
1778	Adds a toggle/checkbox item to the popup. Teh callback gets called	1902	Adds a toggle/checkbox item to the popup. The callback gets called
1779	whenever it gets toggled, with a boolean indicating its value as its first	1903	whenever it gets toggled, with a boolean indicating its new value as its
1780	argument.	1904	first argument.
1781		1905
1782	=cut	1906	=cut
1783		1907
1784	sub add_toggle {	1908	sub add_toggle {
1785	my ($self, $text, $cb, $value) = @_;	1909	my ($self, $text, $value, $cb) = @_;
1786		1910
1787	my $item; $item = {	1911	my $item; $item = {
1788	type => "button",	1912	type => "button",
1789	text => " $text",	1913	text => " $text",
1790	value => $value,	1914	value => $value,
…		…
1809	my $env = $self->{term}->env;	1933	my $env = $self->{term}->env;
1810	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1934	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1811	delete $env->{LC_ALL};	1935	delete $env->{LC_ALL};
1812	$env->{LC_CTYPE} = $self->{term}->locale;	1936	$env->{LC_CTYPE} = $self->{term}->locale;
1813		1937
1814	urxvt::term->new ($env, "popup",	1938	my $term = urxvt::term->new (
		1939	$env, "popup",
1815	"--perl-lib" => "", "--perl-ext-common" => "",	1940	"--perl-lib" => "", "--perl-ext-common" => "",
1816	"-pty-fd" => -1, "-sl" => 0,	1941	"-pty-fd" => -1, "-sl" => 0,
1817	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1942	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1818	"--transient-for" => $self->{term}->parent,	1943	"--transient-for" => $self->{term}->parent,
1819	"-display" => $self->{term}->display_id,	1944	"-display" => $self->{term}->display_id,
1820	"-pe" => "urxvt-popup")	1945	"-pe" => "urxvt-popup",
1821	or die "unable to create popup window\n";	1946	) or die "unable to create popup window\n";
		1947
		1948	unless (delete $term->{urxvt_popup_init_done}) {
		1949	$term->ungrab;
		1950	$term->destroy;
		1951	die "unable to initialise popup window\n";
		1952	}
1822	}	1953	}
1823		1954
1824	sub DESTROY {	1955	sub DESTROY {
1825	my ($self) = @_;	1956	my ($self) = @_;
1826		1957
…		…
1831	=back	1962	=back
1832		1963
1833	=cut	1964	=cut
1834		1965
1835	package urxvt::watcher;	1966	package urxvt::watcher;
1836
1837	@urxvt::timer::ISA = __PACKAGE__;
1838	@urxvt::iow::ISA = __PACKAGE__;
1839	@urxvt::pw::ISA = __PACKAGE__;
1840	@urxvt::iw::ISA = __PACKAGE__;
1841		1967
1842	=head2 The C<urxvt::timer> Class	1968	=head2 The C<urxvt::timer> Class
1843		1969
1844	This class implements timer watchers/events. Time is represented as a	1970	This class implements timer watchers/events. Time is represented as a
1845	fractional number of seconds since the epoch. Example:	1971	fractional number of seconds since the epoch. Example:
…		…
1849	->new	1975	->new
1850	->interval (1)	1976	->interval (1)
1851	->cb (sub {	1977	->cb (sub {
1852	$term->{overlay}->set (0, 0,	1978	$term->{overlay}->set (0, 0,
1853	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1979	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1854	});	1980	});
1855		1981
1856	=over 4	1982	=over 4
1857		1983
1858	=item $timer = new urxvt::timer	1984	=item $timer = new urxvt::timer
1859		1985
…		…
1862		1988
1863	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1989	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1864		1990
1865	Set the callback to be called when the timer triggers.	1991	Set the callback to be called when the timer triggers.
1866		1992
1867	=item $tstamp = $timer->at
1868
1869	Return the time this watcher will fire next.
1870
1871	=item $timer = $timer->set ($tstamp)	1993	=item $timer = $timer->set ($tstamp[, $interval])
1872		1994
1873	Set the time the event is generated to $tstamp.	1995	Set the time the event is generated to $tstamp (and optionally specifies a
		1996	new $interval).
1874		1997
1875	=item $timer = $timer->interval ($interval)	1998	=item $timer = $timer->interval ($interval)
1876		1999
1877	Normally (and when C<$interval> is C<0>), the timer will automatically	2000	By default (and when C<$interval> is C<0>), the timer will automatically
1878	stop after it has fired once. If C<$interval> is non-zero, then the timer	2001	stop after it has fired once. If C<$interval> is non-zero, then the timer
1879	is automatically rescheduled at the given intervals.	2002	is automatically rescheduled at the given intervals.
1880		2003
1881	=item $timer = $timer->start	2004	=item $timer = $timer->start
1882		2005
1883	Start the timer.	2006	Start the timer.
1884		2007
1885	=item $timer = $timer->start ($tstamp)	2008	=item $timer = $timer->start ($tstamp[, $interval])
1886		2009
1887	Set the event trigger time to C<$tstamp> and start the timer.	2010	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2011	also replaces the interval.
1888		2012
1889	=item $timer = $timer->after ($delay)	2013	=item $timer = $timer->after ($delay[, $interval])
1890		2014
1891	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2015	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1892		2016
1893	=item $timer = $timer->stop	2017	=item $timer = $timer->stop
1894		2018
…		…
1902		2026
1903	$term->{socket} = ...	2027	$term->{socket} = ...
1904	$term->{iow} = urxvt::iow	2028	$term->{iow} = urxvt::iow
1905	->new	2029	->new
1906	->fd (fileno $term->{socket})	2030	->fd (fileno $term->{socket})
1907	->events (urxvt::EVENT_READ)	2031	->events (urxvt::EV_READ)
1908	->start	2032	->start
1909	->cb (sub {	2033	->cb (sub {
1910	my ($iow, $revents) = @_;	2034	my ($iow, $revents) = @_;
1911	# $revents must be 1 here, no need to check	2035	# $revents must be 1 here, no need to check
1912	sysread $term->{socket}, my $buf, 8192	2036	sysread $term->{socket}, my $buf, 8192
…		…
1925	Set the callback to be called when io events are triggered. C<$reventmask>	2049	Set the callback to be called when io events are triggered. C<$reventmask>
1926	is a bitset as described in the C<events> method.	2050	is a bitset as described in the C<events> method.
1927		2051
1928	=item $iow = $iow->fd ($fd)	2052	=item $iow = $iow->fd ($fd)
1929		2053
1930	Set the filedescriptor (not handle) to watch.	2054	Set the file descriptor (not handle) to watch.
1931		2055
1932	=item $iow = $iow->events ($eventmask)	2056	=item $iow = $iow->events ($eventmask)
1933		2057
1934	Set the event mask to watch. The only allowed values are	2058	Set the event mask to watch. The only allowed values are
1935	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2059	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1936	together, or C<urxvt::EVENT_NONE>.	2060	together, or C<urxvt::EV_NONE>.
1937		2061
1938	=item $iow = $iow->start	2062	=item $iow = $iow->start
1939		2063
1940	Start watching for requested events on the given handle.	2064	Start watching for requested events on the given handle.
1941		2065
1942	=item $iow = $iow->stop	2066	=item $iow = $iow->stop
1943		2067
1944	Stop watching for events on the given filehandle.	2068	Stop watching for events on the given file handle.
1945		2069
1946	=back	2070	=back
1947		2071
1948	=head2 The C<urxvt::iw> Class	2072	=head2 The C<urxvt::iw> Class
1949		2073
…		…
1982	->new	2106	->new
1983	->start ($pid)	2107	->start ($pid)
1984	->cb (sub {	2108	->cb (sub {
1985	my ($pw, $exit_status) = @_;	2109	my ($pw, $exit_status) = @_;
1986	...	2110	...
1987	});	2111	});
1988		2112
1989	=over 4	2113	=over 4
1990		2114
1991	=item $pw = new urxvt::pw	2115	=item $pw = new urxvt::pw
1992		2116
…		…
1996		2120
1997	Set the callback to be called when the timer triggers.	2121	Set the callback to be called when the timer triggers.
1998		2122
1999	=item $pw = $timer->start ($pid)	2123	=item $pw = $timer->start ($pid)
2000		2124
2001	Tells the wqtcher to start watching for process C<$pid>.	2125	Tells the watcher to start watching for process C<$pid>.
2002		2126
2003	=item $pw = $pw->stop	2127	=item $pw = $pw->stop
2004		2128
2005	Stop the watcher.	2129	Stop the watcher.
2006		2130
…		…
2019		2143
2020	=item >= 3 - script loading and management	2144	=item >= 3 - script loading and management
2021		2145
2022	=item >=10 - all called hooks	2146	=item >=10 - all called hooks
2023		2147
2024	=item >=11 - hook reutrn values	2148	=item >=11 - hook return values
2025		2149
2026	=back	2150	=back
2027		2151
2028	=head1 AUTHOR	2152	=head1 AUTHOR
2029		2153
2030	Marc Lehmann <pcg@goof.com>	2154	Marc Lehmann <schmorp@schmorp.de>
2031	http://software.schmorp.de/pkg/rxvt-unicode	2155	http://software.schmorp.de/pkg/rxvt-unicode
2032		2156
2033	=cut	2157	=cut
2034		2158
2035	1	2159	1
		2160
		2161	# vim: sw=3:

Diff Legend

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