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.132 by root, Mon Feb 6 05:40:15 2006 UTC vs.
Revision 1.220 by root, Tue Jun 19 18:17:56 2012 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --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 @@RXVT_NAME@@d, 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<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed
		38	using 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	@@RXVT_NAME@@ -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	The tabbar itself can be configured similarly to a normal terminal, but
211	with a resource class of C<URxvt.tabbed>. In addition, it supports the
212	following four resources (shown with defaults):
213
214	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
215	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
216	URxvt.tabbed.tab-fg: <colour-index, default 0>
217	URxvt.tabbed.tab-bg: <colour-index, default 1>
218
219	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
220	indices.
221
222	=item mark-urls
223
224	Uses per-line display filtering (C<on_line_update>) to underline urls and
225	make them clickable. When middle-clicked, the program specified in the
226	resource C<urlLauncher> (default C<x-www-browser>) will be started with
227	the URL as first argument.
228
229	=item xim-onthespot
230
231	This (experimental) perl extension implements OnTheSpot editing. It does
232	not work perfectly, and some input methods don't seem to work well with
233	OnTheSpot editing in general, but it seems to work at leats for SCIM and
234	kinput2.
235
236	You enable it by specifying this extension and a preedit style of
237	C<OnTheSpot>, i.e.:
238
239	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
240
241	=item automove-background
242
243	This is basically a one-line extension that dynamically changes the background pixmap offset
244	to the window position, in effect creating the same effect as pseudo transparency with
245	a custom pixmap. No scaling is supported in this mode. Exmaple:
246
247	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
248
249	=item block-graphics-to-ascii
250
251	A not very useful example of filtering all text output to the terminal,
252	by replacing all line-drawing characters (U+2500 .. U+259F) by a
253	similar-looking ascii character.
254
255	=item digital-clock
256
257	Displays a digital clock using the built-in overlay.
258
259	=item remote-clipboard
260
261	Somewhat of a misnomer, this extension adds two menu entries to the
262	selection popup that allows one ti run external commands to store the
263	selection somewhere and fetch it again.
264
265	We use it to implement a "distributed selection mechanism", which just
266	means that one command uploads the file to a remote server, and another
267	reads it.
268
269	The commands can be set using the C<URxvt.remote-selection.store> and
270	C<URxvt.remote-selection.fetch> resources. The first should read the
271	selection to store from STDIN (always in UTF-8), the second should provide
272	the selection data on STDOUT (also in UTF-8).
273
274	The defaults (which are likely useless to you) use rsh and cat:
275
276	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
277	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
278
279	=item selection-pastebin
280
281	This is a little rarely useful extension that Uploads the selection as
282	textfile to a remote site (or does other things). (The implementation is
283	not currently secure for use in a multiuser environment as it writes to
284	F</tmp> directly.).
285
286	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
287	i.e.
288
289	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
290
291	Pressing this combination runs a command with C<%> replaced by the name of
292	the textfile. This command can be set via a resource:
293
294	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
295
296	And the default is likely not useful to anybody but the few people around
297	here :)
298
299	The name of the textfile is the hex encoded md5 sum of the selection, so
300	the same content should lead to the same filename.
301
302	After a successful upload the selection will be replaced by the text given
303	in the C<selection-pastebin-url> resource (again, the % is the placeholder
304	for the filename):
305
306	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
307
308	=item example-refresh-hooks
309
310	Displays a very simple digital clock in the upper right corner of the
311	window. Illustrates overwriting the refresh callbacks to create your own
312	overlays or changes.
313
314	=back
315		50
316	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
317		52
318	=head2 General API Considerations	53	=head2 General API Considerations
319		54
…		…
333		68
334	=over 4	69	=over 4
335		70
336	=item $text	71	=item $text
337		72
338	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
339	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.
340		75
341	=item $string	76	=item $string
342		77
343	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
…		…
347	=item $octets	82	=item $octets
348		83
349	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
350	locale-specific way.	85	locale-specific way.
351		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
352	=back	93	=back
353		94
354	=head2 Extension Objects	95	=head2 Extension Objects
355		96
356	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
357	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,
358	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
359	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
360	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
361	use.	103	internal use.
362		104
363	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
364	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
365		107
366	It has the following methods and data members:	108	It has the following methods and data members:
…		…
370	=item $urxvt_term = $self->{term}	112	=item $urxvt_term = $self->{term}
371		113
372	Returns the C<urxvt::term> object associated with this instance of the	114	Returns the C<urxvt::term> object associated with this instance of the
373	extension. This member I<must not> be changed in any way.	115	extension. This member I<must not> be changed in any way.
374		116
375	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	117	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
376		118
377	Dynamically enable the given hooks (named without the C<on_> prefix) for	119	Dynamically enable the given hooks (named without the C<on_> prefix) for
378	this extension, replacing any previous hook. This is useful when you want	120	this extension, replacing any previous hook. This is useful when you want
379	to overwrite time-critical hooks only temporarily.	121	to overwrite time-critical hooks only temporarily.
380		122
		123	To install additional callbacks for the same hook, you cna use the C<on>
		124	method of the C<urxvt::term> class.
		125
381	=item $self->disable ($hook_name[, $hook_name..])	126	=item $self->disable ($hook_name[, $hook_name..])
382		127
383	Dynamically disable the given hooks.	128	Dynamically disable the given hooks.
		129
		130	=item $self->x_resource ($pattern)
		131
		132	=item $self->x_resource_boolean ($pattern)
		133
		134	These methods support an additional C<%> prefix when called on an
		135	extension object - see the description of these methods in the
		136	C<urxvt::term> class for details.
384		137
385	=back	138	=back
386		139
387	=head2 Hooks	140	=head2 Hooks
388		141
389	The following subroutines can be declared in extension files, and will be	142	The following subroutines can be declared in extension files, and will be
390	called whenever the relevant event happens.	143	called whenever the relevant event happens.
391		144
392	The first argument passed to them is an extension oject as described in	145	The first argument passed to them is an extension object as described in
393	the in the C<Extension Objects> section.	146	the in the C<Extension Objects> section.
394		147
395	B<All> of these hooks must return a boolean value. If any of the called	148	B<All> of these hooks must return a boolean value. If any of the called
396	hooks returns true, then the event counts as being I<consumed>, and the	149	hooks returns true, then the event counts as being I<consumed>, and the
397	relevant action might not be carried out by the C++ code.	150	relevant action might not be carried out by the C++ code.
…		…
410	place.	163	place.
411		164
412	=item on_start $term	165	=item on_start $term
413		166
414	Called at the very end of initialisation of a new terminal, just before	167	Called at the very end of initialisation of a new terminal, just before
415	trying to map (display) the toplevel and returning to the mainloop.	168	trying to map (display) the toplevel and returning to the main loop.
416		169
417	=item on_destroy $term	170	=item on_destroy $term
418		171
419	Called whenever something tries to destroy terminal, when the terminal is	172	Called whenever something tries to destroy terminal, when the terminal is
420	still fully functional (not for long, though).	173	still fully functional (not for long, though).
…		…
447		200
448	Called whenever a selection has been copied, but before the selection is	201	Called whenever a selection has been copied, but before the selection is
449	requested from the server. The selection text can be queried and changed	202	requested from the server. The selection text can be queried and changed
450	by calling C<< $term->selection >>.	203	by calling C<< $term->selection >>.
451		204
452	Returning a true value aborts selection grabbing. It will still be hilighted.	205	Returning a true value aborts selection grabbing. It will still be highlighted.
453		206
454	=item on_sel_extend $term	207	=item on_sel_extend $term
455		208
456	Called whenever the user tries to extend the selection (e.g. with a double	209	Called whenever the user tries to extend the selection (e.g. with a double
457	click) and is either supposed to return false (normal operation), or	210	click) and is either supposed to return false (normal operation), or
458	should extend the selection itelf and return true to suppress the built-in	211	should extend the selection itself and return true to suppress the built-in
459	processing. This can happen multiple times, as long as the callback	212	processing. This can happen multiple times, as long as the callback
460	returns true, it will be called on every further click by the user and is	213	returns true, it will be called on every further click by the user and is
461	supposed to enlarge the selection more and more, if possible.	214	supposed to enlarge the selection more and more, if possible.
462		215
463	See the F<selection> example extension.	216	See the F<selection> example extension.
464		217
465	=item on_view_change $term, $offset	218	=item on_view_change $term, $offset
466		219
467	Called whenever the view offset changes, i..e the user or program	220	Called whenever the view offset changes, i.e. the user or program
468	scrolls. Offset C<0> means display the normal terminal, positive values	221	scrolls. Offset C<0> means display the normal terminal, positive values
469	show this many lines of scrollback.	222	show this many lines of scrollback.
470		223
471	=item on_scroll_back $term, $lines, $saved	224	=item on_scroll_back $term, $lines, $saved
472		225
…		…
476		229
477	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	230	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
478	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	231	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
479	number of lines that will be in the scrollback buffer.	232	number of lines that will be in the scrollback buffer.
480		233
481	=item on_osc_seq $term, $string	234	=item on_osc_seq $term, $op, $args, $resp
		235
		236	Called on every OSC sequence and can be used to suppress it or modify its
		237	behaviour. The default should be to return an empty list. A true value
		238	suppresses execution of the request completely. Make sure you don't get
		239	confused by recursive invocations when you output an OSC sequence within
		240	this callback.
		241
		242	C<on_osc_seq_perl> should be used for new behaviour.
		243
		244	=item on_osc_seq_perl $term, $args, $resp
482		245
483	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	246	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
484	operating system command) is processed. Cursor position and other state	247	operating system command) is processed. Cursor position and other state
485	information is up-to-date when this happens. For interoperability, the	248	information is up-to-date when this happens. For interoperability, the
486	string should start with the extension name and a colon, to distinguish	249	string should start with the extension name (sans -osc) and a semicolon,
487	it from commands for other extensions, and this might be enforced in the	250	to distinguish it from commands for other extensions, and this might be
488	future.	251	enforced in the future.
		252
		253	For example, C<overlay-osc> uses this:
		254
		255	sub on_osc_seq_perl {
		256	my ($self, $osc, $resp) = @_;
		257
		258	return unless $osc =~ s/^overlay;//;
		259
		260	... process remaining $osc string
		261	}
489		262
490	Be careful not ever to trust (in a security sense) the data you receive,	263	Be careful not ever to trust (in a security sense) the data you receive,
491	as its source can not easily be controleld (e-mail content, messages from	264	as its source can not easily be controlled (e-mail content, messages from
492	other users on the same system etc.).	265	other users on the same system etc.).
		266
		267	For responses, C<$resp> contains the end-of-args separator used by the
		268	sender.
493		269
494	=item on_add_lines $term, $string	270	=item on_add_lines $term, $string
495		271
496	Called whenever text is about to be output, with the text as argument. You	272	Called whenever text is about to be output, with the text as argument. You
497	can filter/change and output the text yourself by returning a true value	273	can filter/change and output the text yourself by returning a true value
…		…
502	=item on_tt_write $term, $octets	278	=item on_tt_write $term, $octets
503		279
504	Called whenever some data is written to the tty/pty and can be used to	280	Called whenever some data is written to the tty/pty and can be used to
505	suppress or filter tty input.	281	suppress or filter tty input.
506		282
		283	=item on_tt_paste $term, $octets
		284
		285	Called whenever text is about to be pasted, with the text as argument. You
		286	can filter/change and paste the text yourself by returning a true value
		287	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		288	locale-encoded.
		289
507	=item on_line_update $term, $row	290	=item on_line_update $term, $row
508		291
509	Called whenever a line was updated or changed. Can be used to filter	292	Called whenever a line was updated or changed. Can be used to filter
510	screen output (e.g. underline urls or other useless stuff). Only lines	293	screen output (e.g. underline urls or other useless stuff). Only lines
511	that are being shown will be filtered, and, due to performance reasons,	294	that are being shown will be filtered, and, due to performance reasons,
…		…
518	later with the already-modified line (e.g. if unrelated parts change), so	301	later with the already-modified line (e.g. if unrelated parts change), so
519	you cannot just toggle rendition bits, but only set them.	302	you cannot just toggle rendition bits, but only set them.
520		303
521	=item on_refresh_begin $term	304	=item on_refresh_begin $term
522		305
523	Called just before the screen gets redrawn. Can be used for overlay	306	Called just before the screen gets redrawn. Can be used for overlay or
524	or similar effects by modify terminal contents in refresh_begin, and	307	similar effects by modifying the terminal contents in refresh_begin, and
525	restoring them in refresh_end. The built-in overlay and selection display	308	restoring them in refresh_end. The built-in overlay and selection display
526	code is run after this hook, and takes precedence.	309	code is run after this hook, and takes precedence.
527		310
528	=item on_refresh_end $term	311	=item on_refresh_end $term
529		312
530	Called just after the screen gets redrawn. See C<on_refresh_begin>.	313	Called just after the screen gets redrawn. See C<on_refresh_begin>.
531		314
532	=item on_user_command $term, $string	315	=item on_user_command $term, $string
533		316
534	Called whenever the a user-configured event is being activated (e.g. via	317	Called whenever a user-configured event is being activated (e.g. via
535	a C<perl:string> action bound to a key, see description of the B<keysym>	318	a C<perl:string> action bound to a key, see description of the B<keysym>
536	resource in the @@RXVT_NAME@@(1) manpage).	319	resource in the @@RXVT_NAME@@(1) manpage).
537		320
538	The event is simply the action string. This interface is assumed to change	321	The event is simply the action string. This interface is assumed to change
539	slightly in the future.	322	slightly in the future.
		323
		324	=item on_register_command $term, $keysym, $modifiermask, $string
		325
		326	Called after parsing a keysym resource but before registering the
		327	associated binding. If this hook returns TRUE the binding is not
		328	registered. It can be used to modify a binding by calling
		329	C<register_command>.
		330
		331	=item on_resize_all_windows $term, $new_width, $new_height
		332
		333	Called just after the new window size has been calculated, but before
		334	windows are actually being resized or hints are being set. If this hook
		335	returns TRUE, setting of the window hints is being skipped.
540		336
541	=item on_x_event $term, $event	337	=item on_x_event $term, $event
542		338
543	Called on every X event received on the vt window (and possibly other	339	Called on every X event received on the vt window (and possibly other
544	windows). Should only be used as a last resort. Most event structure	340	windows). Should only be used as a last resort. Most event structure
545	members are not passed.	341	members are not passed.
546		342
		343	=item on_root_event $term, $event
		344
		345	Like C<on_x_event>, but is called for events on the root window.
		346
547	=item on_focus_in $term	347	=item on_focus_in $term
548		348
549	Called whenever the window gets the keyboard focus, before rxvt-unicode	349	Called whenever the window gets the keyboard focus, before rxvt-unicode
550	does focus in processing.	350	does focus in processing.
551		351
552	=item on_focus_out $term	352	=item on_focus_out $term
553		353
554	Called wheneever the window loses keyboard focus, before rxvt-unicode does	354	Called whenever the window loses keyboard focus, before rxvt-unicode does
555	focus out processing.	355	focus out processing.
556		356
557	=item on_configure_notify $term, $event	357	=item on_configure_notify $term, $event
558		358
559	=item on_property_notify $term, $event	359	=item on_property_notify $term, $event
…		…
570		370
571	=item on_map_notify $term, $event	371	=item on_map_notify $term, $event
572		372
573	=item on_unmap_notify $term, $event	373	=item on_unmap_notify $term, $event
574		374
575	Called whenever the corresponding X event is received for the terminal If	375	Called whenever the corresponding X event is received for the terminal. If
576	the hook returns true, then the even will be ignored by rxvt-unicode.	376	the hook returns true, then the event will be ignored by rxvt-unicode.
577		377
578	The event is a hash with most values as named by Xlib (see the XEvent	378	The event is a hash with most values as named by Xlib (see the XEvent
579	manpage), with the additional members C<row> and C<col>, which are the	379	manpage), with the additional members C<row> and C<col>, which are the
580	(real, not screen-based) row and column under the mouse cursor.	380	(real, not screen-based) row and column under the mouse cursor.
581		381
…		…
591	=item on_wm_delete_window $term, $event	391	=item on_wm_delete_window $term, $event
592		392
593	Called when various types of ClientMessage events are received (all with	393	Called when various types of ClientMessage events are received (all with
594	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	394	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
595		395
		396	=item on_bell $term
		397
		398	Called on receipt of a bell character.
		399
596	=back	400	=back
597		401
598	=cut	402	=cut
599		403
600	package urxvt;	404	package urxvt;
601		405
602	use utf8;	406	use utf8;
603	use strict;	407	use strict 'vars';
604	use Carp ();	408	use Carp ();
605	use Scalar::Util ();	409	use Scalar::Util ();
606	use List::Util ();	410	use List::Util ();
607		411
608	our $VERSION = 1;	412	our $VERSION = 1;
609	our $TERM;	413	our $TERM;
610	our @TERM_INIT;	414	our @TERM_INIT; # should go, prevents async I/O etc.
611	our @TERM_EXT;	415	our @TERM_EXT; # should go, prevents async I/O etc.
612	our @HOOKNAME;	416	our @HOOKNAME;
613	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
614	our %OPTION;	418	our %OPTION;
615		419
616	our $LIBDIR;	420	our $LIBDIR;
…		…
642	The current terminal. This variable stores the current C<urxvt::term>	446	The current terminal. This variable stores the current C<urxvt::term>
643	object, whenever a callback/hook is executing.	447	object, whenever a callback/hook is executing.
644		448
645	=item @urxvt::TERM_INIT	449	=item @urxvt::TERM_INIT
646		450
647	All coderefs in this array will be called as methods of the next newly	451	All code references in this array will be called as methods of the next newly
648	created C<urxvt::term> object (during the C<on_init> phase). The array	452	created C<urxvt::term> object (during the C<on_init> phase). The array
649	gets cleared before the codereferences that were in it are being executed,	453	gets cleared before the code references that were in it are being executed,
650	so coderefs can push themselves onto it again if they so desire.	454	so references can push themselves onto it again if they so desire.
651		455
652	This complements to the perl-eval commandline option, but gets executed	456	This complements to the perl-eval command line option, but gets executed
653	first.	457	first.
654		458
655	=item @urxvt::TERM_EXT	459	=item @urxvt::TERM_EXT
656		460
657	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	461	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
664		468
665	=over 4	469	=over 4
666		470
667	=item urxvt::fatal $errormessage	471	=item urxvt::fatal $errormessage
668		472
669	Fatally aborts execution with the given error message. Avoid at all	473	Fatally aborts execution with the given error message (which should
670	costs! The only time this is acceptable is when the terminal process	474	include a trailing newline). Avoid at all costs! The only time this
671	starts up.	475	is acceptable (and useful) is in the init hook, where it prevents the
		476	terminal from starting up.
672		477
673	=item urxvt::warn $string	478	=item urxvt::warn $string
674		479
675	Calls C<rxvt_warn> with the given string which should not include a	480	Calls C<rxvt_warn> with the given string which should include a trailing
676	newline. The module also overwrites the C<warn> builtin with a function	481	newline. The module also overwrites the C<warn> builtin with a function
677	that calls this function.	482	that calls this function.
678		483
679	Using this function has the advantage that its output ends up in the	484	Using this function has the advantage that its output ends up in the
680	correct place, e.g. on stderr of the connecting urxvtc client.	485	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
682	Messages have a size limit of 1023 bytes currently.	487	Messages have a size limit of 1023 bytes currently.
683		488
684	=item @terms = urxvt::termlist	489	=item @terms = urxvt::termlist
685		490
686	Returns all urxvt::term objects that exist in this process, regardless of	491	Returns all urxvt::term objects that exist in this process, regardless of
687	wether they are started, being destroyed etc., so be careful. Only term	492	whether they are started, being destroyed etc., so be careful. Only term
688	objects that have perl extensions attached will be returned (because there	493	objects that have perl extensions attached will be returned (because there
689	is no urxvt::term objet associated with others).	494	is no urxvt::term object associated with others).
690		495
691	=item $time = urxvt::NOW	496	=item $time = urxvt::NOW
692		497
693	Returns the "current time" (as per the event loop).	498	Returns the "current time" (as per the event loop).
694		499
…		…
737		542
738	=item $rend = urxvt::OVERLAY_RSTYLE	543	=item $rend = urxvt::OVERLAY_RSTYLE
739		544
740	Return the rendition mask used for overlays by default.	545	Return the rendition mask used for overlays by default.
741		546
742	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	547	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		548	urxvt::RS_RVid, urxvt::RS_Uline
743		549
744	Return the bit that enabled bold, italic, blink, reverse-video and	550	Return the bit that enabled bold, italic, blink, reverse-video and
745	underline, respectively. To enable such a style, just logically OR it into	551	underline, respectively. To enable such a style, just logically OR it into
746	the bitset.	552	the bitset.
747		553
…		…
784	};	590	};
785	}	591	}
786		592
787	no warnings 'utf8';	593	no warnings 'utf8';
788		594
		595	sub parse_resource {
		596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		597
		598	$name =~ y/-/./ if $isarg;
		599
		600	$term->scan_meta;
		601
		602	my $r = $term->{meta}{resource};
		603	keys %$r; # reste iterator
		604	while (my ($pattern, $v) = each %$r) {
		605	if (
		606	$pattern =~ /\.$/
		607	? $pattern eq substr $name, 0, length $pattern
		608	: $pattern eq $name
		609	) {
		610	$name = "$urxvt::RESCLASS.$name";
		611
		612	push @{ $term->{perl_ext_3} }, $v->[0];
		613
		614	if ($v->[1] eq "boolean") {
		615	$term->put_option_db ($name, $flag ? "true" : "false");
		616	return 1;
		617	} else {
		618	$term->put_option_db ($name, $value);
		619	return 1 + 2;
		620	}
		621	}
		622	}
		623
		624	0
		625	}
		626
		627	sub usage {
		628	my ($term, $usage_type) = @_;
		629
		630	$term->scan_meta;
		631
		632	my $r = $term->{meta}{resource};
		633
		634	for my $pattern (sort keys %$r) {
		635	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		636
		637	$desc .= " (-pe $ext)";
		638
		639	if ($usage_type == 1) {
		640	$pattern =~ y/./-/;
		641	$pattern =~ s/-$/-.../g;
		642
		643	if ($type eq "boolean") {
		644	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		645	} else {
		646	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		647	}
		648	} else {
		649	$pattern =~ s/\.$/.*/g;
		650	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		651	}
		652	}
		653	}
		654
789	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	655	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
790		656
791	sub verbose {	657	sub verbose {
792	my ($level, $msg) = @_;	658	my ($level, $msg) = @_;
793	warn "$msg\n" if $level <= $verbosity;	659	warn "$msg\n" if $level <= $verbosity;
…		…
805	$pkg =~ s/[^[:word:]]/_/g;	671	$pkg =~ s/[^[:word:]]/_/g;
806	$pkg = "urxvt::ext::$pkg";	672	$pkg = "urxvt::ext::$pkg";
807		673
808	verbose 3, "loading extension '$path' into package '$pkg'";	674	verbose 3, "loading extension '$path' into package '$pkg'";
809		675
		676	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		677
810	open my $fh, "<:raw", $path	678	open my $fh, "<:raw", $path
811	or die "$path: $!";	679	or die "$path: $!";
812		680
813	my $source =	681	my $source =
814	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	682	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
815	. "#line 1 \"$path\"\n{\n"	683	. "#line 1 \"$path\"\n{\n"
816	. (do { local $/; <$fh> })	684	. (do { local $/; <$fh> })
817	. "\n};\n1";	685	. "\n};\n1";
818		686
819	eval $source	687	eval $source
…		…
829	sub invoke {	697	sub invoke {
830	local $TERM = shift;	698	local $TERM = shift;
831	my $htype = shift;	699	my $htype = shift;
832		700
833	if ($htype == 0) { # INIT	701	if ($htype == 0) { # INIT
834	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	702	my @dirs = $TERM->perl_libdirs;
835		703
836	my %ext_arg;	704	my %ext_arg;
837		705
838	{	706	{
839	my @init = @TERM_INIT;	707	my @init = @TERM_INIT;
840	@TERM_INIT = ();	708	@TERM_INIT = ();
…		…
842	my @pkg = @TERM_EXT;	710	my @pkg = @TERM_EXT;
843	@TERM_EXT = ();	711	@TERM_EXT = ();
844	$TERM->register_package ($_) for @pkg;	712	$TERM->register_package ($_) for @pkg;
845	}	713	}
846		714
		715	for (
		716	@{ delete $TERM->{perl_ext_3} },
847	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	717	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		718	) {
848	if ($_ eq "default") {	719	if ($_ eq "default") {
849	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	720	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
850	} elsif (/^-(.*)$/) {	721	} elsif (/^-(.*)$/) {
851	delete $ext_arg{$1};	722	delete $ext_arg{$1};
852	} elsif (/^([^<]+)<(.*)>$/) {	723	} elsif (/^([^<]+)<(.*)>$/) {
…		…
854	} else {	725	} else {
855	$ext_arg{$_} ||= [];	726	$ext_arg{$_} ||= [];
856	}	727	}
857	}	728	}
858		729
859	while (my ($ext, $argv) = each %ext_arg) {	730	for my $ext (sort keys %ext_arg) {
860	my @files = grep -f $_, map "$_/$ext", @dirs;	731	my @files = grep -f $_, map "$_/$ext", @dirs;
861		732
862	if (@files) {	733	if (@files) {
863	$TERM->register_package (extension_package $files[0], $argv);	734	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
864	} else {	735	} else {
865	warn "perl extension '$ext' not found in perl library search path\n";	736	warn "perl extension '$ext' not found in perl library search path\n";
866	}	737	}
867	}	738	}
868		739
…		…
874		745
875	if (my $cb = $TERM->{_hook}[$htype]) {	746	if (my $cb = $TERM->{_hook}[$htype]) {
876	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
877	if $verbosity >= 10;	748	if $verbosity >= 10;
878		749
879	keys %$cb;	750	for my $pkg (keys %$cb) {
880
881	while (my ($pkg, $cb) = each %$cb) {
882	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	751	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
883	$retval ||= $retval_;	752	$retval ||= $retval_;
884		753
885	if ($@) {	754	if ($@) {
886	$TERM->ungrab; # better to lose the grab than the session	755	$TERM->ungrab; # better to lose the grab than the session
887	warn $@;	756	warn $@;
…		…
905		774
906	sub SET_COLOR($$$) {	775	sub SET_COLOR($$$) {
907	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	776	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
908	}	777	}
909		778
910	# urxvt::term::extension	779	sub rend2mask {
		780	no strict 'refs';
		781	my ($str, $mask) = (@_, 0);
		782	my %color = ( fg => undef, bg => undef );
		783	my @failed;
		784	for my $spec ( split /\s+/, $str ) {
		785	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		786	$color{lc($1)} = $2;
		787	} else {
		788	my $neg = $spec =~ s/^[-^]//;
		789	unless ( exists &{"RS_$spec"} ) {
		790	push @failed, $spec;
		791	next;
		792	}
		793	my $cur = &{"RS_$spec"};
		794	if ( $neg ) {
		795	$mask &= ~$cur;
		796	} else {
		797	$mask |= $cur;
		798	}
		799	}
		800	}
		801	($mask, @color{qw(fg bg)}, \@failed)
		802	}
911		803
912	package urxvt::term::extension;	804	package urxvt::term::extension;
913		805
914	sub enable {	806	sub enable {
915	my ($self, %hook) = @_;	807	my ($self, %hook) = @_;
…		…
970		862
971	sub urxvt::destroy_hook(&) {	863	sub urxvt::destroy_hook(&) {
972	bless \shift, urxvt::destroy_hook::	864	bless \shift, urxvt::destroy_hook::
973	}	865	}
974		866
		867	sub x_resource {
		868	my ($self, $name) = @_;
		869	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		870	$self->{term}->x_resource ($name)
		871	}
		872
		873	sub x_resource_boolean {
		874	my ($self, $name) = @_;
		875	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		876	$self->{term}->x_resource_boolean ($name)
		877	}
		878
975	package urxvt::anyevent;	879	package urxvt::anyevent;
976		880
977	=head2 The C<urxvt::anyevent> Class	881	=head2 The C<urxvt::anyevent> Class
978		882
979	The sole purpose of this class is to deliver an interface to the	883	The sole purpose of this class is to deliver an interface to the
980	C<AnyEvent> module - any module using it will work inside urxvt without	884	C<AnyEvent> module - any module using it will work inside urxvt without
981	further programming. The only exception is that you cannot wait on	885	further programming. The only exception is that you cannot wait on
982	condition variables, but non-blocking condvar use is ok. What this means	886	condition variables, but non-blocking condvar use is ok.
983	is that you cannot use blocking APIs, but the non-blocking variant should	887
984	work.	888	In practical terms this means is that you cannot use blocking APIs, but
		889	the non-blocking variant should work.
985		890
986	=cut	891	=cut
987		892
988	our $VERSION = 1;	893	our $VERSION = '5.23';
989		894
990	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	895	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
991	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	896	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
992		897
993	sub timer {	898	sub timer {
…		…
995		900
996	my $cb = $arg{cb};	901	my $cb = $arg{cb};
997		902
998	urxvt::timer	903	urxvt::timer
999	->new	904	->new
1000	->start (urxvt::NOW + $arg{after})	905	->after ($arg{after}, $arg{interval})
1001	->cb (sub {	906	->cb ($arg{interval} ? $cb : sub {
1002	$_[0]->stop; # need to cancel manually	907	$_[0]->stop; # need to cancel manually
1003	$cb->();	908	$cb->();
1004	})	909	})
1005	}	910	}
1006		911
1007	sub io {	912	sub io {
1008	my ($class, %arg) = @_;	913	my ($class, %arg) = @_;
1009		914
1010	my $cb = $arg{cb};	915	my $cb = $arg{cb};
		916	my $fd = fileno $arg{fh};
		917	defined $fd or $fd = $arg{fh};
1011		918
1012	bless [$arg{fh}, urxvt::iow	919	bless [$arg{fh}, urxvt::iow
1013	->new	920	->new
1014	->fd (fileno $arg{fh})	921	->fd ($fd)
1015	->events (($arg{poll} =~ /r/ ? 1 : 0)	922	->events (($arg{poll} =~ /r/ ? 1 : 0)
1016	| ($arg{poll} =~ /w/ ? 2 : 0))	923	| ($arg{poll} =~ /w/ ? 2 : 0))
1017	->start	924	->start
1018	->cb (sub {	925	->cb ($cb)
1019	$cb->(($_[1] & 1 ? 'r' : '')
1020	. ($_[1] & 2 ? 'w' : ''));
1021	})],
1022	urxvt::anyevent::	926	], urxvt::anyevent::
		927	}
		928
		929	sub idle {
		930	my ($class, %arg) = @_;
		931
		932	my $cb = $arg{cb};
		933
		934	urxvt::iw
		935	->new
		936	->start
		937	->cb ($cb)
		938	}
		939
		940	sub child {
		941	my ($class, %arg) = @_;
		942
		943	my $cb = $arg{cb};
		944
		945	urxvt::pw
		946	->new
		947	->start ($arg{pid})
		948	->cb (sub {
		949	$_[0]->stop; # need to cancel manually
		950	$cb->($_[0]->rpid, $_[0]->rstatus);
		951	})
1023	}	952	}
1024		953
1025	sub DESTROY {	954	sub DESTROY {
1026	$_[0][1]->stop;	955	$_[0][1]->stop;
1027	}	956	}
1028		957
1029	sub condvar {	958	# only needed for AnyEvent < 6 compatibility
1030	bless \my $flag, urxvt::anyevent::condvar::	959	sub one_event {
1031	}
1032
1033	sub urxvt::anyevent::condvar::broadcast {
1034	${$_[0]}++;
1035	}
1036
1037	sub urxvt::anyevent::condvar::wait {
1038	unless (${$_[0]}) {
1039	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	960	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1040	}
1041	}	961	}
1042		962
1043	package urxvt::term;	963	package urxvt::term;
1044		964
1045	=head2 The C<urxvt::term> Class	965	=head2 The C<urxvt::term> Class
…		…
1058	urxvt::verbose 6, "register package $pkg to $self";	978	urxvt::verbose 6, "register package $pkg to $self";
1059		979
1060	@{"$pkg\::ISA"} = urxvt::term::extension::;	980	@{"$pkg\::ISA"} = urxvt::term::extension::;
1061		981
1062	my $proxy = bless {	982	my $proxy = bless {
1063	_pkg => $pkg,	983	_pkg => $pkg,
		984	_name => ${"$pkg\::_NAME"}, # hackish
1064	argv => $argv,	985	argv => $argv,
1065	}, $pkg;	986	}, $pkg;
1066	Scalar::Util::weaken ($proxy->{term} = $self);	987	Scalar::Util::weaken ($proxy->{term} = $self);
1067		988
1068	$self->{_pkg}{$pkg} = $proxy;	989	$self->{_pkg}{$pkg} = $proxy;
1069		990
…		…
1072	$proxy->enable ($name => $ref);	993	$proxy->enable ($name => $ref);
1073	}	994	}
1074	}	995	}
1075	}	996	}
1076		997
		998	sub perl_libdirs {
		999	map { split /:/ }
		1000	$_[0]->resource ("perl_lib"),
		1001	$ENV{URXVT_PERL_LIB},
		1002	"$ENV{HOME}/.urxvt/ext",
		1003	"$LIBDIR/perl"
		1004	}
		1005
		1006	sub scan_meta {
		1007	my ($self) = @_;
		1008	my @libdirs = perl_libdirs $self;
		1009
		1010	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1011
		1012	my %meta;
		1013
		1014	$self->{meta_libdirs} = join "\x00", @libdirs;
		1015	$self->{meta} = \%meta;
		1016
		1017	for my $dir (reverse @libdirs) {
		1018	opendir my $fh, $dir
		1019	or next;
		1020	for my $ext (readdir $fh) {
		1021	$ext ne "."
		1022	and $ext ne ".."
		1023	and open my $fh, "<", "$dir/$ext"
		1024	or next;
		1025
		1026	while (<$fh>) {
		1027	if (/^#:META:X_RESOURCE:(.*)/) {
		1028	my ($pattern, $type, $desc) = split /:/, $1;
		1029	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1030	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1031	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1032	} else {
		1033	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1034	}
		1035	} elsif (/^\s*(?:#|$)/) {
		1036	# skip other comments and empty lines
		1037	} else {
		1038	last; # stop parsing on first non-empty non-comment line
		1039	}
		1040	}
		1041	}
		1042	}
		1043	}
		1044
1077	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1045	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1078		1046
1079	Creates a new terminal, very similar as if you had started it with system	1047	Creates a new terminal, very similar as if you had started it with system
1080	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1048	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1081	hash which defines the environment of the new terminal.	1049	hash which defines the environment of the new terminal.
…		…
1101		1069
1102	Destroy the terminal object (close the window, free resources	1070	Destroy the terminal object (close the window, free resources
1103	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1071	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
1104	watchers (timers, io watchers) are still active.	1072	watchers (timers, io watchers) are still active.
1105		1073
		1074	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		1075
		1076	Similar to the extension method C<enable>, but installs additional
		1077	callbacks for the givne hook(s) (existing ones are not replaced), and
		1078	returns a guard object. When the guard object is destroyed the callbacks
		1079	are disabled again.
		1080
		1081	Note that these callbacks receive the normal paramaters, but the first
		1082	argument (normally the extension) is currently undefined.
		1083
		1084	=cut
		1085
		1086	sub urxvt::term::on_disable::DESTROY {
		1087	my $disable = shift;
		1088
		1089	my $self = delete $disable->{""};
		1090
		1091	while (my ($htype, $id) = each %$disable) {
		1092	delete $self->{_hook}[$htype]{$id};
		1093	$self->set_should_invoke ($htype, -1);
		1094	}
		1095	}
		1096
		1097	sub on {
		1098	my ($self, %hook) = @_;
		1099
		1100	my %disable = ( "" => $self );
		1101
		1102	while (my ($name, $cb) = each %hook) {
		1103	my $htype = $HOOKTYPE{uc $name};
		1104	defined $htype
		1105	or Carp::croak "unsupported hook type '$name'";
		1106
		1107	my $id = $cb+0;
		1108
		1109	$self->set_should_invoke ($htype, +1);
		1110	$disable{$htype} = $id;
		1111	$self->{_hook}[$htype]{$id} = $cb;
		1112	}
		1113
		1114	bless \%disable, "urxvt::term::on_disable"
		1115	}
		1116
1106	=item $term->exec_async ($cmd[, @args])	1117	=item $term->exec_async ($cmd[, @args])
1107		1118
1108	Works like the combination of the C<fork>/C<exec> builtins, which executes	1119	Works like the combination of the C<fork>/C<exec> builtins, which executes
1109	("starts") programs in the background. This function takes care of setting	1120	("starts") programs in the background. This function takes care of setting
1110	the user environment before exec'ing the command (e.g. C<PATH>) and should	1121	the user environment before exec'ing the command (e.g. C<PATH>) and should
…		…
1132		1143
1133	Returns true if the option specified by C<$optval> is enabled, and	1144	Returns true if the option specified by C<$optval> is enabled, and
1134	optionally change it. All option values are stored by name in the hash	1145	optionally change it. All option values are stored by name in the hash
1135	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1146	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1136		1147
1137	Here is a a likely non-exhaustive list of option names, please see the	1148	Here is a likely non-exhaustive list of option names, please see the
1138	source file F</src/optinc.h> to see the actual list:	1149	source file F</src/optinc.h> to see the actual list:
1139		1150
1140	borderLess console cursorBlink cursorUnderline hold iconic insecure	1151	borderLess buffered console cursorBlink cursorUnderline hold iconic
1141	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1152	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1142	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1153	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1143	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1154	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1144	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1155	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1145	transparent tripleclickwords utmpInhibit visualBell	1156	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1157	urgentOnBell utmpInhibit visualBell
1146		1158
1147	=item $value = $term->resource ($name[, $newval])	1159	=item $value = $term->resource ($name[, $newval])
1148		1160
1149	Returns the current resource value associated with a given name and	1161	Returns the current resource value associated with a given name and
1150	optionally sets a new value. Setting values is most useful in the C<init>	1162	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1159	likely change).	1171	likely change).
1160		1172
1161	Please note that resource strings will currently only be freed when the	1173	Please note that resource strings will currently only be freed when the
1162	terminal is destroyed, so changing options frequently will eat memory.	1174	terminal is destroyed, so changing options frequently will eat memory.
1163		1175
1164	Here is a a likely non-exhaustive list of resource names, not all of which	1176	Here is a likely non-exhaustive list of resource names, not all of which
1165	are supported in every build, please see the source file F</src/rsinc.h>	1177	are supported in every build, please see the source file F</src/rsinc.h>
1166	to see the actual list:	1178	to see the actual list:
1167		1179
1168	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1180	answerbackstring backgroundPixmap backspace_key blurradius
1169	borderLess color cursorBlink cursorUnderline cutchars delete_key	1181	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1170	display_name embed ext_bwidth fade font geometry hold iconName	1182	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1171	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1183	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1184	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1172	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1185	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1173	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1186	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1174	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1187	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1175	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1188	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1176	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1189	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1177	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1190	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1178	secondaryScreen secondaryScroll selectstyle shade term_name title	1191	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1179	transient_for transparent transparent_all tripleclickwords utmpInhibit	1192	term_name title transient_for transparent tripleclickwords urgentOnBell
1180	visualBell	1193	utmpInhibit visualBell
1181		1194
1182	=cut	1195	=cut
1183		1196
1184	sub resource($$;$) {	1197	sub resource($$;$) {
1185	my ($self, $name) = (shift, shift);	1198	my ($self, $name) = (shift, shift);
1186	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1199	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1187	&urxvt::term::_resource	1200	goto &urxvt::term::_resource
1188	}	1201	}
1189		1202
1190	=item $value = $term->x_resource ($pattern)	1203	=item $value = $term->x_resource ($pattern)
1191		1204
1192	Returns the X-Resource for the given pattern, excluding the program or	1205	Returns the X-Resource for the given pattern, excluding the program or
1193	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1206	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1194	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1207	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1195	resource with that pattern exists.	1208	resource with that pattern exists.
1196		1209
		1210	Extensions that define extra resource or command line arguments also need
		1211	to call this method to access their values.
		1212
		1213	If the method is called on an extension object (basically, from an
		1214	extension), then the special prefix C<%.> will be replaced by the name of
		1215	the extension and a dot, and the lone string C<%> will be replaced by the
		1216	extension name itself. This makes it possible to code extensions so you
		1217	can rename them and get a new set of commandline switches and resources
		1218	without having to change the actual code.
		1219
1197	This method should only be called during the C<on_start> hook, as there is	1220	This method should only be called during the C<on_start> hook, as there is
1198	only one resource database per display, and later invocations might return	1221	only one resource database per display, and later invocations might return
1199	the wrong resources.	1222	the wrong resources.
1200		1223
1201	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1224	=item $value = $term->x_resource_boolean ($pattern)
1202		1225
		1226	Like C<x_resource>, above, but interprets the string value as a boolean
		1227	and returns C<1> for true values, C<0> for false values and C<undef> if
		1228	the resource or option isn't specified.
		1229
		1230	You should always use this method to parse boolean resources.
		1231
		1232	=cut
		1233
		1234	sub x_resource_boolean {
		1235	my $res = &x_resource;
		1236
		1237	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1238	}
		1239
		1240	=item $success = $term->parse_keysym ($key, $octets)
		1241
1203	Adds a keymap translation exactly as specified via a resource. See the	1242	Adds a key binding exactly as specified via a resource. See the
1204	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1243	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1244
		1245	=item $term->register_command ($keysym, $modifiermask, $string)
		1246
		1247	Adds a key binding. This is a lower level api compared to
		1248	C<parse_keysym>, as it expects a parsed key description, and can be
		1249	used only inside either the C<on_init> hook, to add a binding, or the
		1250	C<on_register_command> hook, to modify a parsed binding.
1205		1251
1206	=item $rend = $term->rstyle ([$new_rstyle])	1252	=item $rend = $term->rstyle ([$new_rstyle])
1207		1253
1208	Return and optionally change the current rendition. Text that is output by	1254	Return and optionally change the current rendition. Text that is output by
1209	the terminal application will use this style.	1255	the terminal application will use this style.
…		…
1217		1263
1218	=item ($row, $col) = $term->selection_beg ([$row, $col])	1264	=item ($row, $col) = $term->selection_beg ([$row, $col])
1219		1265
1220	=item ($row, $col) = $term->selection_end ([$row, $col])	1266	=item ($row, $col) = $term->selection_end ([$row, $col])
1221		1267
1222	Return the current values of the selection mark, begin or end positions,	1268	Return the current values of the selection mark, begin or end positions.
1223	and optionally set them to new values.	1269
		1270	When arguments are given, then the selection coordinates are set to
		1271	C<$row> and C<$col>, and the selection screen is set to the current
		1272	screen.
		1273
		1274	=item $screen = $term->selection_screen ([$screen])
		1275
		1276	Returns the current selection screen, and then optionally sets it.
1224		1277
1225	=item $term->selection_make ($eventtime[, $rectangular])	1278	=item $term->selection_make ($eventtime[, $rectangular])
1226		1279
1227	Tries to make a selection as set by C<selection_beg> and	1280	Tries to make a selection as set by C<selection_beg> and
1228	C<selection_end>. If C<$rectangular> is true (default: false), a	1281	C<selection_end>. If C<$rectangular> is true (default: false), a
1229	rectangular selection will be made. This is the prefered function to make	1282	rectangular selection will be made. This is the preferred function to make
1230	a selection.	1283	a selection.
1231		1284
1232	=item $success = $term->selection_grab ($eventtime)	1285	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1233		1286
1234	Try to request the primary selection text from the server (for example, as	1287	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1288	true) selection from the server. The corresponding text can be set
1235	set by the next method). No visual feedback will be given. This function	1289	with the next method. No visual feedback will be given. This function
1236	is mostly useful from within C<on_sel_grab> hooks.	1290	is mostly useful from within C<on_sel_grab> hooks.
1237		1291
1238	=item $oldtext = $term->selection ([$newtext])	1292	=item $oldtext = $term->selection ([$newtext, $clipboard])
1239		1293
1240	Return the current selection text and optionally replace it by C<$newtext>.	1294	Return the current selection (clipboard if C<$clipboard> is true) text
		1295	and optionally replace it by C<$newtext>.
		1296
		1297	=item $term->selection_clear ([$clipboard])
		1298
		1299	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1241		1300
1242	=item $term->overlay_simple ($x, $y, $text)	1301	=item $term->overlay_simple ($x, $y, $text)
1243		1302
1244	Create a simple multi-line overlay box. See the next method for details.	1303	Create a simple multi-line overlay box. See the next method for details.
1245		1304
…		…
1275		1334
1276	The methods currently supported on C<urxvt::overlay> objects are:	1335	The methods currently supported on C<urxvt::overlay> objects are:
1277		1336
1278	=over 4	1337	=over 4
1279		1338
1280	=item $overlay->set ($x, $y, $text, $rend)	1339	=item $overlay->set ($x, $y, $text[, $rend])
1281		1340
1282	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1341	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1283	text in rxvt-unicode's special encoding and an array of rendition values	1342	text in rxvt-unicode's special encoding and an array of rendition values
1284	at a specific position inside the overlay.	1343	at a specific position inside the overlay.
		1344
		1345	If C<$rend> is missing, then the rendition will not be changed.
1285		1346
1286	=item $overlay->hide	1347	=item $overlay->hide
1287		1348
1288	If visible, hide the overlay, but do not destroy it.	1349	If visible, hide the overlay, but do not destroy it.
1289		1350
…		…
1371	locale-specific encoding of the terminal and can contain command sequences	1432	locale-specific encoding of the terminal and can contain command sequences
1372	(escape codes) that will be interpreted.	1433	(escape codes) that will be interpreted.
1373		1434
1374	=item $term->tt_write ($octets)	1435	=item $term->tt_write ($octets)
1375		1436
1376	Write the octets given in C<$data> to the tty (i.e. as program input). To	1437	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1377	pass characters instead of octets, you should convert your strings first	1438	pass characters instead of octets, you should convert your strings first
1378	to the locale-specific encoding using C<< $term->locale_encode >>.	1439	to the locale-specific encoding using C<< $term->locale_encode >>.
		1440
		1441	=item $term->tt_paste ($octets)
		1442
		1443	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1444	CR and bracketing the data with control sequences if bracketed paste mode
		1445	is set.
1379		1446
1380	=item $old_events = $term->pty_ev_events ([$new_events])	1447	=item $old_events = $term->pty_ev_events ([$new_events])
1381		1448
1382	Replaces the event mask of the pty watcher by the given event mask. Can	1449	Replaces the event mask of the pty watcher by the given event mask. Can
1383	be used to suppress input and output handling to the pty/tty. See the	1450	be used to suppress input and output handling to the pty/tty. See the
…		…
1402	Adds the specified events to the vt event mask. Useful e.g. when you want	1469	Adds the specified events to the vt event mask. Useful e.g. when you want
1403	to receive pointer events all the times:	1470	to receive pointer events all the times:
1404		1471
1405	$term->vt_emask_add (urxvt::PointerMotionMask);	1472	$term->vt_emask_add (urxvt::PointerMotionMask);
1406		1473
		1474	=item $term->set_urgency ($set)
		1475
		1476	Enable/disable the urgency hint on the toplevel window.
		1477
1407	=item $term->focus_in	1478	=item $term->focus_in
1408		1479
1409	=item $term->focus_out	1480	=item $term->focus_out
1410		1481
1411	=item $term->key_press ($state, $keycode[, $time])	1482	=item $term->key_press ($state, $keycode[, $time])
…		…
1451	=item $env = $term->env	1522	=item $env = $term->env
1452		1523
1453	Returns a copy of the environment in effect for the terminal as a hashref	1524	Returns a copy of the environment in effect for the terminal as a hashref
1454	similar to C<\%ENV>.	1525	similar to C<\%ENV>.
1455		1526
		1527	=item @envv = $term->envv
		1528
		1529	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1530
		1531	=item @argv = $term->argv
		1532
		1533	Return the argument vector as this terminal, similar to @ARGV, but
		1534	includes the program name as first element.
		1535
1456	=cut	1536	=cut
1457		1537
1458	sub env {	1538	sub env {
1459	if (my $env = $_[0]->_env) {
1460	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1539	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1461	} else {
1462	+{ %ENV }
1463	}
1464	}	1540	}
1465		1541
1466	=item $modifiermask = $term->ModLevel3Mask	1542	=item $modifiermask = $term->ModLevel3Mask
1467		1543
1468	=item $modifiermask = $term->ModMetaMask	1544	=item $modifiermask = $term->ModMetaMask
…		…
1476		1552
1477	Returns the currently displayed screen (0 primary, 1 secondary).	1553	Returns the currently displayed screen (0 primary, 1 secondary).
1478		1554
1479	=item $cursor_is_hidden = $term->hidden_cursor	1555	=item $cursor_is_hidden = $term->hidden_cursor
1480		1556
1481	Returns wether the cursor is currently hidden or not.	1557	Returns whether the cursor is currently hidden or not.
1482		1558
1483	=item $view_start = $term->view_start ([$newvalue])	1559	=item $view_start = $term->view_start ([$newvalue])
1484		1560
1485	Returns the row number of the topmost displayed line. Maximum value is	1561	Returns the row number of the topmost displayed line. Maximum value is
1486	C<0>, which displays the normal terminal contents. Lower values scroll	1562	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1494		1570
1495	Used after changing terminal contents to display them.	1571	Used after changing terminal contents to display them.
1496		1572
1497	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1573	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1498		1574
1499	Returns the text of the entire row with number C<$row_number>. Row C<0>	1575	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1500	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1576	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1501	terminal line. The scrollback buffer starts at line C<-1> and extends to
1502	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1577	terminal line. Nothing will be returned if a nonexistent line
1503	is requested.	1578	is requested.
1504		1579
1505	If C<$new_text> is specified, it will replace characters in the current	1580	If C<$new_text> is specified, it will replace characters in the current
1506	line, starting at column C<$start_col> (default C<0>), which is useful	1581	line, starting at column C<$start_col> (default C<0>), which is useful
1507	to replace only parts of a line. The font index in the rendition will	1582	to replace only parts of a line. The font index in the rendition will
1508	automatically be updated.	1583	automatically be updated.
1509		1584
1510	C<$text> is in a special encoding: tabs and wide characters that use more	1585	C<$text> is in a special encoding: tabs and wide characters that use more
1511	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1586	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1512	characters. Characters with combining characters and other characters that	1587	characters. Characters with combining characters and other characters that
1513	do not fit into the normal tetx encoding will be replaced with characters	1588	do not fit into the normal text encoding will be replaced with characters
1514	in the private use area.	1589	in the private use area.
1515		1590
1516	You have to obey this encoding when changing text. The advantage is	1591	You have to obey this encoding when changing text. The advantage is
1517	that C<substr> and similar functions work on screen cells and not on	1592	that C<substr> and similar functions work on screen cells and not on
1518	characters.	1593	characters.
…		…
1663	where one character corresponds to one screen cell. See	1738	where one character corresponds to one screen cell. See
1664	C<< $term->ROW_t >> for details.	1739	C<< $term->ROW_t >> for details.
1665		1740
1666	=item $string = $term->special_decode $text	1741	=item $string = $term->special_decode $text
1667		1742
1668	Converts rxvt-unicodes text reprsentation into a perl string. See	1743	Converts rxvt-unicodes text representation into a perl string. See
1669	C<< $term->ROW_t >> for details.	1744	C<< $term->ROW_t >> for details.
1670		1745
1671	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1746	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1672		1747
1673	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1748	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1676	manpage.	1751	manpage.
1677		1752
1678	=item $success = $term->grab ($eventtime[, $sync])	1753	=item $success = $term->grab ($eventtime[, $sync])
1679		1754
1680	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1755	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1681	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1756	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1682		1757
1683	=item $term->allow_events_async	1758	=item $term->allow_events_async
1684		1759
1685	Calls XAllowEvents with AsyncBoth for the most recent grab.	1760	Calls XAllowEvents with AsyncBoth for the most recent grab.
1686		1761
…		…
1693	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1768	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1694	recent grab.	1769	recent grab.
1695		1770
1696	=item $term->ungrab	1771	=item $term->ungrab
1697		1772
1698	Calls XUngrab for the most recent grab. Is called automatically on	1773	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1699	evaluation errors, as it is better to lose the grab in the error case as	1774	evaluation errors, as it is better to lose the grab in the error case as
1700	the session.	1775	the session.
1701		1776
1702	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1777	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1703		1778
…		…
1705		1780
1706	=item @atoms = $term->XListProperties ($window)	1781	=item @atoms = $term->XListProperties ($window)
1707		1782
1708	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1783	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1709		1784
1710	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1785	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1711		1786
1712	=item $term->XDeleteProperty ($window, $property)	1787	=item $term->XDeleteProperty ($window, $property)
1713		1788
1714	=item $window = $term->DefaultRootWindow	1789	=item $window = $term->DefaultRootWindow
1715		1790
…		…
1722	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1797	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1723		1798
1724	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1799	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1725		1800
1726	=item $term->XChangeInput ($window, $add_events[, $del_events])	1801	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1802
		1803	=item $keysym = $term->XStringToKeysym ($string)
		1804
		1805	=item $string = $term->XKeysymToString ($keysym)
1727		1806
1728	Various X or X-related functions. The C<$term> object only serves as	1807	Various X or X-related functions. The C<$term> object only serves as
1729	the source of the display, otherwise those functions map more-or-less	1808	the source of the display, otherwise those functions map more-or-less
1730	directory onto the X functions of the same name.	1809	directly onto the X functions of the same name.
1731		1810
1732	=back	1811	=back
1733		1812
1734	=cut	1813	=cut
1735		1814
…		…
1799	my ($self, $text, $cb) = @_;	1878	my ($self, $text, $cb) = @_;
1800		1879
1801	$self->add_item ({ type => "button", text => $text, activate => $cb});	1880	$self->add_item ({ type => "button", text => $text, activate => $cb});
1802	}	1881	}
1803		1882
1804	=item $popup->add_toggle ($text, $cb, $initial_value)	1883	=item $popup->add_toggle ($text, $initial_value, $cb)
1805		1884
1806	Adds a toggle/checkbox item to the popup. Teh callback gets called	1885	Adds a toggle/checkbox item to the popup. The callback gets called
1807	whenever it gets toggled, with a boolean indicating its value as its first	1886	whenever it gets toggled, with a boolean indicating its new value as its
1808	argument.	1887	first argument.
1809		1888
1810	=cut	1889	=cut
1811		1890
1812	sub add_toggle {	1891	sub add_toggle {
1813	my ($self, $text, $cb, $value) = @_;	1892	my ($self, $text, $value, $cb) = @_;
1814		1893
1815	my $item; $item = {	1894	my $item; $item = {
1816	type => "button",	1895	type => "button",
1817	text => " $text",	1896	text => " $text",
1818	value => $value,	1897	value => $value,
…		…
1837	my $env = $self->{term}->env;	1916	my $env = $self->{term}->env;
1838	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1917	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1839	delete $env->{LC_ALL};	1918	delete $env->{LC_ALL};
1840	$env->{LC_CTYPE} = $self->{term}->locale;	1919	$env->{LC_CTYPE} = $self->{term}->locale;
1841		1920
1842	urxvt::term->new ($env, "popup",	1921	my $term = urxvt::term->new (
		1922	$env, "popup",
1843	"--perl-lib" => "", "--perl-ext-common" => "",	1923	"--perl-lib" => "", "--perl-ext-common" => "",
1844	"-pty-fd" => -1, "-sl" => 0,	1924	"-pty-fd" => -1, "-sl" => 0,
1845	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1925	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1846	"--transient-for" => $self->{term}->parent,	1926	"--transient-for" => $self->{term}->parent,
1847	"-display" => $self->{term}->display_id,	1927	"-display" => $self->{term}->display_id,
1848	"-pe" => "urxvt-popup")	1928	"-pe" => "urxvt-popup",
1849	or die "unable to create popup window\n";	1929	) or die "unable to create popup window\n";
		1930
		1931	unless (delete $term->{urxvt_popup_init_done}) {
		1932	$term->ungrab;
		1933	$term->destroy;
		1934	die "unable to initialise popup window\n";
		1935	}
1850	}	1936	}
1851		1937
1852	sub DESTROY {	1938	sub DESTROY {
1853	my ($self) = @_;	1939	my ($self) = @_;
1854		1940
…		…
1859	=back	1945	=back
1860		1946
1861	=cut	1947	=cut
1862		1948
1863	package urxvt::watcher;	1949	package urxvt::watcher;
1864
1865	@urxvt::timer::ISA = __PACKAGE__;
1866	@urxvt::iow::ISA = __PACKAGE__;
1867	@urxvt::pw::ISA = __PACKAGE__;
1868	@urxvt::iw::ISA = __PACKAGE__;
1869		1950
1870	=head2 The C<urxvt::timer> Class	1951	=head2 The C<urxvt::timer> Class
1871		1952
1872	This class implements timer watchers/events. Time is represented as a	1953	This class implements timer watchers/events. Time is represented as a
1873	fractional number of seconds since the epoch. Example:	1954	fractional number of seconds since the epoch. Example:
…		…
1877	->new	1958	->new
1878	->interval (1)	1959	->interval (1)
1879	->cb (sub {	1960	->cb (sub {
1880	$term->{overlay}->set (0, 0,	1961	$term->{overlay}->set (0, 0,
1881	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1962	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1882	});	1963	});
1883		1964
1884	=over 4	1965	=over 4
1885		1966
1886	=item $timer = new urxvt::timer	1967	=item $timer = new urxvt::timer
1887		1968
…		…
1890		1971
1891	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1972	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1892		1973
1893	Set the callback to be called when the timer triggers.	1974	Set the callback to be called when the timer triggers.
1894		1975
1895	=item $tstamp = $timer->at
1896
1897	Return the time this watcher will fire next.
1898
1899	=item $timer = $timer->set ($tstamp)	1976	=item $timer = $timer->set ($tstamp[, $interval])
1900		1977
1901	Set the time the event is generated to $tstamp.	1978	Set the time the event is generated to $tstamp (and optionally specifies a
		1979	new $interval).
1902		1980
1903	=item $timer = $timer->interval ($interval)	1981	=item $timer = $timer->interval ($interval)
1904		1982
1905	Normally (and when C<$interval> is C<0>), the timer will automatically	1983	By default (and when C<$interval> is C<0>), the timer will automatically
1906	stop after it has fired once. If C<$interval> is non-zero, then the timer	1984	stop after it has fired once. If C<$interval> is non-zero, then the timer
1907	is automatically rescheduled at the given intervals.	1985	is automatically rescheduled at the given intervals.
1908		1986
1909	=item $timer = $timer->start	1987	=item $timer = $timer->start
1910		1988
1911	Start the timer.	1989	Start the timer.
1912		1990
1913	=item $timer = $timer->start ($tstamp)	1991	=item $timer = $timer->start ($tstamp[, $interval])
1914		1992
1915	Set the event trigger time to C<$tstamp> and start the timer.	1993	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		1994	also replaces the interval.
1916		1995
1917	=item $timer = $timer->after ($delay)	1996	=item $timer = $timer->after ($delay[, $interval])
1918		1997
1919	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	1998	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1920		1999
1921	=item $timer = $timer->stop	2000	=item $timer = $timer->stop
1922		2001
…		…
1930		2009
1931	$term->{socket} = ...	2010	$term->{socket} = ...
1932	$term->{iow} = urxvt::iow	2011	$term->{iow} = urxvt::iow
1933	->new	2012	->new
1934	->fd (fileno $term->{socket})	2013	->fd (fileno $term->{socket})
1935	->events (urxvt::EVENT_READ)	2014	->events (urxvt::EV_READ)
1936	->start	2015	->start
1937	->cb (sub {	2016	->cb (sub {
1938	my ($iow, $revents) = @_;	2017	my ($iow, $revents) = @_;
1939	# $revents must be 1 here, no need to check	2018	# $revents must be 1 here, no need to check
1940	sysread $term->{socket}, my $buf, 8192	2019	sysread $term->{socket}, my $buf, 8192
…		…
1953	Set the callback to be called when io events are triggered. C<$reventmask>	2032	Set the callback to be called when io events are triggered. C<$reventmask>
1954	is a bitset as described in the C<events> method.	2033	is a bitset as described in the C<events> method.
1955		2034
1956	=item $iow = $iow->fd ($fd)	2035	=item $iow = $iow->fd ($fd)
1957		2036
1958	Set the filedescriptor (not handle) to watch.	2037	Set the file descriptor (not handle) to watch.
1959		2038
1960	=item $iow = $iow->events ($eventmask)	2039	=item $iow = $iow->events ($eventmask)
1961		2040
1962	Set the event mask to watch. The only allowed values are	2041	Set the event mask to watch. The only allowed values are
1963	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2042	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1964	together, or C<urxvt::EVENT_NONE>.	2043	together, or C<urxvt::EV_NONE>.
1965		2044
1966	=item $iow = $iow->start	2045	=item $iow = $iow->start
1967		2046
1968	Start watching for requested events on the given handle.	2047	Start watching for requested events on the given handle.
1969		2048
1970	=item $iow = $iow->stop	2049	=item $iow = $iow->stop
1971		2050
1972	Stop watching for events on the given filehandle.	2051	Stop watching for events on the given file handle.
1973		2052
1974	=back	2053	=back
1975		2054
1976	=head2 The C<urxvt::iw> Class	2055	=head2 The C<urxvt::iw> Class
1977		2056
…		…
2010	->new	2089	->new
2011	->start ($pid)	2090	->start ($pid)
2012	->cb (sub {	2091	->cb (sub {
2013	my ($pw, $exit_status) = @_;	2092	my ($pw, $exit_status) = @_;
2014	...	2093	...
2015	});	2094	});
2016		2095
2017	=over 4	2096	=over 4
2018		2097
2019	=item $pw = new urxvt::pw	2098	=item $pw = new urxvt::pw
2020		2099
…		…
2024		2103
2025	Set the callback to be called when the timer triggers.	2104	Set the callback to be called when the timer triggers.
2026		2105
2027	=item $pw = $timer->start ($pid)	2106	=item $pw = $timer->start ($pid)
2028		2107
2029	Tells the wqtcher to start watching for process C<$pid>.	2108	Tells the watcher to start watching for process C<$pid>.
2030		2109
2031	=item $pw = $pw->stop	2110	=item $pw = $pw->stop
2032		2111
2033	Stop the watcher.	2112	Stop the watcher.
2034		2113
…		…
2047		2126
2048	=item >= 3 - script loading and management	2127	=item >= 3 - script loading and management
2049		2128
2050	=item >=10 - all called hooks	2129	=item >=10 - all called hooks
2051		2130
2052	=item >=11 - hook reutrn values	2131	=item >=11 - hook return values
2053		2132
2054	=back	2133	=back
2055		2134
2056	=head1 AUTHOR	2135	=head1 AUTHOR
2057		2136
2058	Marc Lehmann <pcg@goof.com>	2137	Marc Lehmann <schmorp@schmorp.de>
2059	http://software.schmorp.de/pkg/rxvt-unicode	2138	http://software.schmorp.de/pkg/rxvt-unicode
2060		2139
2061	=cut	2140	=cut
2062		2141
2063	1	2142	1
		2143
		2144	# vim: sw=3:

Diff Legend

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