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.123 by root, Sat Jan 21 14:49:18 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	You can look at the source of the selection extension to see more
73	interesting uses, such as parsing a line from beginning to end.
74
75	This extension also offers following bindable keyboard commands:
76
77	=over 4
78
79	=item rot13
80
81	Rot-13 the selection when activated. Used via keyboard trigger:
82
83	URxvt.keysym.C-M-r: perl:selection:rot13
84
85	=back
86
87	=item option-popup (enabled by default)
88
89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90	runtime.
91
92	=item selection-popup (enabled by default)
93
94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95	text into various other formats/action (such as uri unescaping, perl
96	evaluation, web-browser starting etc.), depending on content.
97
98	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100	popup is displayed.
101
102	It's sole argument is the popup menu, which can be modified. The selection
103	is in C<$_>, which can be used to decide wether to add something or not.
104	It should either return nothing or a string and a code reference. The
105	string will be used as button text and the code reference will be called
106	when the button gets activated and should transform C<$_>.
107
108	The following will add an entry C<a to b> that transforms all C<a>s in
109	the selection to C<b>s, but only if the selection currently contains any
110	C<a>s:
111
112	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }
114	: ()
115	};
116
117	=item searchable-scrollback<hotkey> (enabled by default)
118
119	Adds regex search functionality to the scrollback buffer, triggered
120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
121	input/output is suspended and a regex is displayed at the bottom of the
122	screen.
123
124	Inputting characters appends them to the regex and continues incremental
125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
127	bottom. C<Escape> leaves search mode and returns to the point where search
128	was started, while C<Enter> or C<Return> stay at the current position and
129	additionally stores the first match in the current line into the primary
130	selection.
131
132	=item readline (enabled by default)
133
134	A support package that tries to make editing with readline easier. At the
135	moment, it reacts to clicking with the left mouse button by trying to
136	move the text cursor to this position. It does so by generating as many
137	cursor-left or cursor-right keypresses as required (the this only works
138	for programs that correctly support wide characters).
139
140	To avoid too many false positives, this is only done when:
141
142	=over 4
143
144	=item - the mouse is on the same (multi-row-) line as the text cursor.
145
146	=item - the primary screen is currently being displayed.
147
148	=item - the text cursor is visible.
149
150	=back
151
152	The normal selection mechanism isn't disabled, so quick successive clicks
153	might interfere with selection creation in harmless ways.
154
155	=item selection-autotransform
156
157	This selection allows you to do automatic transforms on a selection
158	whenever a selection is made.
159
160	It works by specifying perl snippets (most useful is a single C<s///>
161	operator) that modify C<$_> as resources:
162
163	URxvt.selection-autotransform.0: transform
164	URxvt.selection-autotransform.1: transform
165	...
166
167	For example, the following will transform selections of the form
168	C<filename:number>, often seen in compiler messages, into C<vi +$filename
169	$word>:
170
171	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
172
173	And this example matches the same,but replaces it with vi-commands you can
174	paste directly into your (vi :) editor:
175
176	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
177
178	Of course, this can be modified to suit your needs and your editor :)
179
180	To expand the example above to typical perl error messages ("XXX at
181	FILENAME line YYY."), you need a slightly more elaborate solution:
182
183	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
184	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
185
186	The first line tells the selection code to treat the unchanging part of
187	every error message as a selection pattern, and the second line transforms
188	the message into vi commands to load the file.
189
190	=item tabbed
191
192	This transforms the terminal into a tabbar with additional terminals, that
193	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
194	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
195	button per tab.
196
197	Clicking a button will activate that tab. Pressing B<Shift-Left> and
198	B<Shift-Right> will switch to the tab left or right of the current one,
199	while B<Shift-Down> creates a new tab.
200
201	=item mark-urls
202
203	Uses per-line display filtering (C<on_line_update>) to underline urls and
204	make them clickable. When middle-clicked, the program specified in the
205	resource C<urlLauncher> (default C<x-www-browser>) will be started with
206	the URL as first argument.
207
208	=item automove-background
209
210	This is basically a one-line extension that dynamically changes the background pixmap offset
211	to the window position, in effect creating the same effect as pseudo transparency with
212	a custom pixmap. No scaling is supported in this mode. Exmaple:
213
214	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
215
216	=item block-graphics-to-ascii
217
218	A not very useful example of filtering all text output to the terminal,
219	by replacing all line-drawing characters (U+2500 .. U+259F) by a
220	similar-looking ascii character.
221
222	=item digital-clock
223
224	Displays a digital clock using the built-in overlay.
225
226	=item example-refresh-hooks
227
228	Displays a very simple digital clock in the upper right corner of the
229	window. Illustrates overwriting the refresh callbacks to create your own
230	overlays or changes.
231
232	=item selection-pastebin
233
234	This is a little rarely useful extension that Uploads the selection as
235	textfile to a remote site (or does other things). (The implementation is
236	not currently secure for use in a multiuser environment as it writes to
237	F</tmp> directly.).
238
239	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
240	i.e.
241
242	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
243
244	Pressing this combination runs a command with C<%> replaced by the name of
245	the textfile. This command can be set via a resource:
246
247	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
248
249	And the default is likely not useful to anybody but the few people around
250	here :)
251
252	The name of the textfile is the hex encoded md5 sum of the selection, so
253	the same content should lead to the same filename.
254
255	After a successful upload the selection will be replaced by the text given
256	in the C<selection-pastebin-url> resource (again, the % is the placeholder
257	for the filename):
258
259	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
260
261	=back
262		50
263	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
264		52
265	=head2 General API Considerations	53	=head2 General API Considerations
266		54
…		…
280		68
281	=over 4	69	=over 4
282		70
283	=item $text	71	=item $text
284		72
285	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
286	always represents one screen cell. See L<ROW_t> for a discussion of this format.	74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
287		75
288	=item $string	76	=item $string
289		77
290	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
…		…
294	=item $octets	82	=item $octets
295		83
296	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
297	locale-specific way.	85	locale-specific way.
298		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
299	=back	93	=back
300		94
301	=head2 Extension Objects	95	=head2 Extension Objects
302		96
303	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
304	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,
305	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
306	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
307	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
308	use.	103	internal use.
309		104
310	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
311	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
312		107
313	It has the following methods and data members:	108	It has the following methods and data members:
…		…
317	=item $urxvt_term = $self->{term}	112	=item $urxvt_term = $self->{term}
318		113
319	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
320	extension. This member I<must not> be changed in any way.	115	extension. This member I<must not> be changed in any way.
321		116
322	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	117	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
323		118
324	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
325	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
326	to overwrite time-critical hooks only temporarily.	121	to overwrite time-critical hooks only temporarily.
327		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
328	=item $self->disable ($hook_name[, $hook_name..])	126	=item $self->disable ($hook_name[, $hook_name..])
329		127
330	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.
331		137
332	=back	138	=back
333		139
334	=head2 Hooks	140	=head2 Hooks
335		141
336	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
337	called whenever the relevant event happens.	143	called whenever the relevant event happens.
338		144
339	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
340	the in the C<Extension Objects> section.	146	the in the C<Extension Objects> section.
341		147
342	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
343	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
344	relevant action might not be carried out by the C++ code.	150	relevant action might not be carried out by the C++ code.
…		…
357	place.	163	place.
358		164
359	=item on_start $term	165	=item on_start $term
360		166
361	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
362	trying to map (display) the toplevel and returning to the mainloop.	168	trying to map (display) the toplevel and returning to the main loop.
363		169
364	=item on_destroy $term	170	=item on_destroy $term
365		171
366	Called whenever something tries to destroy terminal, before doing anything	172	Called whenever something tries to destroy terminal, when the terminal is
367	yet. If this hook returns true, then destruction is skipped, but this is	173	still fully functional (not for long, though).
368	rarely a good idea.
369		174
370	=item on_reset $term	175	=item on_reset $term
371		176
372	Called after the screen is "reset" for any reason, such as resizing or	177	Called after the screen is "reset" for any reason, such as resizing or
373	control sequences. Here is where you can react on changes to size-related	178	control sequences. Here is where you can react on changes to size-related
…		…
395		200
396	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
397	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
398	by calling C<< $term->selection >>.	203	by calling C<< $term->selection >>.
399		204
400	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.
401		206
402	=item on_sel_extend $term	207	=item on_sel_extend $term
403		208
404	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
405	click) and is either supposed to return false (normal operation), or	210	click) and is either supposed to return false (normal operation), or
406	should extend the selection itelf and return true to suppress the built-in	211	should extend the selection itself and return true to suppress the built-in
407	processing. This can happen multiple times, as long as the callback	212	processing. This can happen multiple times, as long as the callback
408	returns true, it will be called on every further click by the user and is	213	returns true, it will be called on every further click by the user and is
409	supposed to enlarge the selection more and more, if possible.	214	supposed to enlarge the selection more and more, if possible.
410		215
411	See the F<selection> example extension.	216	See the F<selection> example extension.
412		217
413	=item on_view_change $term, $offset	218	=item on_view_change $term, $offset
414		219
415	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
416	scrolls. Offset C<0> means display the normal terminal, positive values	221	scrolls. Offset C<0> means display the normal terminal, positive values
417	show this many lines of scrollback.	222	show this many lines of scrollback.
418		223
419	=item on_scroll_back $term, $lines, $saved	224	=item on_scroll_back $term, $lines, $saved
420		225
…		…
424		229
425	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,
426	$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
427	number of lines that will be in the scrollback buffer.	232	number of lines that will be in the scrollback buffer.
428		233
429	=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
430		245
431	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	246	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
432	operating system command) is processed. Cursor position and other state	247	operating system command) is processed. Cursor position and other state
433	information is up-to-date when this happens. For interoperability, the	248	information is up-to-date when this happens. For interoperability, the
434	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,
435	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
436	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	}
437		262
438	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,
439	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
440	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.
441		269
442	=item on_add_lines $term, $string	270	=item on_add_lines $term, $string
443		271
444	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
445	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
…		…
450	=item on_tt_write $term, $octets	278	=item on_tt_write $term, $octets
451		279
452	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
453	suppress or filter tty input.	281	suppress or filter tty input.
454		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
455	=item on_line_update $term, $row	290	=item on_line_update $term, $row
456		291
457	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
458	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
459	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,
…		…
466	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
467	you cannot just toggle rendition bits, but only set them.	302	you cannot just toggle rendition bits, but only set them.
468		303
469	=item on_refresh_begin $term	304	=item on_refresh_begin $term
470		305
471	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
472	or similar effects by modify terminal contents in refresh_begin, and	307	similar effects by modifying the terminal contents in refresh_begin, and
473	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
474	code is run after this hook, and takes precedence.	309	code is run after this hook, and takes precedence.
475		310
476	=item on_refresh_end $term	311	=item on_refresh_end $term
477		312
478	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>.
479		314
480	=item on_keyboard_command $term, $string	315	=item on_user_command $term, $string
481		316
482	Called whenever the user presses a key combination that has a	317	Called whenever a user-configured event is being activated (e.g. via
483	C<perl:string> action bound to it (see description of the B<keysym>	318	a C<perl:string> action bound to a key, see description of the B<keysym>
484	resource in the @@RXVT_NAME@@(1) manpage).	319	resource in the @@RXVT_NAME@@(1) manpage).
		320
		321	The event is simply the action string. This interface is assumed to change
		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.
485		336
486	=item on_x_event $term, $event	337	=item on_x_event $term, $event
487		338
488	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
489	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
490	members are not passed.	341	members are not passed.
491		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
492	=item on_focus_in $term	347	=item on_focus_in $term
493		348
494	Called whenever the window gets the keyboard focus, before rxvt-unicode	349	Called whenever the window gets the keyboard focus, before rxvt-unicode
495	does focus in processing.	350	does focus in processing.
496		351
497	=item on_focus_out $term	352	=item on_focus_out $term
498		353
499	Called wheneever the window loses keyboard focus, before rxvt-unicode does	354	Called whenever the window loses keyboard focus, before rxvt-unicode does
500	focus out processing.	355	focus out processing.
501		356
502	=item on_configure_notify $term, $event	357	=item on_configure_notify $term, $event
503		358
504	=item on_property_notify $term, $event	359	=item on_property_notify $term, $event
…		…
515		370
516	=item on_map_notify $term, $event	371	=item on_map_notify $term, $event
517		372
518	=item on_unmap_notify $term, $event	373	=item on_unmap_notify $term, $event
519		374
520	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
521	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.
522		377
523	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
524	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
525	(real, not screen-based) row and column under the mouse cursor.	380	(real, not screen-based) row and column under the mouse cursor.
526		381
…		…
536	=item on_wm_delete_window $term, $event	391	=item on_wm_delete_window $term, $event
537		392
538	Called when various types of ClientMessage events are received (all with	393	Called when various types of ClientMessage events are received (all with
539	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	394	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
540		395
		396	=item on_bell $term
		397
		398	Called on receipt of a bell character.
		399
541	=back	400	=back
542		401
543	=cut	402	=cut
544		403
545	package urxvt;	404	package urxvt;
546		405
547	use utf8;	406	use utf8;
548	use strict;	407	use strict 'vars';
549	use Carp ();	408	use Carp ();
550	use Scalar::Util ();	409	use Scalar::Util ();
551	use List::Util ();	410	use List::Util ();
552		411
553	our $VERSION = 1;	412	our $VERSION = 1;
554	our $TERM;	413	our $TERM;
555	our @TERM_INIT;	414	our @TERM_INIT; # should go, prevents async I/O etc.
556	our @TERM_EXT;	415	our @TERM_EXT; # should go, prevents async I/O etc.
557	our @HOOKNAME;	416	our @HOOKNAME;
558	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
559	our %OPTION;	418	our %OPTION;
560		419
561	our $LIBDIR;	420	our $LIBDIR;
562	our $RESNAME;	421	our $RESNAME;
563	our $RESCLASS;	422	our $RESCLASS;
564	our $RXVTNAME;	423	our $RXVTNAME;
565		424
566	our $NOCHAR = chr 0xfffe;	425	our $NOCHAR = chr 0xffff;
567		426
568	=head2 Variables in the C<urxvt> Package	427	=head2 Variables in the C<urxvt> Package
569		428
570	=over 4	429	=over 4
571		430
…		…
587	The current terminal. This variable stores the current C<urxvt::term>	446	The current terminal. This variable stores the current C<urxvt::term>
588	object, whenever a callback/hook is executing.	447	object, whenever a callback/hook is executing.
589		448
590	=item @urxvt::TERM_INIT	449	=item @urxvt::TERM_INIT
591		450
592	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
593	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
594	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,
595	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.
596		455
597	This complements to the perl-eval commandline option, but gets executed	456	This complements to the perl-eval command line option, but gets executed
598	first.	457	first.
599		458
600	=item @urxvt::TERM_EXT	459	=item @urxvt::TERM_EXT
601		460
602	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
…		…
609		468
610	=over 4	469	=over 4
611		470
612	=item urxvt::fatal $errormessage	471	=item urxvt::fatal $errormessage
613		472
614	Fatally aborts execution with the given error message. Avoid at all	473	Fatally aborts execution with the given error message (which should
615	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
616	starts up.	475	is acceptable (and useful) is in the init hook, where it prevents the
		476	terminal from starting up.
617		477
618	=item urxvt::warn $string	478	=item urxvt::warn $string
619		479
620	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
621	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
622	that calls this function.	482	that calls this function.
623		483
624	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
625	correct place, e.g. on stderr of the connecting urxvtc client.	485	correct place, e.g. on stderr of the connecting urxvtc client.
626		486
627	Messages have a size limit of 1023 bytes currently.	487	Messages have a size limit of 1023 bytes currently.
		488
		489	=item @terms = urxvt::termlist
		490
		491	Returns all urxvt::term objects that exist in this process, regardless of
		492	whether they are started, being destroyed etc., so be careful. Only term
		493	objects that have perl extensions attached will be returned (because there
		494	is no urxvt::term object associated with others).
628		495
629	=item $time = urxvt::NOW	496	=item $time = urxvt::NOW
630		497
631	Returns the "current time" (as per the event loop).	498	Returns the "current time" (as per the event loop).
632		499
…		…
675		542
676	=item $rend = urxvt::OVERLAY_RSTYLE	543	=item $rend = urxvt::OVERLAY_RSTYLE
677		544
678	Return the rendition mask used for overlays by default.	545	Return the rendition mask used for overlays by default.
679		546
680	=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
681		549
682	Return the bit that enabled bold, italic, blink, reverse-video and	550	Return the bit that enabled bold, italic, blink, reverse-video and
683	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
684	the bitset.	552	the bitset.
685		553
…		…
690	Return the foreground/background colour index, respectively.	558	Return the foreground/background colour index, respectively.
691		559
692	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	560	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
693		561
694	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	562	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		563
		564	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
695		565
696	Replace the foreground/background colour in the rendition mask with the	566	Replace the foreground/background colour in the rendition mask with the
697	specified one.	567	specified one.
698		568
699	=item $value = urxvt::GET_CUSTOM $rend	569	=item $value = urxvt::GET_CUSTOM $rend
…		…
718	unless $msg =~ /\n$/;	588	unless $msg =~ /\n$/;
719	urxvt::warn ($msg);	589	urxvt::warn ($msg);
720	};	590	};
721	}	591	}
722		592
		593	no warnings 'utf8';
		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
723	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	655	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
724		656
725	sub verbose {	657	sub verbose {
726	my ($level, $msg) = @_;	658	my ($level, $msg) = @_;
727	warn "$msg\n" if $level <= $verbosity;	659	warn "$msg\n" if $level <= $verbosity;
…		…
739	$pkg =~ s/[^[:word:]]/_/g;	671	$pkg =~ s/[^[:word:]]/_/g;
740	$pkg = "urxvt::ext::$pkg";	672	$pkg = "urxvt::ext::$pkg";
741		673
742	verbose 3, "loading extension '$path' into package '$pkg'";	674	verbose 3, "loading extension '$path' into package '$pkg'";
743		675
		676	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		677
744	open my $fh, "<:raw", $path	678	open my $fh, "<:raw", $path
745	or die "$path: $!";	679	or die "$path: $!";
746		680
747	my $source =	681	my $source =
748	"package $pkg; use strict; use utf8;\n"	682	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
749	. "#line 1 \"$path\"\n{\n"	683	. "#line 1 \"$path\"\n{\n"
750	. (do { local $/; <$fh> })	684	. (do { local $/; <$fh> })
751	. "\n};\n1";	685	. "\n};\n1";
752		686
753	eval $source	687	eval $source
…		…
763	sub invoke {	697	sub invoke {
764	local $TERM = shift;	698	local $TERM = shift;
765	my $htype = shift;	699	my $htype = shift;
766		700
767	if ($htype == 0) { # INIT	701	if ($htype == 0) { # INIT
768	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	702	my @dirs = $TERM->perl_libdirs;
769		703
770	my %ext_arg;	704	my %ext_arg;
771		705
772	{	706	{
773	my @init = @TERM_INIT;	707	my @init = @TERM_INIT;
774	@TERM_INIT = ();	708	@TERM_INIT = ();
…		…
776	my @pkg = @TERM_EXT;	710	my @pkg = @TERM_EXT;
777	@TERM_EXT = ();	711	@TERM_EXT = ();
778	$TERM->register_package ($_) for @pkg;	712	$TERM->register_package ($_) for @pkg;
779	}	713	}
780		714
		715	for (
		716	@{ delete $TERM->{perl_ext_3} },
781	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	717	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		718	) {
782	if ($_ eq "default") {	719	if ($_ eq "default") {
783	$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);
784	} elsif (/^-(.*)$/) {	721	} elsif (/^-(.*)$/) {
785	delete $ext_arg{$1};	722	delete $ext_arg{$1};
786	} elsif (/^([^<]+)<(.*)>$/) {	723	} elsif (/^([^<]+)<(.*)>$/) {
…		…
788	} else {	725	} else {
789	$ext_arg{$_} ||= [];	726	$ext_arg{$_} ||= [];
790	}	727	}
791	}	728	}
792		729
793	while (my ($ext, $argv) = each %ext_arg) {	730	for my $ext (sort keys %ext_arg) {
794	my @files = grep -f $_, map "$_/$ext", @dirs;	731	my @files = grep -f $_, map "$_/$ext", @dirs;
795		732
796	if (@files) {	733	if (@files) {
797	$TERM->register_package (extension_package $files[0], $argv);	734	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
798	} else {	735	} else {
799	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";
800	}	737	}
801	}	738	}
802		739
…		…
808		745
809	if (my $cb = $TERM->{_hook}[$htype]) {	746	if (my $cb = $TERM->{_hook}[$htype]) {
810	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
811	if $verbosity >= 10;	748	if $verbosity >= 10;
812		749
813	keys %$cb;	750	for my $pkg (keys %$cb) {
814
815	while (my ($pkg, $cb) = each %$cb) {
816	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	751	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
817	$retval ||= $retval_;	752	$retval ||= $retval_;
818		753
819	if ($@) {	754	if ($@) {
820	$TERM->ungrab; # better to lose the grab than the session	755	$TERM->ungrab; # better to lose the grab than the session
821	warn $@;	756	warn $@;
…		…
835	}	770	}
836		771
837	$retval	772	$retval
838	}	773	}
839		774
840	# urxvt::term::extension	775	sub SET_COLOR($$$) {
		776	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		777	}
		778
		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	}
841		803
842	package urxvt::term::extension;	804	package urxvt::term::extension;
843		805
844	sub enable {	806	sub enable {
845	my ($self, %hook) = @_;	807	my ($self, %hook) = @_;
…		…
900		862
901	sub urxvt::destroy_hook(&) {	863	sub urxvt::destroy_hook(&) {
902	bless \shift, urxvt::destroy_hook::	864	bless \shift, urxvt::destroy_hook::
903	}	865	}
904		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
905	package urxvt::anyevent;	879	package urxvt::anyevent;
906		880
907	=head2 The C<urxvt::anyevent> Class	881	=head2 The C<urxvt::anyevent> Class
908		882
909	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
910	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
911	further programming. The only exception is that you cannot wait on	885	further programming. The only exception is that you cannot wait on
912	condition variables, but non-blocking condvar use is ok. What this means	886	condition variables, but non-blocking condvar use is ok.
913	is that you cannot use blocking APIs, but the non-blocking variant should	887
914	work.	888	In practical terms this means is that you cannot use blocking APIs, but
		889	the non-blocking variant should work.
915		890
916	=cut	891	=cut
917		892
918	our $VERSION = 1;	893	our $VERSION = '5.23';
919		894
920	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	895	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
921	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	896	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
922		897
923	sub timer {	898	sub timer {
…		…
925		900
926	my $cb = $arg{cb};	901	my $cb = $arg{cb};
927		902
928	urxvt::timer	903	urxvt::timer
929	->new	904	->new
930	->start (urxvt::NOW + $arg{after})	905	->after ($arg{after}, $arg{interval})
931	->cb (sub {	906	->cb ($arg{interval} ? $cb : sub {
932	$_[0]->stop; # need to cancel manually	907	$_[0]->stop; # need to cancel manually
933	$cb->();	908	$cb->();
934	})	909	})
935	}	910	}
936		911
937	sub io {	912	sub io {
938	my ($class, %arg) = @_;	913	my ($class, %arg) = @_;
939		914
940	my $cb = $arg{cb};	915	my $cb = $arg{cb};
		916	my $fd = fileno $arg{fh};
		917	defined $fd or $fd = $arg{fh};
941		918
942	bless [$arg{fh}, urxvt::iow	919	bless [$arg{fh}, urxvt::iow
943	->new	920	->new
944	->fd (fileno $arg{fh})	921	->fd ($fd)
945	->events (($arg{poll} =~ /r/ ? 1 : 0)	922	->events (($arg{poll} =~ /r/ ? 1 : 0)
946	| ($arg{poll} =~ /w/ ? 2 : 0))	923	| ($arg{poll} =~ /w/ ? 2 : 0))
947	->start	924	->start
948	->cb (sub {	925	->cb ($cb)
949	$cb->(($_[1] & 1 ? 'r' : '')
950	. ($_[1] & 2 ? 'w' : ''));
951	})],
952	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	})
953	}	952	}
954		953
955	sub DESTROY {	954	sub DESTROY {
956	$_[0][1]->stop;	955	$_[0][1]->stop;
957	}	956	}
958		957
959	sub condvar {	958	# only needed for AnyEvent < 6 compatibility
960	bless \my $flag, urxvt::anyevent::condvar::	959	sub one_event {
961	}
962
963	sub urxvt::anyevent::condvar::broadcast {
964	${$_[0]}++;
965	}
966
967	sub urxvt::anyevent::condvar::wait {
968	unless (${$_[0]}) {
969	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	960	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
970	}
971	}	961	}
972		962
973	package urxvt::term;	963	package urxvt::term;
974		964
975	=head2 The C<urxvt::term> Class	965	=head2 The C<urxvt::term> Class
…		…
988	urxvt::verbose 6, "register package $pkg to $self";	978	urxvt::verbose 6, "register package $pkg to $self";
989		979
990	@{"$pkg\::ISA"} = urxvt::term::extension::;	980	@{"$pkg\::ISA"} = urxvt::term::extension::;
991		981
992	my $proxy = bless {	982	my $proxy = bless {
993	_pkg => $pkg,	983	_pkg => $pkg,
		984	_name => ${"$pkg\::_NAME"}, # hackish
994	argv => $argv,	985	argv => $argv,
995	}, $pkg;	986	}, $pkg;
996	Scalar::Util::weaken ($proxy->{term} = $self);	987	Scalar::Util::weaken ($proxy->{term} = $self);
997		988
998	$self->{_pkg}{$pkg} = $proxy;	989	$self->{_pkg}{$pkg} = $proxy;
999		990
…		…
1002	$proxy->enable ($name => $ref);	993	$proxy->enable ($name => $ref);
1003	}	994	}
1004	}	995	}
1005	}	996	}
1006		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
1007	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1045	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1008		1046
1009	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
1010	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
1011	hash which defines the environment of the new terminal.	1049	hash which defines the environment of the new terminal.
1012		1050
1013	Croaks (and probably outputs an error message) if the new instance	1051	Croaks (and probably outputs an error message) if the new instance
1014	couldn't be created. Returns C<undef> if the new instance didn't	1052	couldn't be created. Returns C<undef> if the new instance didn't
1015	initialise perl, and the terminal object otherwise. The C<init> and	1053	initialise perl, and the terminal object otherwise. The C<init> and
1016	C<start> hooks will be called during this call.	1054	C<start> hooks will be called before this call returns, and are free to
		1055	refer to global data (which is race free).
1017		1056
1018	=cut	1057	=cut
1019		1058
1020	sub new {	1059	sub new {
1021	my ($class, $env, @args) = @_;	1060	my ($class, $env, @args) = @_;
1022		1061
		1062	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1063	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1064
1023	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1065	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1024	}	1066	}
1025		1067
1026	=item $term->destroy	1068	=item $term->destroy
1027		1069
1028	Destroy the terminal object (close the window, free resources	1070	Destroy the terminal object (close the window, free resources
1029	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
1030	watchers (timers, io watchers) are still active.	1072	watchers (timers, io watchers) are still active.
		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	}
1031		1116
1032	=item $term->exec_async ($cmd[, @args])	1117	=item $term->exec_async ($cmd[, @args])
1033		1118
1034	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
1035	("starts") programs in the background. This function takes care of setting	1120	("starts") programs in the background. This function takes care of setting
…		…
1058		1143
1059	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
1060	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
1061	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.
1062		1147
1063	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
1064	source file F</src/optinc.h> to see the actual list:	1149	source file F</src/optinc.h> to see the actual list:
1065		1150
1066	borderLess console cursorBlink cursorUnderline hold iconic insecure	1151	borderLess buffered console cursorBlink cursorUnderline hold iconic
1067	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1152	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1068	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1153	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1069	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1154	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1070	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1155	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1071	transparent tripleclickwords utmpInhibit visualBell	1156	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1157	urgentOnBell utmpInhibit visualBell
1072		1158
1073	=item $value = $term->resource ($name[, $newval])	1159	=item $value = $term->resource ($name[, $newval])
1074		1160
1075	Returns the current resource value associated with a given name and	1161	Returns the current resource value associated with a given name and
1076	optionally sets a new value. Setting values is most useful in the C<init>	1162	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1085	likely change).	1171	likely change).
1086		1172
1087	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
1088	terminal is destroyed, so changing options frequently will eat memory.	1174	terminal is destroyed, so changing options frequently will eat memory.
1089		1175
1090	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
1091	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>
1092	to see the actual list:	1178	to see the actual list:
1093		1179
1094	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1180	answerbackstring backgroundPixmap backspace_key blurradius
1095	borderLess color cursorBlink cursorUnderline cutchars delete_key	1181	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1096	display_name embed ext_bwidth fade font geometry hold iconName	1182	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1097	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
1098	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1185	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1099	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1186	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1100	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1187	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1101	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1188	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1102	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1189	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1103	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1190	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1104	secondaryScreen secondaryScroll selectstyle shade term_name title	1191	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1105	transient_for transparent transparent_all tripleclickwords utmpInhibit	1192	term_name title transient_for transparent tripleclickwords urgentOnBell
1106	visualBell	1193	utmpInhibit visualBell
1107		1194
1108	=cut	1195	=cut
1109		1196
1110	sub resource($$;$) {	1197	sub resource($$;$) {
1111	my ($self, $name) = (shift, shift);	1198	my ($self, $name) = (shift, shift);
1112	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1199	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1113	&urxvt::term::_resource	1200	goto &urxvt::term::_resource
1114	}	1201	}
1115		1202
1116	=item $value = $term->x_resource ($pattern)	1203	=item $value = $term->x_resource ($pattern)
1117		1204
1118	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
1119	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
1120	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
1121	resource with that pattern exists.	1208	resource with that pattern exists.
1122		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
1123	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
1124	only one resource database per display, and later invocations might return	1221	only one resource database per display, and later invocations might return
1125	the wrong resources.	1222	the wrong resources.
1126		1223
1127	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1224	=item $value = $term->x_resource_boolean ($pattern)
1128		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
1129	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
1130	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.
1131		1251
1132	=item $rend = $term->rstyle ([$new_rstyle])	1252	=item $rend = $term->rstyle ([$new_rstyle])
1133		1253
1134	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
1135	the terminal application will use this style.	1255	the terminal application will use this style.
…		…
1143		1263
1144	=item ($row, $col) = $term->selection_beg ([$row, $col])	1264	=item ($row, $col) = $term->selection_beg ([$row, $col])
1145		1265
1146	=item ($row, $col) = $term->selection_end ([$row, $col])	1266	=item ($row, $col) = $term->selection_end ([$row, $col])
1147		1267
1148	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.
1149	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.
1150		1277
1151	=item $term->selection_make ($eventtime[, $rectangular])	1278	=item $term->selection_make ($eventtime[, $rectangular])
1152		1279
1153	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
1154	C<selection_end>. If C<$rectangular> is true (default: false), a	1281	C<selection_end>. If C<$rectangular> is true (default: false), a
1155	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
1156	a selection.	1283	a selection.
1157		1284
1158	=item $success = $term->selection_grab ($eventtime)	1285	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1159		1286
1160	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
1161	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
1162	is mostly useful from within C<on_sel_grab> hooks.	1290	is mostly useful from within C<on_sel_grab> hooks.
1163		1291
1164	=item $oldtext = $term->selection ([$newtext])	1292	=item $oldtext = $term->selection ([$newtext, $clipboard])
1165		1293
1166	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.
1167		1300
1168	=item $term->overlay_simple ($x, $y, $text)	1301	=item $term->overlay_simple ($x, $y, $text)
1169		1302
1170	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.
1171		1304
…		…
1201		1334
1202	The methods currently supported on C<urxvt::overlay> objects are:	1335	The methods currently supported on C<urxvt::overlay> objects are:
1203		1336
1204	=over 4	1337	=over 4
1205		1338
1206	=item $overlay->set ($x, $y, $text, $rend)	1339	=item $overlay->set ($x, $y, $text[, $rend])
1207		1340
1208	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
1209	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
1210	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.
1211		1346
1212	=item $overlay->hide	1347	=item $overlay->hide
1213		1348
1214	If visible, hide the overlay, but do not destroy it.	1349	If visible, hide the overlay, but do not destroy it.
1215		1350
…		…
1297	locale-specific encoding of the terminal and can contain command sequences	1432	locale-specific encoding of the terminal and can contain command sequences
1298	(escape codes) that will be interpreted.	1433	(escape codes) that will be interpreted.
1299		1434
1300	=item $term->tt_write ($octets)	1435	=item $term->tt_write ($octets)
1301		1436
1302	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
1303	pass characters instead of octets, you should convert your strings first	1438	pass characters instead of octets, you should convert your strings first
1304	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.
1305		1446
1306	=item $old_events = $term->pty_ev_events ([$new_events])	1447	=item $old_events = $term->pty_ev_events ([$new_events])
1307		1448
1308	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
1309	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
1310	description of C<< urxvt::timer->events >>. Make sure to always restore	1451	description of C<< urxvt::timer->events >>. Make sure to always restore
1311	the previous value.	1452	the previous value.
1312		1453
		1454	=item $fd = $term->pty_fd
		1455
		1456	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1457	is used.
		1458
1313	=item $windowid = $term->parent	1459	=item $windowid = $term->parent
1314		1460
1315	Return the window id of the toplevel window.	1461	Return the window id of the toplevel window.
1316		1462
1317	=item $windowid = $term->vt	1463	=item $windowid = $term->vt
…		…
1323	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
1324	to receive pointer events all the times:	1470	to receive pointer events all the times:
1325		1471
1326	$term->vt_emask_add (urxvt::PointerMotionMask);	1472	$term->vt_emask_add (urxvt::PointerMotionMask);
1327		1473
		1474	=item $term->set_urgency ($set)
		1475
		1476	Enable/disable the urgency hint on the toplevel window.
		1477
		1478	=item $term->focus_in
		1479
		1480	=item $term->focus_out
		1481
		1482	=item $term->key_press ($state, $keycode[, $time])
		1483
		1484	=item $term->key_release ($state, $keycode[, $time])
		1485
		1486	Deliver various fake events to to terminal.
		1487
1328	=item $window_width = $term->width	1488	=item $window_width = $term->width
1329		1489
1330	=item $window_height = $term->height	1490	=item $window_height = $term->height
1331		1491
1332	=item $font_width = $term->fwidth	1492	=item $font_width = $term->fwidth
…		…
1362	=item $env = $term->env	1522	=item $env = $term->env
1363		1523
1364	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
1365	similar to C<\%ENV>.	1525	similar to C<\%ENV>.
1366		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
1367	=cut	1536	=cut
1368		1537
1369	sub env {	1538	sub env {
1370	if (my $env = $_[0]->_env) {
1371	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1539	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1372	} else {
1373	+{ %ENV }
1374	}
1375	}	1540	}
1376		1541
1377	=item $modifiermask = $term->ModLevel3Mask	1542	=item $modifiermask = $term->ModLevel3Mask
1378		1543
1379	=item $modifiermask = $term->ModMetaMask	1544	=item $modifiermask = $term->ModMetaMask
…		…
1387		1552
1388	Returns the currently displayed screen (0 primary, 1 secondary).	1553	Returns the currently displayed screen (0 primary, 1 secondary).
1389		1554
1390	=item $cursor_is_hidden = $term->hidden_cursor	1555	=item $cursor_is_hidden = $term->hidden_cursor
1391		1556
1392	Returns wether the cursor is currently hidden or not.	1557	Returns whether the cursor is currently hidden or not.
1393		1558
1394	=item $view_start = $term->view_start ([$newvalue])	1559	=item $view_start = $term->view_start ([$newvalue])
1395		1560
1396	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
1397	C<0>, which displays the normal terminal contents. Lower values scroll	1562	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1405		1570
1406	Used after changing terminal contents to display them.	1571	Used after changing terminal contents to display them.
1407		1572
1408	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1573	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1409		1574
1410	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 >>
1411	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
1412	terminal line. The scrollback buffer starts at line C<-1> and extends to
1413	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1577	terminal line. Nothing will be returned if a nonexistent line
1414	is requested.	1578	is requested.
1415		1579
1416	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
1417	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
1418	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
1419	automatically be updated.	1583	automatically be updated.
1420		1584
1421	C<$text> is in a special encoding: tabs and wide characters that use	1585	C<$text> is in a special encoding: tabs and wide characters that use more
1422	more than one cell when displayed are padded with C<$urxvt::NOCHAR>	1586	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1423	characters. Characters with combining characters and other characters that	1587	characters. Characters with combining characters and other characters that
1424	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
1425	in the private use area.	1589	in the private use area.
1426		1590
1427	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
1428	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
1429	characters.	1593	characters.
…		…
1574	where one character corresponds to one screen cell. See	1738	where one character corresponds to one screen cell. See
1575	C<< $term->ROW_t >> for details.	1739	C<< $term->ROW_t >> for details.
1576		1740
1577	=item $string = $term->special_decode $text	1741	=item $string = $term->special_decode $text
1578		1742
1579	Converts rxvt-unicodes text reprsentation into a perl string. See	1743	Converts rxvt-unicodes text representation into a perl string. See
1580	C<< $term->ROW_t >> for details.	1744	C<< $term->ROW_t >> for details.
1581		1745
1582	=item $success = $term->grab_button ($button, $modifiermask)	1746	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1583		1747
		1748	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1749
1584	Registers a synchronous button grab. See the XGrabButton manpage.	1750	Register/unregister a synchronous button grab. See the XGrabButton
		1751	manpage.
1585		1752
1586	=item $success = $term->grab ($eventtime[, $sync])	1753	=item $success = $term->grab ($eventtime[, $sync])
1587		1754
1588	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1755	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1589	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1756	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1590		1757
1591	=item $term->allow_events_async	1758	=item $term->allow_events_async
1592		1759
1593	Calls XAllowEvents with AsyncBoth for the most recent grab.	1760	Calls XAllowEvents with AsyncBoth for the most recent grab.
1594		1761
…		…
1601	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1768	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1602	recent grab.	1769	recent grab.
1603		1770
1604	=item $term->ungrab	1771	=item $term->ungrab
1605		1772
1606	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
1607	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
1608	the session.	1775	the session.
1609		1776
1610	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1777	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1611		1778
…		…
1613		1780
1614	=item @atoms = $term->XListProperties ($window)	1781	=item @atoms = $term->XListProperties ($window)
1615		1782
1616	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1783	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1617		1784
1618	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1785	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1619		1786
1620	=item $term->XDeleteProperty ($window, $property)	1787	=item $term->XDeleteProperty ($window, $property)
1621		1788
1622	=item $window = $term->DefaultRootWindow	1789	=item $window = $term->DefaultRootWindow
1623		1790
…		…
1630	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1797	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1631		1798
1632	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1799	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1633		1800
1634	=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)
1635		1806
1636	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
1637	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
1638	directory onto the X functions of the same name.	1809	directly onto the X functions of the same name.
1639		1810
1640	=back	1811	=back
1641		1812
1642	=cut	1813	=cut
1643		1814
…		…
1707	my ($self, $text, $cb) = @_;	1878	my ($self, $text, $cb) = @_;
1708		1879
1709	$self->add_item ({ type => "button", text => $text, activate => $cb});	1880	$self->add_item ({ type => "button", text => $text, activate => $cb});
1710	}	1881	}
1711		1882
1712	=item $popup->add_toggle ($text, $cb, $initial_value)	1883	=item $popup->add_toggle ($text, $initial_value, $cb)
1713		1884
1714	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
1715	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
1716	argument.	1887	first argument.
1717		1888
1718	=cut	1889	=cut
1719		1890
1720	sub add_toggle {	1891	sub add_toggle {
1721	my ($self, $text, $cb, $value) = @_;	1892	my ($self, $text, $value, $cb) = @_;
1722		1893
1723	my $item; $item = {	1894	my $item; $item = {
1724	type => "button",	1895	type => "button",
1725	text => " $text",	1896	text => " $text",
1726	value => $value,	1897	value => $value,
…		…
1745	my $env = $self->{term}->env;	1916	my $env = $self->{term}->env;
1746	# 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.
1747	delete $env->{LC_ALL};	1918	delete $env->{LC_ALL};
1748	$env->{LC_CTYPE} = $self->{term}->locale;	1919	$env->{LC_CTYPE} = $self->{term}->locale;
1749		1920
1750	urxvt::term->new ($env, "popup",	1921	my $term = urxvt::term->new (
		1922	$env, "popup",
1751	"--perl-lib" => "", "--perl-ext-common" => "",	1923	"--perl-lib" => "", "--perl-ext-common" => "",
1752	"-pty-fd" => -1, "-sl" => 0,	1924	"-pty-fd" => -1, "-sl" => 0,
1753	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1925	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1754	"--transient-for" => $self->{term}->parent,	1926	"--transient-for" => $self->{term}->parent,
1755	"-display" => $self->{term}->display_id,	1927	"-display" => $self->{term}->display_id,
1756	"-pe" => "urxvt-popup")	1928	"-pe" => "urxvt-popup",
1757	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	}
1758	}	1936	}
1759		1937
1760	sub DESTROY {	1938	sub DESTROY {
1761	my ($self) = @_;	1939	my ($self) = @_;
1762		1940
…		…
1767	=back	1945	=back
1768		1946
1769	=cut	1947	=cut
1770		1948
1771	package urxvt::watcher;	1949	package urxvt::watcher;
1772
1773	@urxvt::timer::ISA = __PACKAGE__;
1774	@urxvt::iow::ISA = __PACKAGE__;
1775	@urxvt::pw::ISA = __PACKAGE__;
1776	@urxvt::iw::ISA = __PACKAGE__;
1777		1950
1778	=head2 The C<urxvt::timer> Class	1951	=head2 The C<urxvt::timer> Class
1779		1952
1780	This class implements timer watchers/events. Time is represented as a	1953	This class implements timer watchers/events. Time is represented as a
1781	fractional number of seconds since the epoch. Example:	1954	fractional number of seconds since the epoch. Example:
…		…
1785	->new	1958	->new
1786	->interval (1)	1959	->interval (1)
1787	->cb (sub {	1960	->cb (sub {
1788	$term->{overlay}->set (0, 0,	1961	$term->{overlay}->set (0, 0,
1789	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1962	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1790	});	1963	});
1791		1964
1792	=over 4	1965	=over 4
1793		1966
1794	=item $timer = new urxvt::timer	1967	=item $timer = new urxvt::timer
1795		1968
…		…
1798		1971
1799	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1972	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1800		1973
1801	Set the callback to be called when the timer triggers.	1974	Set the callback to be called when the timer triggers.
1802		1975
1803	=item $tstamp = $timer->at
1804
1805	Return the time this watcher will fire next.
1806
1807	=item $timer = $timer->set ($tstamp)	1976	=item $timer = $timer->set ($tstamp[, $interval])
1808		1977
1809	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).
1810		1980
1811	=item $timer = $timer->interval ($interval)	1981	=item $timer = $timer->interval ($interval)
1812		1982
1813	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
1814	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
1815	is automatically rescheduled at the given intervals.	1985	is automatically rescheduled at the given intervals.
1816		1986
1817	=item $timer = $timer->start	1987	=item $timer = $timer->start
1818		1988
1819	Start the timer.	1989	Start the timer.
1820		1990
1821	=item $timer = $timer->start ($tstamp)	1991	=item $timer = $timer->start ($tstamp[, $interval])
1822		1992
1823	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.
1824		1995
1825	=item $timer = $timer->after ($delay)	1996	=item $timer = $timer->after ($delay[, $interval])
1826		1997
1827	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>.
1828		1999
1829	=item $timer = $timer->stop	2000	=item $timer = $timer->stop
1830		2001
…		…
1838		2009
1839	$term->{socket} = ...	2010	$term->{socket} = ...
1840	$term->{iow} = urxvt::iow	2011	$term->{iow} = urxvt::iow
1841	->new	2012	->new
1842	->fd (fileno $term->{socket})	2013	->fd (fileno $term->{socket})
1843	->events (urxvt::EVENT_READ)	2014	->events (urxvt::EV_READ)
1844	->start	2015	->start
1845	->cb (sub {	2016	->cb (sub {
1846	my ($iow, $revents) = @_;	2017	my ($iow, $revents) = @_;
1847	# $revents must be 1 here, no need to check	2018	# $revents must be 1 here, no need to check
1848	sysread $term->{socket}, my $buf, 8192	2019	sysread $term->{socket}, my $buf, 8192
…		…
1861	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>
1862	is a bitset as described in the C<events> method.	2033	is a bitset as described in the C<events> method.
1863		2034
1864	=item $iow = $iow->fd ($fd)	2035	=item $iow = $iow->fd ($fd)
1865		2036
1866	Set the filedescriptor (not handle) to watch.	2037	Set the file descriptor (not handle) to watch.
1867		2038
1868	=item $iow = $iow->events ($eventmask)	2039	=item $iow = $iow->events ($eventmask)
1869		2040
1870	Set the event mask to watch. The only allowed values are	2041	Set the event mask to watch. The only allowed values are
1871	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2042	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1872	together, or C<urxvt::EVENT_NONE>.	2043	together, or C<urxvt::EV_NONE>.
1873		2044
1874	=item $iow = $iow->start	2045	=item $iow = $iow->start
1875		2046
1876	Start watching for requested events on the given handle.	2047	Start watching for requested events on the given handle.
1877		2048
1878	=item $iow = $iow->stop	2049	=item $iow = $iow->stop
1879		2050
1880	Stop watching for events on the given filehandle.	2051	Stop watching for events on the given file handle.
1881		2052
1882	=back	2053	=back
1883		2054
1884	=head2 The C<urxvt::iw> Class	2055	=head2 The C<urxvt::iw> Class
1885		2056
…		…
1918	->new	2089	->new
1919	->start ($pid)	2090	->start ($pid)
1920	->cb (sub {	2091	->cb (sub {
1921	my ($pw, $exit_status) = @_;	2092	my ($pw, $exit_status) = @_;
1922	...	2093	...
1923	});	2094	});
1924		2095
1925	=over 4	2096	=over 4
1926		2097
1927	=item $pw = new urxvt::pw	2098	=item $pw = new urxvt::pw
1928		2099
…		…
1932		2103
1933	Set the callback to be called when the timer triggers.	2104	Set the callback to be called when the timer triggers.
1934		2105
1935	=item $pw = $timer->start ($pid)	2106	=item $pw = $timer->start ($pid)
1936		2107
1937	Tells the wqtcher to start watching for process C<$pid>.	2108	Tells the watcher to start watching for process C<$pid>.
1938		2109
1939	=item $pw = $pw->stop	2110	=item $pw = $pw->stop
1940		2111
1941	Stop the watcher.	2112	Stop the watcher.
1942		2113
…		…
1955		2126
1956	=item >= 3 - script loading and management	2127	=item >= 3 - script loading and management
1957		2128
1958	=item >=10 - all called hooks	2129	=item >=10 - all called hooks
1959		2130
1960	=item >=11 - hook reutrn values	2131	=item >=11 - hook return values
1961		2132
1962	=back	2133	=back
1963		2134
1964	=head1 AUTHOR	2135	=head1 AUTHOR
1965		2136
1966	Marc Lehmann <pcg@goof.com>	2137	Marc Lehmann <schmorp@schmorp.de>
1967	http://software.schmorp.de/pkg/rxvt-unicode	2138	http://software.schmorp.de/pkg/rxvt-unicode
1968		2139
1969	=cut	2140	=cut
1970		2141
1971	1	2142	1
		2143
		2144	# vim: sw=3:

Diff Legend

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