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.103 by root, Wed Jan 18 11:05:09 2006 UTC vs.
Revision 1.192 by root, Mon Feb 21 07:41:04 2011 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' 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	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	71	between two vertical bars:
65		72
66	URxvt.selection.pattern-0: \\|([^|]+)\\|	73	URxvt.selection.pattern-0: \\|([^|]+)\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
67		81
68	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
83	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
84		98
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.	100	runtime.
87		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
88	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
89		120
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
93		124
94	Other extensions can extend this popup menu by pushing a code reference onto	125	Other extensions can extend this popup menu by pushing a code reference
95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
96		128
97	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
98	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
99	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
100	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
101	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
102		134
103	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
104	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	137	C<a>s:
106		138
107	push urxvt::ext::selection_popup::hook, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
109	: ()	141	: ()
110	};	142	};
111		143
112	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
113		145
…		…
120	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
121	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
122	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
123	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
124	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
125	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
126		189
127	=item selection-autotransform	190	=item selection-autotransform
128		191
129	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
130	whenever a selection is made.	193	whenever a selection is made.
…		…
143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144		207
145	And this example matches the same,but replaces it with vi-commands you can	208	And this example matches the same,but replaces it with vi-commands you can
146	paste directly into your (vi :) editor:	209	paste directly into your (vi :) editor:
147		210
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149		212
150	Of course, this can be modified to suit your needs and your editor :)	213	Of course, this can be modified to suit your needs and your editor :)
151		214
152	To expand the example above to typical perl error messages ("XXX at	215	To expand the example above to typical perl error messages ("XXX at
153	FILENAME line YYY."), you need a slightly more elaborate solution:	216	FILENAME line YYY."), you need a slightly more elaborate solution:
154		217
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157		220
158	The first line tells the selection code to treat the unchanging part of	221	The first line tells the selection code to treat the unchanging part of
159	every error message as a selection pattern, and the second line transforms	222	every error message as a selection pattern, and the second line transforms
160	the message into vi commands to load the file.	223	the message into vi commands to load the file.
161		224
162	=item mark-urls	225	=item tabbed
163		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
164	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
165	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
166	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
167	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
168		313
169	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
170		315
171	A not very useful example of filtering all text output to the terminal,	316	A not very useful example of filtering all text output to the terminal
172	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
173	similar-looking ascii character.	318	similar-looking ascii character.
174		319
175	=item digital-clock	320	=item digital-clock
176		321
177	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
		323
		324	=item remote-clipboard
		325
		326	Somewhat of a misnomer, this extension adds two menu entries to the
		327	selection popup that allows one to run external commands to store the
		328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		343
		344	=item selection-pastebin
		345
		346	This is a little rarely useful extension that uploads the selection as
		347	textfile to a remote site (or does other things). (The implementation is
		348	not currently secure for use in a multiuser environment as it writes to
		349	F</tmp> directly.).
		350
		351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		352	i.e.
		353
		354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		355
		356	Pressing this combination runs a command with C<%> replaced by the name of
		357	the textfile. This command can be set via a resource:
		358
		359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		360
		361	And the default is likely not useful to anybody but the few people around
		362	here :)
		363
		364	The name of the textfile is the hex encoded md5 sum of the selection, so
		365	the same content should lead to the same filename.
		366
		367	After a successful upload the selection will be replaced by the text given
		368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		369	for the filename):
		370
		371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of whether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
178		391
179	=item example-refresh-hooks	392	=item example-refresh-hooks
180		393
181	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
182	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
183	overlays or changes.	396	overlays or changes.
184		397
185	=item selection-pastebin	398	=item confirm-paste
186		399
187	This is a little rarely useful extension that Uploads the selection as	400	Displays a confirmation dialog when a paste containing at least a full
188	textfile to a remote site (or does other things). (The implementation is	401	line is detected.
189	not currently secure for use in a multiuser environment as it writes to
190	F</tmp> directly.).
191
192	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
193	i.e.
194
195	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
196
197	Pressing this combination runs a command with C<%> replaced by the name of
198	the textfile. This command can be set via a resource:
199
200	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
201
202	And the default is likely not useful to anybody but the few people around
203	here :)
204
205	The name of the textfile is the hex encoded md5 sum of the selection, so
206	the same content should lead to the same filename.
207
208	After a successful upload the selection will be replaced by the text given
209	in the C<selection-pastebin-url> resource (again, the % is the placeholder
210	for the filename):
211
212	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
213		402
214	=back	403	=back
215		404
216	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
217		406
…		…
233		422
234	=over 4	423	=over 4
235		424
236	=item $text	425	=item $text
237		426
238	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
239	always represents one screen cell. See L<ROW_t> for a discussion of this format.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
240		429
241	=item $string	430	=item $string
242		431
243	A perl text string, with an emphasis on I<text>. It can store all unicode	432	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
251		440
252	=back	441	=back
253		442
254	=head2 Extension Objects	443	=head2 Extension Objects
255		444
256	Very perl extension is a perl class. A separate perl object is created	445	Every perl extension is a perl class. A separate perl object is created
257	for each terminal and each extension and passed as the first parameter to	446	for each terminal, and each terminal has its own set of extenion objects,
258	hooks. So extensions can use their C<$self> object without having to think	447	which are passed as the first parameter to hooks. So extensions can use
259	about other extensions, with the exception of methods and members that	448	their C<$self> object without having to think about clashes with other
		449	extensions or other terminals, with the exception of methods and members
260	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
261	use.	451	internal use.
262		452
263	Although it isn't a C<urxvt::term> object, you can call all methods of the	453	Although it isn't a C<urxvt::term> object, you can call all methods of the
264	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
265		455
266	It has the following methods and data members:	456	It has the following methods and data members:
…		…
287	=head2 Hooks	477	=head2 Hooks
288		478
289	The following subroutines can be declared in extension files, and will be	479	The following subroutines can be declared in extension files, and will be
290	called whenever the relevant event happens.	480	called whenever the relevant event happens.
291		481
292	The first argument passed to them is an extension oject as described in	482	The first argument passed to them is an extension object as described in
293	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
294		484
295	B<All> of these hooks must return a boolean value. If it is true, then the	485	B<All> of these hooks must return a boolean value. If any of the called
296	event counts as being I<consumed>, and the invocation of other hooks is	486	hooks returns true, then the event counts as being I<consumed>, and the
297	skipped, and the relevant action might not be carried out by the C++ code.	487	relevant action might not be carried out by the C++ code.
298		488
299	I<< When in doubt, return a false value (preferably C<()>). >>	489	I<< When in doubt, return a false value (preferably C<()>). >>
300		490
301	=over 4	491	=over 4
302		492
303	=item on_init $term	493	=item on_init $term
304		494
305	Called after a new terminal object has been initialized, but before	495	Called after a new terminal object has been initialized, but before
306	windows are created or the command gets run. Most methods are unsafe to	496	windows are created or the command gets run. Most methods are unsafe to
307	call or deliver senseless data, as terminal size and other characteristics	497	call or deliver senseless data, as terminal size and other characteristics
308	have not yet been determined. You can safely query and change resources,	498	have not yet been determined. You can safely query and change resources
309	though.	499	and options, though. For many purposes the C<on_start> hook is a better
		500	place.
		501
		502	=item on_start $term
		503
		504	Called at the very end of initialisation of a new terminal, just before
		505	trying to map (display) the toplevel and returning to the main loop.
		506
		507	=item on_destroy $term
		508
		509	Called whenever something tries to destroy terminal, when the terminal is
		510	still fully functional (not for long, though).
310		511
311	=item on_reset $term	512	=item on_reset $term
312		513
313	Called after the screen is "reset" for any reason, such as resizing or	514	Called after the screen is "reset" for any reason, such as resizing or
314	control sequences. Here is where you can react on changes to size-related	515	control sequences. Here is where you can react on changes to size-related
315	variables.	516	variables.
316		517
317	=item on_start $term	518	=item on_child_start $term, $pid
318		519
319	Called at the very end of initialisation of a new terminal, just before	520	Called just after the child process has been C<fork>ed.
320	returning to the mainloop.	521
		522	=item on_child_exit $term, $status
		523
		524	Called just after the child process has exited. C<$status> is the status
		525	from C<waitpid>.
321		526
322	=item on_sel_make $term, $eventtime	527	=item on_sel_make $term, $eventtime
323		528
324	Called whenever a selection has been made by the user, but before the	529	Called whenever a selection has been made by the user, but before the
325	selection text is copied, so changes to the beginning, end or type of the	530	selection text is copied, so changes to the beginning, end or type of the
…		…
332		537
333	Called whenever a selection has been copied, but before the selection is	538	Called whenever a selection has been copied, but before the selection is
334	requested from the server. The selection text can be queried and changed	539	requested from the server. The selection text can be queried and changed
335	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
336		541
337	Returning a true value aborts selection grabbing. It will still be hilighted.	542	Returning a true value aborts selection grabbing. It will still be highlighted.
338		543
339	=item on_sel_extend $term	544	=item on_sel_extend $term
340		545
341	Called whenever the user tries to extend the selection (e.g. with a double	546	Called whenever the user tries to extend the selection (e.g. with a double
342	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
343	should extend the selection itelf and return true to suppress the built-in	548	should extend the selection itself and return true to suppress the built-in
344	processing. This can happen multiple times, as long as the callback	549	processing. This can happen multiple times, as long as the callback
345	returns true, it will be called on every further click by the user and is	550	returns true, it will be called on every further click by the user and is
346	supposed to enlarge the selection more and more, if possible.	551	supposed to enlarge the selection more and more, if possible.
347		552
348	See the F<selection> example extension.	553	See the F<selection> example extension.
349		554
350	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
351		556
352	Called whenever the view offset changes, i..e the user or program	557	Called whenever the view offset changes, i.e. the user or program
353	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
354	show this many lines of scrollback.	559	show this many lines of scrollback.
355		560
356	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
357		562
…		…
361		566
362	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	567	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
363	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	568	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
364	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
365		570
366	=item on_osc_seq $term, $string	571	=item on_osc_seq $term, $op, $args, $resp
		572
		573	Called on every OSC sequence and can be used to suppress it or modify its
		574	behaviour. The default should be to return an empty list. A true value
		575	suppresses execution of the request completely. Make sure you don't get
		576	confused by recursive invocations when you output an OSC sequence within
		577	this callback.
		578
		579	C<on_osc_seq_perl> should be used for new behaviour.
		580
		581	=item on_osc_seq_perl $term, $args, $resp
367		582
368	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
369	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
370	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
371	string should start with the extension name and a colon, to distinguish	586	string should start with the extension name (sans -osc) and a semicolon,
372	it from commands for other extensions, and this might be enforced in the	587	to distinguish it from commands for other extensions, and this might be
373	future.	588	enforced in the future.
		589
		590	For example, C<overlay-osc> uses this:
		591
		592	sub on_osc_seq_perl {
		593	my ($self, $osc, $resp) = @_;
		594
		595	return unless $osc =~ s/^overlay;//;
		596
		597	... process remaining $osc string
		598	}
374		599
375	Be careful not ever to trust (in a security sense) the data you receive,	600	Be careful not ever to trust (in a security sense) the data you receive,
376	as its source can not easily be controleld (e-mail content, messages from	601	as its source can not easily be controlled (e-mail content, messages from
377	other users on the same system etc.).	602	other users on the same system etc.).
		603
		604	For responses, C<$resp> contains the end-of-args separator used by the
		605	sender.
378		606
379	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
380		608
381	Called whenever text is about to be output, with the text as argument. You	609	Called whenever text is about to be output, with the text as argument. You
382	can filter/change and output the text yourself by returning a true value	610	can filter/change and output the text yourself by returning a true value
…		…
387	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
388		616
389	Called whenever some data is written to the tty/pty and can be used to	617	Called whenever some data is written to the tty/pty and can be used to
390	suppress or filter tty input.	618	suppress or filter tty input.
391		619
		620	=item on_tt_paste $term, $octets
		621
		622	Called whenever text is about to be pasted, with the text as argument. You
		623	can filter/change and paste the text yourself by returning a true value
		624	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		625	locale-encoded.
		626
392	=item on_line_update $term, $row	627	=item on_line_update $term, $row
393		628
394	Called whenever a line was updated or changed. Can be used to filter	629	Called whenever a line was updated or changed. Can be used to filter
395	screen output (e.g. underline urls or other useless stuff). Only lines	630	screen output (e.g. underline urls or other useless stuff). Only lines
396	that are being shown will be filtered, and, due to performance reasons,	631	that are being shown will be filtered, and, due to performance reasons,
…		…
403	later with the already-modified line (e.g. if unrelated parts change), so	638	later with the already-modified line (e.g. if unrelated parts change), so
404	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
405		640
406	=item on_refresh_begin $term	641	=item on_refresh_begin $term
407		642
408	Called just before the screen gets redrawn. Can be used for overlay	643	Called just before the screen gets redrawn. Can be used for overlay or
409	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
410	restoring them in refresh_end. The built-in overlay and selection display	645	restoring them in refresh_end. The built-in overlay and selection display
411	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
412		647
413	=item on_refresh_end $term	648	=item on_refresh_end $term
414		649
415	Called just after the screen gets redrawn. See C<on_refresh_begin>.	650	Called just after the screen gets redrawn. See C<on_refresh_begin>.
416		651
417	=item on_keyboard_command $term, $string	652	=item on_user_command $term, $string
418		653
419	Called whenever the user presses a key combination that has a	654	Called whenever a user-configured event is being activated (e.g. via
420	C<perl:string> action bound to it (see description of the B<keysym>	655	a C<perl:string> action bound to a key, see description of the B<keysym>
421	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
		657
		658	The event is simply the action string. This interface is assumed to change
		659	slightly in the future.
		660
		661	=item on_resize_all_windows $term, $new_width, $new_height
		662
		663	Called just after the new window size has been calculated, but before
		664	windows are actually being resized or hints are being set. If this hook
		665	returns TRUE, setting of the window hints is being skipped.
422		666
423	=item on_x_event $term, $event	667	=item on_x_event $term, $event
424		668
425	Called on every X event received on the vt window (and possibly other	669	Called on every X event received on the vt window (and possibly other
426	windows). Should only be used as a last resort. Most event structure	670	windows). Should only be used as a last resort. Most event structure
427	members are not passed.	671	members are not passed.
428		672
		673	=item on_root_event $term, $event
		674
		675	Like C<on_x_event>, but is called for events on the root window.
		676
429	=item on_focus_in $term	677	=item on_focus_in $term
430		678
431	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
432	does focus in processing.	680	does focus in processing.
433		681
434	=item on_focus_out $term	682	=item on_focus_out $term
435		683
436	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
437	focus out processing.	685	focus out processing.
438		686
439	=item on_configure_notify $term, $event	687	=item on_configure_notify $term, $event
440		688
		689	=item on_property_notify $term, $event
		690
441	=item on_key_press $term, $event, $keysym, $octets	691	=item on_key_press $term, $event, $keysym, $octets
442		692
443	=item on_key_release $term, $event, $keysym	693	=item on_key_release $term, $event, $keysym
444		694
445	=item on_button_press $term, $event	695	=item on_button_press $term, $event
…		…
450		700
451	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
452		702
453	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
454		704
455	Called whenever the corresponding X event is received for the terminal If	705	Called whenever the corresponding X event is received for the terminal. If
456	the hook returns true, then the even will be ignored by rxvt-unicode.	706	the hook returns true, then the event will be ignored by rxvt-unicode.
457		707
458	The event is a hash with most values as named by Xlib (see the XEvent	708	The event is a hash with most values as named by Xlib (see the XEvent
459	manpage), with the additional members C<row> and C<col>, which are the row	709	manpage), with the additional members C<row> and C<col>, which are the
460	and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
461		711
462	C<on_key_press> additionally receives the string rxvt-unicode would	712	C<on_key_press> additionally receives the string rxvt-unicode would
463	output, if any, in locale-specific encoding.	713	output, if any, in locale-specific encoding.
464		714
465	subwindow.	715	subwindow.
		716
		717	=item on_client_message $term, $event
		718
		719	=item on_wm_protocols $term, $event
		720
		721	=item on_wm_delete_window $term, $event
		722
		723	Called when various types of ClientMessage events are received (all with
		724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		725
		726	=item on_bell $term
		727
		728	Called on receipt of a bell character.
466		729
467	=back	730	=back
468		731
469	=cut	732	=cut
470		733
…		…
476	use Scalar::Util ();	739	use Scalar::Util ();
477	use List::Util ();	740	use List::Util ();
478		741
479	our $VERSION = 1;	742	our $VERSION = 1;
480	our $TERM;	743	our $TERM;
		744	our @TERM_INIT;
		745	our @TERM_EXT;
481	our @HOOKNAME;	746	our @HOOKNAME;
482	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	747	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
483	our %OPTION;	748	our %OPTION;
484		749
485	our $LIBDIR;	750	our $LIBDIR;
486	our $RESNAME;	751	our $RESNAME;
487	our $RESCLASS;	752	our $RESCLASS;
488	our $RXVTNAME;	753	our $RXVTNAME;
489		754
		755	our $NOCHAR = chr 0xffff;
		756
490	=head2 Variables in the C<urxvt> Package	757	=head2 Variables in the C<urxvt> Package
491		758
492	=over 4	759	=over 4
493		760
494	=item $urxvt::LIBDIR	761	=item $urxvt::LIBDIR
…		…
507	=item $urxvt::TERM	774	=item $urxvt::TERM
508		775
509	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
510	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
511		778
		779	=item @urxvt::TERM_INIT
		780
		781	All code references in this array will be called as methods of the next newly
		782	created C<urxvt::term> object (during the C<on_init> phase). The array
		783	gets cleared before the code references that were in it are being executed,
		784	so references can push themselves onto it again if they so desire.
		785
		786	This complements to the perl-eval command line option, but gets executed
		787	first.
		788
		789	=item @urxvt::TERM_EXT
		790
		791	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		792	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		793	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		794
512	=back	795	=back
513		796
514	=head2 Functions in the C<urxvt> Package	797	=head2 Functions in the C<urxvt> Package
515		798
516	=over 4	799	=over 4
517		800
518	=item urxvt::fatal $errormessage	801	=item urxvt::fatal $errormessage
519		802
520	Fatally aborts execution with the given error message. Avoid at all	803	Fatally aborts execution with the given error message (which should
521	costs! The only time this is acceptable is when the terminal process	804	include a trailing newline). Avoid at all costs! The only time this
522	starts up.	805	is acceptable (and useful) is in the init hook, where it prevents the
		806	terminal from starting up.
523		807
524	=item urxvt::warn $string	808	=item urxvt::warn $string
525		809
526	Calls C<rxvt_warn> with the given string which should not include a	810	Calls C<rxvt_warn> with the given string which should include a trailing
527	newline. The module also overwrites the C<warn> builtin with a function	811	newline. The module also overwrites the C<warn> builtin with a function
528	that calls this function.	812	that calls this function.
529		813
530	Using this function has the advantage that its output ends up in the	814	Using this function has the advantage that its output ends up in the
531	correct place, e.g. on stderr of the connecting urxvtc client.	815	correct place, e.g. on stderr of the connecting urxvtc client.
532		816
533	Messages have a size limit of 1023 bytes currently.	817	Messages have a size limit of 1023 bytes currently.
		818
		819	=item @terms = urxvt::termlist
		820
		821	Returns all urxvt::term objects that exist in this process, regardless of
		822	whether they are started, being destroyed etc., so be careful. Only term
		823	objects that have perl extensions attached will be returned (because there
		824	is no urxvt::term objet associated with others).
534		825
535	=item $time = urxvt::NOW	826	=item $time = urxvt::NOW
536		827
537	Returns the "current time" (as per the event loop).	828	Returns the "current time" (as per the event loop).
538		829
…		…
581		872
582	=item $rend = urxvt::OVERLAY_RSTYLE	873	=item $rend = urxvt::OVERLAY_RSTYLE
583		874
584	Return the rendition mask used for overlays by default.	875	Return the rendition mask used for overlays by default.
585		876
586	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	877	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		878	urxvt::RS_RVid, urxvt::RS_Uline
587		879
588	Return the bit that enabled bold, italic, blink, reverse-video and	880	Return the bit that enabled bold, italic, blink, reverse-video and
589	underline, respectively. To enable such a style, just logically OR it into	881	underline, respectively. To enable such a style, just logically OR it into
590	the bitset.	882	the bitset.
591		883
…		…
596	Return the foreground/background colour index, respectively.	888	Return the foreground/background colour index, respectively.
597		889
598	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	890	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
599		891
600	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	892	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		893
		894	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
601		895
602	Replace the foreground/background colour in the rendition mask with the	896	Replace the foreground/background colour in the rendition mask with the
603	specified one.	897	specified one.
604		898
605	=item $value = urxvt::GET_CUSTOM $rend	899	=item $value = urxvt::GET_CUSTOM $rend
…		…
622	my $msg = join "", @_;	916	my $msg = join "", @_;
623	$msg .= "\n"	917	$msg .= "\n"
624	unless $msg =~ /\n$/;	918	unless $msg =~ /\n$/;
625	urxvt::warn ($msg);	919	urxvt::warn ($msg);
626	};	920	};
627
628	# %ENV is the original startup environment
629	delete $ENV{IFS};
630	delete $ENV{CDPATH};
631	delete $ENV{BASH_ENV};
632	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
633	}	921	}
		922
		923	no warnings 'utf8';
634		924
635	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	925	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
636		926
637	sub verbose {	927	sub verbose {
638	my ($level, $msg) = @_;	928	my ($level, $msg) = @_;
…		…
642	my %extension_pkg;	932	my %extension_pkg;
643		933
644	# load a single script into its own package, once only	934	# load a single script into its own package, once only
645	sub extension_package($) {	935	sub extension_package($) {
646	my ($path) = @_;	936	my ($path) = @_;
647
648	no strict 'refs';
649		937
650	$extension_pkg{$path} ||= do {	938	$extension_pkg{$path} ||= do {
651	$path =~ /([^\/\\]+)$/;	939	$path =~ /([^\/\\]+)$/;
652	my $pkg = $1;	940	my $pkg = $1;
653	$pkg =~ s/[^[:word:]]/_/g;	941	$pkg =~ s/[^[:word:]]/_/g;
…		…
656	verbose 3, "loading extension '$path' into package '$pkg'";	944	verbose 3, "loading extension '$path' into package '$pkg'";
657		945
658	open my $fh, "<:raw", $path	946	open my $fh, "<:raw", $path
659	or die "$path: $!";	947	or die "$path: $!";
660		948
661	@{"$pkg\::ISA"} = urxvt::term::extension::;
662
663	my $source =	949	my $source =
664	"package $pkg; use strict; use utf8;\n"	950	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
665	. "#line 1 \"$path\"\n{\n"	951	. "#line 1 \"$path\"\n{\n"
666	. (do { local $/; <$fh> })	952	. (do { local $/; <$fh> })
667	. "\n};\n1";	953	. "\n};\n1";
668		954
669	eval $source	955	eval $source
…		…
680	local $TERM = shift;	966	local $TERM = shift;
681	my $htype = shift;	967	my $htype = shift;
682		968
683	if ($htype == 0) { # INIT	969	if ($htype == 0) { # INIT
684	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
685		971
686	my %ext_arg;	972	my %ext_arg;
687		973
		974	{
		975	my @init = @TERM_INIT;
		976	@TERM_INIT = ();
		977	$_->($TERM) for @init;
		978	my @pkg = @TERM_EXT;
		979	@TERM_EXT = ();
		980	$TERM->register_package ($_) for @pkg;
		981	}
		982
688	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	983	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
689	if ($_ eq "default") {	984	if ($_ eq "default") {
690	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	985	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
691	} elsif (/^-(.*)$/) {	986	} elsif (/^-(.*)$/) {
692	delete $ext_arg{$1};	987	delete $ext_arg{$1};
693	} elsif (/^([^<]+)<(.*)>$/) {	988	} elsif (/^([^<]+)<(.*)>$/) {
694	push @{ $ext_arg{$1} }, $2;	989	push @{ $ext_arg{$1} }, $2;
695	} else {	990	} else {
696	$ext_arg{$_} ||= [];	991	$ext_arg{$_} ||= [];
697	}	992	}
698	}	993	}
699		994
700	while (my ($ext, $argv) = each %ext_arg) {	995	for my $ext (sort keys %ext_arg) {
701	my @files = grep -f $_, map "$_/$ext", @dirs;	996	my @files = grep -f $_, map "$_/$ext", @dirs;
702		997
703	if (@files) {	998	if (@files) {
704	$TERM->register_package (extension_package $files[0], $argv);	999	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
705	} else {	1000	} else {
706	warn "perl extension '$ext' not found in perl library search path\n";	1001	warn "perl extension '$ext' not found in perl library search path\n";
707	}	1002	}
708	}	1003	}
709		1004
…		…
715		1010
716	if (my $cb = $TERM->{_hook}[$htype]) {	1011	if (my $cb = $TERM->{_hook}[$htype]) {
717	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1012	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
718	if $verbosity >= 10;	1013	if $verbosity >= 10;
719		1014
720	keys %$cb;	1015	for my $pkg (keys %$cb) {
721
722	while (my ($pkg, $cb) = each %$cb) {
723	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1016	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
724	and last;	1017	$retval ||= $retval_;
725		1018
726	if ($@) {	1019	if ($@) {
727	$TERM->ungrab; # better to lose the grab than the session	1020	$TERM->ungrab; # better to lose the grab than the session
728	warn $@;	1021	warn $@;
729	}	1022	}
…		…
742	}	1035	}
743		1036
744	$retval	1037	$retval
745	}	1038	}
746		1039
747	sub exec_async(@) {	1040	sub SET_COLOR($$$) {
748	my $pid = fork;	1041	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1042	}
749		1043
750	return	1044	sub rend2mask {
751	if !defined $pid or $pid;	1045	no strict 'refs';
752		1046	my ($str, $mask) = (@_, 0);
753	%ENV = %{ $TERM->env };	1047	my %color = ( fg => undef, bg => undef );
754		1048	my @failed;
755	exec @_;	1049	for my $spec ( split /\s+/, $str ) {
756	_exit 255;	1050	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1051	$color{lc($1)} = $2;
		1052	} else {
		1053	my $neg = $spec =~ s/^[-^]//;
		1054	unless ( exists &{"RS_$spec"} ) {
		1055	push @failed, $spec;
		1056	next;
		1057	}
		1058	my $cur = &{"RS_$spec"};
		1059	if ( $neg ) {
		1060	$mask &= ~$cur;
		1061	} else {
		1062	$mask |= $cur;
		1063	}
		1064	}
		1065	}
		1066	($mask, @color{qw(fg bg)}, \@failed)
757	}	1067	}
758		1068
759	# urxvt::term::extension	1069	# urxvt::term::extension
760		1070
761	package urxvt::term::extension;	1071	package urxvt::term::extension;
…		…
832	is that you cannot use blocking APIs, but the non-blocking variant should	1142	is that you cannot use blocking APIs, but the non-blocking variant should
833	work.	1143	work.
834		1144
835	=cut	1145	=cut
836		1146
837	our $VERSION = 1;	1147	our $VERSION = '5.23';
838		1148
839	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1149	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
840	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1150	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
841		1151
842	sub timer {	1152	sub timer {
…		…
844		1154
845	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
846		1156
847	urxvt::timer	1157	urxvt::timer
848	->new	1158	->new
849	->start (urxvt::NOW + $arg{after})	1159	->after ($arg{after}, $arg{interval})
850	->cb (sub {	1160	->cb ($arg{interval} ? $cb : sub {
851	$_[0]->stop; # need to cancel manually	1161	$_[0]->stop; # need to cancel manually
852	$cb->();	1162	$cb->();
853	})	1163	})
854	}	1164	}
855		1165
856	sub io {	1166	sub io {
857	my ($class, %arg) = @_;	1167	my ($class, %arg) = @_;
858		1168
859	my $cb = $arg{cb};	1169	my $cb = $arg{cb};
		1170	my $fd = fileno $arg{fh};
		1171	defined $fd or $fd = $arg{fh};
860		1172
861	bless [$arg{fh}, urxvt::iow	1173	bless [$arg{fh}, urxvt::iow
862	->new	1174	->new
863	->fd (fileno $arg{fh})	1175	->fd ($fd)
864	->events (($arg{poll} =~ /r/ ? 1 : 0)	1176	->events (($arg{poll} =~ /r/ ? 1 : 0)
865	| ($arg{poll} =~ /w/ ? 2 : 0))	1177	| ($arg{poll} =~ /w/ ? 2 : 0))
866	->start	1178	->start
867	->cb (sub {	1179	->cb ($cb)
868	$cb->(($_[1] & 1 ? 'r' : '')
869	. ($_[1] & 2 ? 'w' : ''));
870	})],
871	urxvt::anyevent::	1180	], urxvt::anyevent::
		1181	}
		1182
		1183	sub idle {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::iw
		1189	->new
		1190	->start
		1191	->cb ($cb)
		1192	}
		1193
		1194	sub child {
		1195	my ($class, %arg) = @_;
		1196
		1197	my $cb = $arg{cb};
		1198
		1199	urxvt::pw
		1200	->new
		1201	->start ($arg{pid})
		1202	->cb (sub {
		1203	$_[0]->stop; # need to cancel manually
		1204	$cb->($_[0]->rpid, $_[0]->rstatus);
		1205	})
872	}	1206	}
873		1207
874	sub DESTROY {	1208	sub DESTROY {
875	$_[0][1]->stop;	1209	$_[0][1]->stop;
876	}	1210	}
877		1211
878	sub condvar {	1212	sub one_event {
879	bless \my $flag, urxvt::anyevent::condvar::
880	}
881
882	sub urxvt::anyevent::condvar::broadcast {
883	${$_[0]}++;
884	}
885
886	sub urxvt::anyevent::condvar::wait {
887	unless (${$_[0]}) {
888	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1213	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
889	}
890	}	1214	}
891		1215
892	package urxvt::term;	1216	package urxvt::term;
893		1217
894	=head2 The C<urxvt::term> Class	1218	=head2 The C<urxvt::term> Class
…		…
899		1223
900	# find on_xxx subs in the package and register them	1224	# find on_xxx subs in the package and register them
901	# as hooks	1225	# as hooks
902	sub register_package {	1226	sub register_package {
903	my ($self, $pkg, $argv) = @_;	1227	my ($self, $pkg, $argv) = @_;
		1228
		1229	no strict 'refs';
		1230
		1231	urxvt::verbose 6, "register package $pkg to $self";
		1232
		1233	@{"$pkg\::ISA"} = urxvt::term::extension::;
904		1234
905	my $proxy = bless {	1235	my $proxy = bless {
906	_pkg => $pkg,	1236	_pkg => $pkg,
907	argv => $argv,	1237	argv => $argv,
908	}, $pkg;	1238	}, $pkg;
…		…
924	hash which defines the environment of the new terminal.	1254	hash which defines the environment of the new terminal.
925		1255
926	Croaks (and probably outputs an error message) if the new instance	1256	Croaks (and probably outputs an error message) if the new instance
927	couldn't be created. Returns C<undef> if the new instance didn't	1257	couldn't be created. Returns C<undef> if the new instance didn't
928	initialise perl, and the terminal object otherwise. The C<init> and	1258	initialise perl, and the terminal object otherwise. The C<init> and
929	C<start> hooks will be called during this call.	1259	C<start> hooks will be called before this call returns, and are free to
		1260	refer to global data (which is race free).
930		1261
931	=cut	1262	=cut
932		1263
933	sub new {	1264	sub new {
934	my ($class, $env, @args) = @_;	1265	my ($class, $env, @args) = @_;
935		1266
		1267	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1268	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1269
936	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1270	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
937	}	1271	}
938		1272
939	=item $term->destroy	1273	=item $term->destroy
940		1274
941	Destroy the terminal object (close the window, free resources	1275	Destroy the terminal object (close the window, free resources
942	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1276	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
943	watchers (timers, io watchers) are still active.	1277	watchers (timers, io watchers) are still active.
944		1278
		1279	=item $term->exec_async ($cmd[, @args])
		1280
		1281	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1282	("starts") programs in the background. This function takes care of setting
		1283	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1284	be preferred over explicit calls to C<exec> or C<system>.
		1285
		1286	Returns the pid of the subprocess or C<undef> on error.
		1287
		1288	=cut
		1289
		1290	sub exec_async {
		1291	my $self = shift;
		1292
		1293	my $pid = fork;
		1294
		1295	return $pid
		1296	if !defined $pid or $pid;
		1297
		1298	%ENV = %{ $self->env };
		1299
		1300	exec @_;
		1301	urxvt::_exit 255;
		1302	}
		1303
945	=item $isset = $term->option ($optval[, $set])	1304	=item $isset = $term->option ($optval[, $set])
946		1305
947	Returns true if the option specified by C<$optval> is enabled, and	1306	Returns true if the option specified by C<$optval> is enabled, and
948	optionally change it. All option values are stored by name in the hash	1307	optionally change it. All option values are stored by name in the hash
949	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1308	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
950		1309
951	Here is a a likely non-exhaustive list of option names, please see the	1310	Here is a likely non-exhaustive list of option names, please see the
952	source file F</src/optinc.h> to see the actual list:	1311	source file F</src/optinc.h> to see the actual list:
953		1312
954	borderLess console cursorBlink cursorUnderline hold iconic insecure	1313	borderLess console cursorBlink cursorUnderline hold iconic insecure
955	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1314	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
956	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1315	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
957	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1316	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
958	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1317	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
959	tripleclickwords utmpInhibit visualBell	1318	transparent tripleclickwords utmpInhibit visualBell
960		1319
961	=item $value = $term->resource ($name[, $newval])	1320	=item $value = $term->resource ($name[, $newval])
962		1321
963	Returns the current resource value associated with a given name and	1322	Returns the current resource value associated with a given name and
964	optionally sets a new value. Setting values is most useful in the C<init>	1323	optionally sets a new value. Setting values is most useful in the C<init>
…		…
973	likely change).	1332	likely change).
974		1333
975	Please note that resource strings will currently only be freed when the	1334	Please note that resource strings will currently only be freed when the
976	terminal is destroyed, so changing options frequently will eat memory.	1335	terminal is destroyed, so changing options frequently will eat memory.
977		1336
978	Here is a a likely non-exhaustive list of resource names, not all of which	1337	Here is a likely non-exhaustive list of resource names, not all of which
979	are supported in every build, please see the source file F</src/rsinc.h>	1338	are supported in every build, please see the source file F</src/rsinc.h>
980	to see the actual list:	1339	to see the actual list:
981		1340
982	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1341	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
983	borderLess color cursorBlink cursorUnderline cutchars delete_key	1342	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
984	display_name embed ext_bwidth fade font geometry hold iconName	1343	display_name embed ext_bwidth fade font geometry hold iconName
985	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1344	imFont imLocale inputMethod insecure int_bwidth intensityStyles
986	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1345	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
987	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1346	modifier mouseWheelScrollPage name override_redirect pastableTabs path
988	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1347	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
989	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1348	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
990	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1349	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
991	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1350	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
992	shade term_name title transparent transparent_all tripleclickwords	1351	secondaryScreen secondaryScroll shade term_name title
993	utmpInhibit visualBell	1352	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1353	visualBell
994		1354
995	=cut	1355	=cut
996		1356
997	sub resource($$;$) {	1357	sub resource($$;$) {
998	my ($self, $name) = (shift, shift);	1358	my ($self, $name) = (shift, shift);
999	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1359	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1000	&urxvt::term::_resource	1360	goto &urxvt::term::_resource
1001	}	1361	}
1002		1362
1003	=item $value = $term->x_resource ($pattern)	1363	=item $value = $term->x_resource ($pattern)
1004		1364
1005	Returns the X-Resource for the given pattern, excluding the program or	1365	Returns the X-Resource for the given pattern, excluding the program or
…		…
1030		1390
1031	=item ($row, $col) = $term->selection_beg ([$row, $col])	1391	=item ($row, $col) = $term->selection_beg ([$row, $col])
1032		1392
1033	=item ($row, $col) = $term->selection_end ([$row, $col])	1393	=item ($row, $col) = $term->selection_end ([$row, $col])
1034		1394
1035	Return the current values of the selection mark, begin or end positions,	1395	Return the current values of the selection mark, begin or end positions.
1036	and optionally set them to new values.	1396
		1397	When arguments are given, then the selection coordinates are set to
		1398	C<$row> and C<$col>, and the selection screen is set to the current
		1399	screen.
		1400
		1401	=item $screen = $term->selection_screen ([$screen])
		1402
		1403	Returns the current selection screen, and then optionally sets it.
1037		1404
1038	=item $term->selection_make ($eventtime[, $rectangular])	1405	=item $term->selection_make ($eventtime[, $rectangular])
1039		1406
1040	Tries to make a selection as set by C<selection_beg> and	1407	Tries to make a selection as set by C<selection_beg> and
1041	C<selection_end>. If C<$rectangular> is true (default: false), a	1408	C<selection_end>. If C<$rectangular> is true (default: false), a
1042	rectangular selection will be made. This is the prefered function to make	1409	rectangular selection will be made. This is the preferred function to make
1043	a selection.	1410	a selection.
1044		1411
1045	=item $success = $term->selection_grab ($eventtime)	1412	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1046		1413
1047	Try to request the primary selection text from the server (for example, as	1414	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1415	true) selection from the server. The corresponding text can be set
1048	set by the next method). No visual feedback will be given. This function	1416	with the next method. No visual feedback will be given. This function
1049	is mostly useful from within C<on_sel_grab> hooks.	1417	is mostly useful from within C<on_sel_grab> hooks.
1050		1418
1051	=item $oldtext = $term->selection ([$newtext])	1419	=item $oldtext = $term->selection ([$newtext, $clipboard])
1052		1420
1053	Return the current selection text and optionally replace it by C<$newtext>.	1421	Return the current selection (clipboard if C<$clipboard> is true) text
		1422	and optionally replace it by C<$newtext>.
		1423
		1424	=item $term->selection_clear ([$clipboard])
		1425
		1426	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1054		1427
1055	=item $term->overlay_simple ($x, $y, $text)	1428	=item $term->overlay_simple ($x, $y, $text)
1056		1429
1057	Create a simple multi-line overlay box. See the next method for details.	1430	Create a simple multi-line overlay box. See the next method for details.
1058		1431
…		…
1088		1461
1089	The methods currently supported on C<urxvt::overlay> objects are:	1462	The methods currently supported on C<urxvt::overlay> objects are:
1090		1463
1091	=over 4	1464	=over 4
1092		1465
1093	=item $overlay->set ($x, $y, $text, $rend)	1466	=item $overlay->set ($x, $y, $text[, $rend])
1094		1467
1095	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1468	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1096	text in rxvt-unicode's special encoding and an array of rendition values	1469	text in rxvt-unicode's special encoding and an array of rendition values
1097	at a specific position inside the overlay.	1470	at a specific position inside the overlay.
		1471
		1472	If C<$rend> is missing, then the rendition will not be changed.
1098		1473
1099	=item $overlay->hide	1474	=item $overlay->hide
1100		1475
1101	If visible, hide the overlay, but do not destroy it.	1476	If visible, hide the overlay, but do not destroy it.
1102		1477
…		…
1172		1547
1173	Normally its not a good idea to use this function, as programs might be	1548	Normally its not a good idea to use this function, as programs might be
1174	confused by changes in cursor position or scrolling. Its useful inside a	1549	confused by changes in cursor position or scrolling. Its useful inside a
1175	C<on_add_lines> hook, though.	1550	C<on_add_lines> hook, though.
1176		1551
		1552	=item $term->scr_change_screen ($screen)
		1553
		1554	Switch to given screen - 0 primary, 1 secondary.
		1555
1177	=item $term->cmd_parse ($octets)	1556	=item $term->cmd_parse ($octets)
1178		1557
1179	Similar to C<scr_add_lines>, but the argument must be in the	1558	Similar to C<scr_add_lines>, but the argument must be in the
1180	locale-specific encoding of the terminal and can contain command sequences	1559	locale-specific encoding of the terminal and can contain command sequences
1181	(escape codes) that will be interpreted.	1560	(escape codes) that will be interpreted.
1182		1561
1183	=item $term->tt_write ($octets)	1562	=item $term->tt_write ($octets)
1184		1563
1185	Write the octets given in C<$data> to the tty (i.e. as program input). To	1564	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1186	pass characters instead of octets, you should convert your strings first	1565	pass characters instead of octets, you should convert your strings first
1187	to the locale-specific encoding using C<< $term->locale_encode >>.	1566	to the locale-specific encoding using C<< $term->locale_encode >>.
		1567
		1568	=item $term->tt_paste ($octets)
		1569
		1570	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1571	CR and bracketing the data with control sequences if bracketed paste mode
		1572	is set.
1188		1573
1189	=item $old_events = $term->pty_ev_events ([$new_events])	1574	=item $old_events = $term->pty_ev_events ([$new_events])
1190		1575
1191	Replaces the event mask of the pty watcher by the given event mask. Can	1576	Replaces the event mask of the pty watcher by the given event mask. Can
1192	be used to suppress input and output handling to the pty/tty. See the	1577	be used to suppress input and output handling to the pty/tty. See the
1193	description of C<< urxvt::timer->events >>. Make sure to always restore	1578	description of C<< urxvt::timer->events >>. Make sure to always restore
1194	the previous value.	1579	the previous value.
1195		1580
		1581	=item $fd = $term->pty_fd
		1582
		1583	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1584	is used.
		1585
1196	=item $windowid = $term->parent	1586	=item $windowid = $term->parent
1197		1587
1198	Return the window id of the toplevel window.	1588	Return the window id of the toplevel window.
1199		1589
1200	=item $windowid = $term->vt	1590	=item $windowid = $term->vt
…		…
1206	Adds the specified events to the vt event mask. Useful e.g. when you want	1596	Adds the specified events to the vt event mask. Useful e.g. when you want
1207	to receive pointer events all the times:	1597	to receive pointer events all the times:
1208		1598
1209	$term->vt_emask_add (urxvt::PointerMotionMask);	1599	$term->vt_emask_add (urxvt::PointerMotionMask);
1210		1600
		1601	=item $term->focus_in
		1602
		1603	=item $term->focus_out
		1604
		1605	=item $term->key_press ($state, $keycode[, $time])
		1606
		1607	=item $term->key_release ($state, $keycode[, $time])
		1608
		1609	Deliver various fake events to to terminal.
		1610
1211	=item $window_width = $term->width	1611	=item $window_width = $term->width
1212		1612
1213	=item $window_height = $term->height	1613	=item $window_height = $term->height
1214		1614
1215	=item $font_width = $term->fwidth	1615	=item $font_width = $term->fwidth
…		…
1245	=item $env = $term->env	1645	=item $env = $term->env
1246		1646
1247	Returns a copy of the environment in effect for the terminal as a hashref	1647	Returns a copy of the environment in effect for the terminal as a hashref
1248	similar to C<\%ENV>.	1648	similar to C<\%ENV>.
1249		1649
		1650	=item @envv = $term->envv
		1651
		1652	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1653
		1654	=item @argv = $term->argv
		1655
		1656	Return the argument vector as this terminal, similar to @ARGV, but
		1657	includes the program name as first element.
		1658
1250	=cut	1659	=cut
1251		1660
1252	sub env {	1661	sub env {
1253	if (my $env = $_[0]->_env) {
1254	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1662	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1255	} else {
1256	+{ %ENV }
1257	}
1258	}	1663	}
1259		1664
1260	=item $modifiermask = $term->ModLevel3Mask	1665	=item $modifiermask = $term->ModLevel3Mask
1261		1666
1262	=item $modifiermask = $term->ModMetaMask	1667	=item $modifiermask = $term->ModMetaMask
1263		1668
1264	=item $modifiermask = $term->ModNumLockMask	1669	=item $modifiermask = $term->ModNumLockMask
1265		1670
1266	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1671	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1267	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1672	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1673
		1674	=item $screen = $term->current_screen
		1675
		1676	Returns the currently displayed screen (0 primary, 1 secondary).
		1677
		1678	=item $cursor_is_hidden = $term->hidden_cursor
		1679
		1680	Returns whether the cursor is currently hidden or not.
1268		1681
1269	=item $view_start = $term->view_start ([$newvalue])	1682	=item $view_start = $term->view_start ([$newvalue])
1270		1683
1271	Returns the row number of the topmost displayed line. Maximum value is	1684	Returns the row number of the topmost displayed line. Maximum value is
1272	C<0>, which displays the normal terminal contents. Lower values scroll	1685	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1280		1693
1281	Used after changing terminal contents to display them.	1694	Used after changing terminal contents to display them.
1282		1695
1283	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1696	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1284		1697
1285	Returns the text of the entire row with number C<$row_number>. Row C<0>	1698	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1286	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1699	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1287	terminal line. The scrollback buffer starts at line C<-1> and extends to
1288	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1700	terminal line. Nothing will be returned if a nonexistent line
1289	is requested.	1701	is requested.
1290		1702
1291	If C<$new_text> is specified, it will replace characters in the current	1703	If C<$new_text> is specified, it will replace characters in the current
1292	line, starting at column C<$start_col> (default C<0>), which is useful	1704	line, starting at column C<$start_col> (default C<0>), which is useful
1293	to replace only parts of a line. The font index in the rendition will	1705	to replace only parts of a line. The font index in the rendition will
1294	automatically be updated.	1706	automatically be updated.
1295		1707
1296	C<$text> is in a special encoding: tabs and wide characters that use more	1708	C<$text> is in a special encoding: tabs and wide characters that use more
1297	than one cell when displayed are padded with urxvt::NOCHAR characters	1709	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1298	(C<chr 65535>). Characters with combining characters and other characters	1710	characters. Characters with combining characters and other characters that
1299	that do not fit into the normal tetx encoding will be replaced with	1711	do not fit into the normal text encoding will be replaced with characters
1300	characters in the private use area.	1712	in the private use area.
1301		1713
1302	You have to obey this encoding when changing text. The advantage is	1714	You have to obey this encoding when changing text. The advantage is
1303	that C<substr> and similar functions work on screen cells and not on	1715	that C<substr> and similar functions work on screen cells and not on
1304	characters.	1716	characters.
1305		1717
…		…
1449	where one character corresponds to one screen cell. See	1861	where one character corresponds to one screen cell. See
1450	C<< $term->ROW_t >> for details.	1862	C<< $term->ROW_t >> for details.
1451		1863
1452	=item $string = $term->special_decode $text	1864	=item $string = $term->special_decode $text
1453		1865
1454	Converts rxvt-unicodes text reprsentation into a perl string. See	1866	Converts rxvt-unicodes text representation into a perl string. See
1455	C<< $term->ROW_t >> for details.	1867	C<< $term->ROW_t >> for details.
1456		1868
1457	=item $success = $term->grab_button ($button, $modifiermask)	1869	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1458		1870
		1871	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1872
1459	Registers a synchronous button grab. See the XGrabButton manpage.	1873	Register/unregister a synchronous button grab. See the XGrabButton
		1874	manpage.
1460		1875
1461	=item $success = $term->grab ($eventtime[, $sync])	1876	=item $success = $term->grab ($eventtime[, $sync])
1462		1877
1463	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1878	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1464	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1879	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1465		1880
1466	=item $term->allow_events_async	1881	=item $term->allow_events_async
1467		1882
1468	Calls XAllowEvents with AsyncBoth for the most recent grab.	1883	Calls XAllowEvents with AsyncBoth for the most recent grab.
1469		1884
…		…
1476	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1891	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1477	recent grab.	1892	recent grab.
1478		1893
1479	=item $term->ungrab	1894	=item $term->ungrab
1480		1895
1481	Calls XUngrab for the most recent grab. Is called automatically on	1896	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1482	evaluation errors, as it is better to lose the grab in the error case as	1897	evaluation errors, as it is better to lose the grab in the error case as
1483	the session.	1898	the session.
		1899
		1900	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1901
		1902	=item $atom_name = $term->XGetAtomName ($atom)
		1903
		1904	=item @atoms = $term->XListProperties ($window)
		1905
		1906	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1907
		1908	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1909
		1910	=item $term->XDeleteProperty ($window, $property)
		1911
		1912	=item $window = $term->DefaultRootWindow
		1913
		1914	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1915
		1916	=item $term->XMapWindow ($window)
		1917
		1918	=item $term->XUnmapWindow ($window)
		1919
		1920	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1921
		1922	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1923
		1924	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1925
		1926	Various X or X-related functions. The C<$term> object only serves as
		1927	the source of the display, otherwise those functions map more-or-less
		1928	directly onto the X functions of the same name.
1484		1929
1485	=back	1930	=back
1486		1931
1487	=cut	1932	=cut
1488		1933
…		…
1552	my ($self, $text, $cb) = @_;	1997	my ($self, $text, $cb) = @_;
1553		1998
1554	$self->add_item ({ type => "button", text => $text, activate => $cb});	1999	$self->add_item ({ type => "button", text => $text, activate => $cb});
1555	}	2000	}
1556		2001
1557	=item $popup->add_toggle ($text, $cb, $initial_value)	2002	=item $popup->add_toggle ($text, $initial_value, $cb)
1558		2003
1559	Adds a toggle/checkbox item to the popup. Teh callback gets called	2004	Adds a toggle/checkbox item to the popup. The callback gets called
1560	whenever it gets toggled, with a boolean indicating its value as its first	2005	whenever it gets toggled, with a boolean indicating its new value as its
1561	argument.	2006	first argument.
1562		2007
1563	=cut	2008	=cut
1564		2009
1565	sub add_toggle {	2010	sub add_toggle {
1566	my ($self, $text, $cb, $value) = @_;	2011	my ($self, $text, $value, $cb) = @_;
1567		2012
1568	my $item; $item = {	2013	my $item; $item = {
1569	type => "button",	2014	type => "button",
1570	text => " $text",	2015	text => " $text",
1571	value => $value,	2016	value => $value,
…		…
1590	my $env = $self->{term}->env;	2035	my $env = $self->{term}->env;
1591	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2036	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1592	delete $env->{LC_ALL};	2037	delete $env->{LC_ALL};
1593	$env->{LC_CTYPE} = $self->{term}->locale;	2038	$env->{LC_CTYPE} = $self->{term}->locale;
1594		2039
1595	urxvt::term->new ($env, "popup",	2040	my $term = urxvt::term->new (
1596	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2041	$env, "popup",
		2042	"--perl-lib" => "", "--perl-ext-common" => "",
		2043	"-pty-fd" => -1, "-sl" => 0,
		2044	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1597	"--transient-for" => $self->{term}->parent,	2045	"--transient-for" => $self->{term}->parent,
1598	"-display" => $self->{term}->display_id,	2046	"-display" => $self->{term}->display_id,
1599	"-pe" => "urxvt-popup")	2047	"-pe" => "urxvt-popup",
1600	or die "unable to create popup window\n";	2048	) or die "unable to create popup window\n";
		2049
		2050	unless (delete $term->{urxvt_popup_init_done}) {
		2051	$term->ungrab;
		2052	$term->destroy;
		2053	die "unable to initialise popup window\n";
		2054	}
1601	}	2055	}
1602		2056
1603	sub DESTROY {	2057	sub DESTROY {
1604	my ($self) = @_;	2058	my ($self) = @_;
1605		2059
1606	delete $self->{term}{_destroy}{$self};	2060	delete $self->{term}{_destroy}{$self};
1607	$self->{term}->ungrab;	2061	$self->{term}->ungrab;
1608	}	2062	}
1609		2063
1610	=back	2064	=back
		2065
		2066	=cut
		2067
		2068	package urxvt::watcher;
1611		2069
1612	=head2 The C<urxvt::timer> Class	2070	=head2 The C<urxvt::timer> Class
1613		2071
1614	This class implements timer watchers/events. Time is represented as a	2072	This class implements timer watchers/events. Time is represented as a
1615	fractional number of seconds since the epoch. Example:	2073	fractional number of seconds since the epoch. Example:
…		…
1619	->new	2077	->new
1620	->interval (1)	2078	->interval (1)
1621	->cb (sub {	2079	->cb (sub {
1622	$term->{overlay}->set (0, 0,	2080	$term->{overlay}->set (0, 0,
1623	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2081	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1624	});	2082	});
1625		2083
1626	=over 4	2084	=over 4
1627		2085
1628	=item $timer = new urxvt::timer	2086	=item $timer = new urxvt::timer
1629		2087
…		…
1632		2090
1633	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2091	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1634		2092
1635	Set the callback to be called when the timer triggers.	2093	Set the callback to be called when the timer triggers.
1636		2094
1637	=item $tstamp = $timer->at
1638
1639	Return the time this watcher will fire next.
1640
1641	=item $timer = $timer->set ($tstamp)	2095	=item $timer = $timer->set ($tstamp[, $interval])
1642		2096
1643	Set the time the event is generated to $tstamp.	2097	Set the time the event is generated to $tstamp (and optionally specifies a
		2098	new $interval).
1644		2099
1645	=item $timer = $timer->interval ($interval)	2100	=item $timer = $timer->interval ($interval)
1646		2101
1647	Normally (and when C<$interval> is C<0>), the timer will automatically	2102	By default (and when C<$interval> is C<0>), the timer will automatically
1648	stop after it has fired once. If C<$interval> is non-zero, then the timer	2103	stop after it has fired once. If C<$interval> is non-zero, then the timer
1649	is automatically rescheduled at the given intervals.	2104	is automatically rescheduled at the given intervals.
1650		2105
1651	=item $timer = $timer->start	2106	=item $timer = $timer->start
1652		2107
1653	Start the timer.	2108	Start the timer.
1654		2109
1655	=item $timer = $timer->start ($tstamp)	2110	=item $timer = $timer->start ($tstamp[, $interval])
1656		2111
1657	Set the event trigger time to C<$tstamp> and start the timer.	2112	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2113	also replaces the interval.
1658		2114
1659	=item $timer = $timer->after ($delay)	2115	=item $timer = $timer->after ($delay[, $interval])
1660		2116
1661	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2117	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1662		2118
1663	=item $timer = $timer->stop	2119	=item $timer = $timer->stop
1664		2120
…		…
1672		2128
1673	$term->{socket} = ...	2129	$term->{socket} = ...
1674	$term->{iow} = urxvt::iow	2130	$term->{iow} = urxvt::iow
1675	->new	2131	->new
1676	->fd (fileno $term->{socket})	2132	->fd (fileno $term->{socket})
1677	->events (urxvt::EVENT_READ)	2133	->events (urxvt::EV_READ)
1678	->start	2134	->start
1679	->cb (sub {	2135	->cb (sub {
1680	my ($iow, $revents) = @_;	2136	my ($iow, $revents) = @_;
1681	# $revents must be 1 here, no need to check	2137	# $revents must be 1 here, no need to check
1682	sysread $term->{socket}, my $buf, 8192	2138	sysread $term->{socket}, my $buf, 8192
…		…
1695	Set the callback to be called when io events are triggered. C<$reventmask>	2151	Set the callback to be called when io events are triggered. C<$reventmask>
1696	is a bitset as described in the C<events> method.	2152	is a bitset as described in the C<events> method.
1697		2153
1698	=item $iow = $iow->fd ($fd)	2154	=item $iow = $iow->fd ($fd)
1699		2155
1700	Set the filedescriptor (not handle) to watch.	2156	Set the file descriptor (not handle) to watch.
1701		2157
1702	=item $iow = $iow->events ($eventmask)	2158	=item $iow = $iow->events ($eventmask)
1703		2159
1704	Set the event mask to watch. The only allowed values are	2160	Set the event mask to watch. The only allowed values are
1705	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2161	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1706	together, or C<urxvt::EVENT_NONE>.	2162	together, or C<urxvt::EV_NONE>.
1707		2163
1708	=item $iow = $iow->start	2164	=item $iow = $iow->start
1709		2165
1710	Start watching for requested events on the given handle.	2166	Start watching for requested events on the given handle.
1711		2167
1712	=item $iow = $iow->stop	2168	=item $iow = $iow->stop
1713		2169
1714	Stop watching for events on the given filehandle.	2170	Stop watching for events on the given file handle.
		2171
		2172	=back
		2173
		2174	=head2 The C<urxvt::iw> Class
		2175
		2176	This class implements idle watchers, that get called automatically when
		2177	the process is idle. They should return as fast as possible, after doing
		2178	some useful work.
		2179
		2180	=over 4
		2181
		2182	=item $iw = new urxvt::iw
		2183
		2184	Create a new idle watcher object in stopped state.
		2185
		2186	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2187
		2188	Set the callback to be called when the watcher triggers.
		2189
		2190	=item $timer = $timer->start
		2191
		2192	Start the watcher.
		2193
		2194	=item $timer = $timer->stop
		2195
		2196	Stop the watcher.
		2197
		2198	=back
		2199
		2200	=head2 The C<urxvt::pw> Class
		2201
		2202	This class implements process watchers. They create an event whenever a
		2203	process exits, after which they stop automatically.
		2204
		2205	my $pid = fork;
		2206	...
		2207	$term->{pw} = urxvt::pw
		2208	->new
		2209	->start ($pid)
		2210	->cb (sub {
		2211	my ($pw, $exit_status) = @_;
		2212	...
		2213	});
		2214
		2215	=over 4
		2216
		2217	=item $pw = new urxvt::pw
		2218
		2219	Create a new process watcher in stopped state.
		2220
		2221	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2222
		2223	Set the callback to be called when the timer triggers.
		2224
		2225	=item $pw = $timer->start ($pid)
		2226
		2227	Tells the watcher to start watching for process C<$pid>.
		2228
		2229	=item $pw = $pw->stop
		2230
		2231	Stop the watcher.
1715		2232
1716	=back	2233	=back
1717		2234
1718	=head1 ENVIRONMENT	2235	=head1 ENVIRONMENT
1719		2236
…		…
1728		2245
1729	=item >= 3 - script loading and management	2246	=item >= 3 - script loading and management
1730		2247
1731	=item >=10 - all called hooks	2248	=item >=10 - all called hooks
1732		2249
1733	=item >=11 - hook reutrn values	2250	=item >=11 - hook return values
1734		2251
1735	=back	2252	=back
1736		2253
1737	=head1 AUTHOR	2254	=head1 AUTHOR
1738		2255
1739	Marc Lehmann <pcg@goof.com>	2256	Marc Lehmann <schmorp@schmorp.de>
1740	http://software.schmorp.de/pkg/rxvt-unicode	2257	http://software.schmorp.de/pkg/rxvt-unicode
1741		2258
1742	=cut	2259	=cut
1743		2260
1744	1	2261	1
		2262
		2263	# vim: sw=3:

Diff Legend

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