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.91 by root, Fri Jan 13 01:09:37 2006 UTC vs.
Revision 1.172 by root, Fri Oct 10 00:21:15 2008 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 the following bindable keyboard command:	85	This extension also offers following bindable keyboard commands:
72		86
73	=over 4	87	=over 4
74		88
75	=item rot13	89	=item rot13
76		90
…		…
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.
		124
		125	Other extensions can extend this popup menu by pushing a code reference
		126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
		128
		129	Its sole argument is the popup menu, which can be modified. The selection
		130	is in C<$_>, which can be used to decide whether to add something or not.
		131	It should either return nothing or a string and a code reference. The
		132	string will be used as button text and the code reference will be called
		133	when the button gets activated and should transform C<$_>.
		134
		135	The following will add an entry C<a to b> that transforms all C<a>s in
		136	the selection to C<b>s, but only if the selection currently contains any
		137	C<a>s:
		138
		139	push @{ $self->{term}{selection_popup_hook} }, sub {
		140	/a/ ? ("a to b" => sub { s/a/b/g }
		141	: ()
		142	};
93		143
94	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
95		145
96	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
102	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>
103	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
104	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
105	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
106	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
107	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.
108		189
109	=item selection-autotransform	190	=item selection-autotransform
110		191
111	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	193	whenever a selection is made.
…		…
120		201
121	For example, the following will transform selections of the form	202	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename	203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:	204	$word>:
124		205
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		207
127	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
128	paste directly into your (vi :) editor:	209	paste directly into your (vi :) editor:
129		210
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		212
132	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 :)
133		214
134	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
135	FILENAME line YYY."), you need a slightly more elaborate solution:	216	FILENAME line YYY."), you need a slightly more elaborate solution:
136		217
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138	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/
139		220
140	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
141	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
142	the message into vi commands to load the file.	223	the message into vi commands to load the file.
143		224
144	=item mark-urls	225	=item tabbed
145		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
146	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
147	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
148	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
149	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).
150		307
151	=item block-graphics-to-ascii	308	=item block-graphics-to-ascii
152		309
153	A not very useful example of filtering all text output to the terminal,	310	A not very useful example of filtering all text output to the terminal
154	by replacing all line-drawing characters (U+2500 .. U+259F) by a	311	by replacing all line-drawing characters (U+2500 .. U+259F) by a
155	similar-looking ascii character.	312	similar-looking ascii character.
156		313
157	=item digital-clock	314	=item digital-clock
158		315
159	Displays a digital clock using the built-in overlay.	316	Displays a digital clock using the built-in overlay.
		317
		318	=item remote-clipboard
		319
		320	Somewhat of a misnomer, this extension adds two menu entries to the
		321	selection popup that allows one to run external commands to store the
		322	selection somewhere and fetch it again.
		323
		324	We use it to implement a "distributed selection mechanism", which just
		325	means that one command uploads the file to a remote server, and another
		326	reads it.
		327
		328	The commands can be set using the C<URxvt.remote-selection.store> and
		329	C<URxvt.remote-selection.fetch> resources. The first should read the
		330	selection to store from STDIN (always in UTF-8), the second should provide
		331	the selection data on STDOUT (also in UTF-8).
		332
		333	The defaults (which are likely useless to you) use rsh and cat:
		334
		335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		337
		338	=item selection-pastebin
		339
		340	This is a little rarely useful extension that Uploads the selection as
		341	textfile to a remote site (or does other things). (The implementation is
		342	not currently secure for use in a multiuser environment as it writes to
		343	F</tmp> directly.).
		344
		345	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		346	i.e.
		347
		348	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		349
		350	Pressing this combination runs a command with C<%> replaced by the name of
		351	the textfile. This command can be set via a resource:
		352
		353	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		354
		355	And the default is likely not useful to anybody but the few people around
		356	here :)
		357
		358	The name of the textfile is the hex encoded md5 sum of the selection, so
		359	the same content should lead to the same filename.
		360
		361	After a successful upload the selection will be replaced by the text given
		362	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		363	for the filename):
		364
		365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		366
		367	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		368	the double C</> characters as comment start. Use C<\057\057> instead,
		369	which works regardless of wether xrdb is used to parse the resource file
		370	or not.
160		371
161	=item example-refresh-hooks	372	=item example-refresh-hooks
162		373
163	Displays a very simple digital clock in the upper right corner of the	374	Displays a very simple digital clock in the upper right corner of the
164	window. Illustrates overwriting the refresh callbacks to create your own	375	window. Illustrates overwriting the refresh callbacks to create your own
…		…
204		415
205	=back	416	=back
206		417
207	=head2 Extension Objects	418	=head2 Extension Objects
208		419
209	Very perl extension is a perl class. A separate perl object is created	420	Every perl extension is a perl class. A separate perl object is created
210	for each terminal and each extension and passed as the first parameter to	421	for each terminal, and each terminal has its own set of extenion objects,
211	hooks. So extensions can use their C<$self> object without having to think	422	which are passed as the first parameter to hooks. So extensions can use
212	about other extensions, with the exception of methods and members that	423	their C<$self> object without having to think about clashes with other
		424	extensions or other terminals, with the exception of methods and members
213	begin with an underscore character C<_>: these are reserved for internal	425	that begin with an underscore character C<_>: these are reserved for
214	use.	426	internal use.
215		427
216	Although it isn't a C<urxvt::term> object, you can call all methods of the	428	Although it isn't a C<urxvt::term> object, you can call all methods of the
217	C<urxvt::term> class on this object.	429	C<urxvt::term> class on this object.
218		430
219	It has the following methods and data members:	431	It has the following methods and data members:
…		…
240	=head2 Hooks	452	=head2 Hooks
241		453
242	The following subroutines can be declared in extension files, and will be	454	The following subroutines can be declared in extension files, and will be
243	called whenever the relevant event happens.	455	called whenever the relevant event happens.
244		456
245	The first argument passed to them is an extension oject as described in	457	The first argument passed to them is an extension object as described in
246	the in the C<Extension Objects> section.	458	the in the C<Extension Objects> section.
247		459
248	B<All> of these hooks must return a boolean value. If it is true, then the	460	B<All> of these hooks must return a boolean value. If any of the called
249	event counts as being I<consumed>, and the invocation of other hooks is	461	hooks returns true, then the event counts as being I<consumed>, and the
250	skipped, and the relevant action might not be carried out by the C++ code.	462	relevant action might not be carried out by the C++ code.
251		463
252	I<< When in doubt, return a false value (preferably C<()>). >>	464	I<< When in doubt, return a false value (preferably C<()>). >>
253		465
254	=over 4	466	=over 4
255		467
256	=item on_init $term	468	=item on_init $term
257		469
258	Called after a new terminal object has been initialized, but before	470	Called after a new terminal object has been initialized, but before
259	windows are created or the command gets run. Most methods are unsafe to	471	windows are created or the command gets run. Most methods are unsafe to
260	call or deliver senseless data, as terminal size and other characteristics	472	call or deliver senseless data, as terminal size and other characteristics
261	have not yet been determined. You can safely query and change resources,	473	have not yet been determined. You can safely query and change resources
262	though.	474	and options, though. For many purposes the C<on_start> hook is a better
		475	place.
		476
		477	=item on_start $term
		478
		479	Called at the very end of initialisation of a new terminal, just before
		480	trying to map (display) the toplevel and returning to the main loop.
		481
		482	=item on_destroy $term
		483
		484	Called whenever something tries to destroy terminal, when the terminal is
		485	still fully functional (not for long, though).
263		486
264	=item on_reset $term	487	=item on_reset $term
265		488
266	Called after the screen is "reset" for any reason, such as resizing or	489	Called after the screen is "reset" for any reason, such as resizing or
267	control sequences. Here is where you can react on changes to size-related	490	control sequences. Here is where you can react on changes to size-related
268	variables.	491	variables.
269		492
270	=item on_start $term	493	=item on_child_start $term, $pid
271		494
272	Called at the very end of initialisation of a new terminal, just before	495	Called just after the child process has been C<fork>ed.
273	returning to the mainloop.	496
		497	=item on_child_exit $term, $status
		498
		499	Called just after the child process has exited. C<$status> is the status
		500	from C<waitpid>.
274		501
275	=item on_sel_make $term, $eventtime	502	=item on_sel_make $term, $eventtime
276		503
277	Called whenever a selection has been made by the user, but before the	504	Called whenever a selection has been made by the user, but before the
278	selection text is copied, so changes to the beginning, end or type of the	505	selection text is copied, so changes to the beginning, end or type of the
…		…
285		512
286	Called whenever a selection has been copied, but before the selection is	513	Called whenever a selection has been copied, but before the selection is
287	requested from the server. The selection text can be queried and changed	514	requested from the server. The selection text can be queried and changed
288	by calling C<< $term->selection >>.	515	by calling C<< $term->selection >>.
289		516
290	Returning a true value aborts selection grabbing. It will still be hilighted.	517	Returning a true value aborts selection grabbing. It will still be highlighted.
291		518
292	=item on_sel_extend $term	519	=item on_sel_extend $term
293		520
294	Called whenever the user tries to extend the selection (e.g. with a double	521	Called whenever the user tries to extend the selection (e.g. with a double
295	click) and is either supposed to return false (normal operation), or	522	click) and is either supposed to return false (normal operation), or
296	should extend the selection itelf and return true to suppress the built-in	523	should extend the selection itself and return true to suppress the built-in
297	processing. This can happen multiple times, as long as the callback	524	processing. This can happen multiple times, as long as the callback
298	returns true, it will be called on every further click by the user and is	525	returns true, it will be called on every further click by the user and is
299	supposed to enlarge the selection more and more, if possible.	526	supposed to enlarge the selection more and more, if possible.
300		527
301	See the F<selection> example extension.	528	See the F<selection> example extension.
302		529
303	=item on_view_change $term, $offset	530	=item on_view_change $term, $offset
304		531
305	Called whenever the view offset changes, i..e the user or program	532	Called whenever the view offset changes, i.e. the user or program
306	scrolls. Offset C<0> means display the normal terminal, positive values	533	scrolls. Offset C<0> means display the normal terminal, positive values
307	show this many lines of scrollback.	534	show this many lines of scrollback.
308		535
309	=item on_scroll_back $term, $lines, $saved	536	=item on_scroll_back $term, $lines, $saved
310		537
…		…
314		541
315	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	542	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
316	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	543	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
317	number of lines that will be in the scrollback buffer.	544	number of lines that will be in the scrollback buffer.
318		545
319	=item on_osc_seq $term, $string	546	=item on_osc_seq $term, $op, $args, $resp
		547
		548	Called on every OSC sequence and can be used to suppress it or modify its
		549	behaviour. The default should be to return an empty list. A true value
		550	suppresses execution of the request completely. Make sure you don't get
		551	confused by recursive invocations when you output an OSC sequence within
		552	this callback.
		553
		554	C<on_osc_seq_perl> should be used for new behaviour.
		555
		556	=item on_osc_seq_perl $term, $args, $resp
320		557
321	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
322	operating system command) is processed. Cursor position and other state	559	operating system command) is processed. Cursor position and other state
323	information is up-to-date when this happens. For interoperability, the	560	information is up-to-date when this happens. For interoperability, the
324	string should start with the extension name and a colon, to distinguish	561	string should start with the extension name (sans -osc) and a semicolon,
325	it from commands for other extensions, and this might be enforced in the	562	to distinguish it from commands for other extensions, and this might be
326	future.	563	enforced in the future.
		564
		565	For example, C<overlay-osc> uses this:
		566
		567	sub on_osc_seq_perl {
		568	my ($self, $osc, $resp) = @_;
		569
		570	return unless $osc =~ s/^overlay;//;
		571
		572	... process remaining $osc string
		573	}
327		574
328	Be careful not ever to trust (in a security sense) the data you receive,	575	Be careful not ever to trust (in a security sense) the data you receive,
329	as its source can not easily be controleld (e-mail content, messages from	576	as its source can not easily be controlled (e-mail content, messages from
330	other users on the same system etc.).	577	other users on the same system etc.).
		578
		579	For responses, C<$resp> contains the end-of-args separator used by the
		580	sender.
331		581
332	=item on_add_lines $term, $string	582	=item on_add_lines $term, $string
333		583
334	Called whenever text is about to be output, with the text as argument. You	584	Called whenever text is about to be output, with the text as argument. You
335	can filter/change and output the text yourself by returning a true value	585	can filter/change and output the text yourself by returning a true value
…		…
356	later with the already-modified line (e.g. if unrelated parts change), so	606	later with the already-modified line (e.g. if unrelated parts change), so
357	you cannot just toggle rendition bits, but only set them.	607	you cannot just toggle rendition bits, but only set them.
358		608
359	=item on_refresh_begin $term	609	=item on_refresh_begin $term
360		610
361	Called just before the screen gets redrawn. Can be used for overlay	611	Called just before the screen gets redrawn. Can be used for overlay or
362	or similar effects by modify terminal contents in refresh_begin, and	612	similar effects by modifying the terminal contents in refresh_begin, and
363	restoring them in refresh_end. The built-in overlay and selection display	613	restoring them in refresh_end. The built-in overlay and selection display
364	code is run after this hook, and takes precedence.	614	code is run after this hook, and takes precedence.
365		615
366	=item on_refresh_end $term	616	=item on_refresh_end $term
367		617
368	Called just after the screen gets redrawn. See C<on_refresh_begin>.	618	Called just after the screen gets redrawn. See C<on_refresh_begin>.
369		619
370	=item on_keyboard_command $term, $string	620	=item on_user_command $term, $string
371		621
372	Called whenever the user presses a key combination that has a	622	Called whenever a user-configured event is being activated (e.g. via
373	C<perl:string> action bound to it (see description of the B<keysym>	623	a C<perl:string> action bound to a key, see description of the B<keysym>
374	resource in the @@RXVT_NAME@@(1) manpage).	624	resource in the @@RXVT_NAME@@(1) manpage).
		625
		626	The event is simply the action string. This interface is assumed to change
		627	slightly in the future.
		628
		629	=item on_resize_all_windows $tern, $new_width, $new_height
		630
		631	Called just after the new window size has been calculated, but before
		632	windows are actually being resized or hints are being set. If this hook
		633	returns TRUE, setting of the window hints is being skipped.
		634
		635	=item on_x_event $term, $event
		636
		637	Called on every X event received on the vt window (and possibly other
		638	windows). Should only be used as a last resort. Most event structure
		639	members are not passed.
		640
		641	=item on_root_event $term, $event
		642
		643	Like C<on_x_event>, but is called for events on the root window.
375		644
376	=item on_focus_in $term	645	=item on_focus_in $term
377		646
378	Called whenever the window gets the keyboard focus, before rxvt-unicode	647	Called whenever the window gets the keyboard focus, before rxvt-unicode
379	does focus in processing.	648	does focus in processing.
380		649
381	=item on_focus_out $term	650	=item on_focus_out $term
382		651
383	Called wheneever the window loses keyboard focus, before rxvt-unicode does	652	Called whenever the window loses keyboard focus, before rxvt-unicode does
384	focus out processing.	653	focus out processing.
		654
		655	=item on_configure_notify $term, $event
		656
		657	=item on_property_notify $term, $event
385		658
386	=item on_key_press $term, $event, $keysym, $octets	659	=item on_key_press $term, $event, $keysym, $octets
387		660
388	=item on_key_release $term, $event, $keysym	661	=item on_key_release $term, $event, $keysym
389		662
…		…
399		672
400	Called whenever the corresponding X event is received for the terminal If	673	Called whenever the corresponding X event is received for the terminal If
401	the hook returns true, then the even will be ignored by rxvt-unicode.	674	the hook returns true, then the even will be ignored by rxvt-unicode.
402		675
403	The event is a hash with most values as named by Xlib (see the XEvent	676	The event is a hash with most values as named by Xlib (see the XEvent
404	manpage), with the additional members C<row> and C<col>, which are the row	677	manpage), with the additional members C<row> and C<col>, which are the
405	and column under the mouse cursor.	678	(real, not screen-based) row and column under the mouse cursor.
406		679
407	C<on_key_press> additionally receives the string rxvt-unicode would	680	C<on_key_press> additionally receives the string rxvt-unicode would
408	output, if any, in locale-specific encoding.	681	output, if any, in locale-specific encoding.
409		682
410	subwindow.	683	subwindow.
		684
		685	=item on_client_message $term, $event
		686
		687	=item on_wm_protocols $term, $event
		688
		689	=item on_wm_delete_window $term, $event
		690
		691	Called when various types of ClientMessage events are received (all with
		692	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
411		693
412	=back	694	=back
413		695
414	=cut	696	=cut
415		697
…		…
421	use Scalar::Util ();	703	use Scalar::Util ();
422	use List::Util ();	704	use List::Util ();
423		705
424	our $VERSION = 1;	706	our $VERSION = 1;
425	our $TERM;	707	our $TERM;
		708	our @TERM_INIT;
		709	our @TERM_EXT;
426	our @HOOKNAME;	710	our @HOOKNAME;
427	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	711	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
428	our %OPTION;	712	our %OPTION;
429		713
430	our $LIBDIR;	714	our $LIBDIR;
431	our $RESNAME;	715	our $RESNAME;
432	our $RESCLASS;	716	our $RESCLASS;
433	our $RXVTNAME;	717	our $RXVTNAME;
434		718
		719	our $NOCHAR = chr 0xffff;
		720
435	=head2 Variables in the C<urxvt> Package	721	=head2 Variables in the C<urxvt> Package
436		722
437	=over 4	723	=over 4
438		724
439	=item $urxvt::LIBDIR	725	=item $urxvt::LIBDIR
…		…
451		737
452	=item $urxvt::TERM	738	=item $urxvt::TERM
453		739
454	The current terminal. This variable stores the current C<urxvt::term>	740	The current terminal. This variable stores the current C<urxvt::term>
455	object, whenever a callback/hook is executing.	741	object, whenever a callback/hook is executing.
		742
		743	=item @urxvt::TERM_INIT
		744
		745	All code references in this array will be called as methods of the next newly
		746	created C<urxvt::term> object (during the C<on_init> phase). The array
		747	gets cleared before the code references that were in it are being executed,
		748	so references can push themselves onto it again if they so desire.
		749
		750	This complements to the perl-eval command line option, but gets executed
		751	first.
		752
		753	=item @urxvt::TERM_EXT
		754
		755	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		756	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		757	but before other extensions. Gets cleared just like C<@TERM_INIT>.
456		758
457	=back	759	=back
458		760
459	=head2 Functions in the C<urxvt> Package	761	=head2 Functions in the C<urxvt> Package
460		762
…		…
475	Using this function has the advantage that its output ends up in the	777	Using this function has the advantage that its output ends up in the
476	correct place, e.g. on stderr of the connecting urxvtc client.	778	correct place, e.g. on stderr of the connecting urxvtc client.
477		779
478	Messages have a size limit of 1023 bytes currently.	780	Messages have a size limit of 1023 bytes currently.
479		781
480	=item $is_safe = urxvt::safe	782	=item @terms = urxvt::termlist
481		783
482	Returns true when it is safe to do potentially unsafe things, such as	784	Returns all urxvt::term objects that exist in this process, regardless of
483	evaluating perl code specified by the user. This is true when urxvt was	785	whether they are started, being destroyed etc., so be careful. Only term
484	started setuid or setgid.	786	objects that have perl extensions attached will be returned (because there
		787	is no urxvt::term objet associated with others).
485		788
486	=item $time = urxvt::NOW	789	=item $time = urxvt::NOW
487		790
488	Returns the "current time" (as per the event loop).	791	Returns the "current time" (as per the event loop).
489		792
490	=item urxvt::CurrentTime	793	=item urxvt::CurrentTime
491		794
492	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	795	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
493	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	796	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
494	Button4Mask, Button5Mask, AnyModifier	797	Button4Mask, Button5Mask, AnyModifier
		798
		799	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		800	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		801	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		802	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		803	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		804	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		805	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		806
		807	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		808	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		809	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		810	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		811	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		812	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		813	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
495		814
496	Various constants for use in X calls and event processing.	815	Various constants for use in X calls and event processing.
497		816
498	=back	817	=back
499		818
…		…
532		851
533	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	852	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
534		853
535	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	854	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
536		855
		856	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		857
537	Replace the foreground/background colour in the rendition mask with the	858	Replace the foreground/background colour in the rendition mask with the
538	specified one.	859	specified one.
539		860
540	=item $value = urxvt::GET_CUSTOM $rend	861	=item $value = urxvt::GET_CUSTOM $rend
541		862
…		…
550	=back	871	=back
551		872
552	=cut	873	=cut
553		874
554	BEGIN {	875	BEGIN {
555	urxvt->bootstrap;
556
557	# overwrite perl's warn	876	# overwrite perl's warn
558	*CORE::GLOBAL::warn = sub {	877	*CORE::GLOBAL::warn = sub {
559	my $msg = join "", @_;	878	my $msg = join "", @_;
560	$msg .= "\n"	879	$msg .= "\n"
561	unless $msg =~ /\n$/;	880	unless $msg =~ /\n$/;
562	urxvt::warn ($msg);	881	urxvt::warn ($msg);
563	};	882	};
564
565	# %ENV is the original startup environment
566	delete $ENV{IFS};
567	delete $ENV{CDPATH};
568	delete $ENV{BASH_ENV};
569	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
570	}	883	}
571		884
572	my @hook_count;	885	no warnings 'utf8';
		886
573	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	887	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
574		888
575	sub verbose {	889	sub verbose {
576	my ($level, $msg) = @_;	890	my ($level, $msg) = @_;
577	warn "$msg\n" if $level <= $verbosity;	891	warn "$msg\n" if $level <= $verbosity;
578	}	892	}
579		893
580	my $extension_pkg = "extension0000";
581	my %extension_pkg;	894	my %extension_pkg;
582		895
583	# load a single script into its own package, once only	896	# load a single script into its own package, once only
584	sub extension_package($) {	897	sub extension_package($) {
585	my ($path) = @_;	898	my ($path) = @_;
586		899
587	$extension_pkg{$path} ||= do {	900	$extension_pkg{$path} ||= do {
588	my $pkg = "urxvt::" . ($extension_pkg++);	901	$path =~ /([^\/\\]+)$/;
		902	my $pkg = $1;
		903	$pkg =~ s/[^[:word:]]/_/g;
		904	$pkg = "urxvt::ext::$pkg";
589		905
590	verbose 3, "loading extension '$path' into package '$pkg'";	906	verbose 3, "loading extension '$path' into package '$pkg'";
591		907
592	open my $fh, "<:raw", $path	908	open my $fh, "<:raw", $path
593	or die "$path: $!";	909	or die "$path: $!";
594		910
595	my $source = untaint	911	my $source =
596	"package $pkg; use strict; use utf8;\n"	912	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
597	. "use base urxvt::term::extension::;\n"
598	. "#line 1 \"$path\"\n{\n"	913	. "#line 1 \"$path\"\n{\n"
599	. (do { local $/; <$fh> })	914	. (do { local $/; <$fh> })
600	. "\n};\n1";	915	. "\n};\n1";
601		916
602	eval $source	917	eval $source
…		…
613	local $TERM = shift;	928	local $TERM = shift;
614	my $htype = shift;	929	my $htype = shift;
615		930
616	if ($htype == 0) { # INIT	931	if ($htype == 0) { # INIT
617	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
618		933
619	my %ext_arg;	934	my %ext_arg;
620		935
		936	{
		937	my @init = @TERM_INIT;
		938	@TERM_INIT = ();
		939	$_->($TERM) for @init;
		940	my @pkg = @TERM_EXT;
		941	@TERM_EXT = ();
		942	$TERM->register_package ($_) for @pkg;
		943	}
		944
621	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	945	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
622	if ($_ eq "default") {	946	if ($_ eq "default") {
623	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	947	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
624	} elsif (/^-(.*)$/) {	948	} elsif (/^-(.*)$/) {
625	delete $ext_arg{$1};	949	delete $ext_arg{$1};
626	} elsif (/^([^<]+)<(.*)>$/) {	950	} elsif (/^([^<]+)<(.*)>$/) {
627	push @{ $ext_arg{$1} }, $2;	951	push @{ $ext_arg{$1} }, $2;
628	} else {	952	} else {
629	$ext_arg{$_} ||= [];	953	$ext_arg{$_} ||= [];
630	}	954	}
631	}	955	}
632		956
633	while (my ($ext, $argv) = each %ext_arg) {	957	for my $ext (sort keys %ext_arg) {
634	my @files = grep -f $_, map "$_/$ext", @dirs;	958	my @files = grep -f $_, map "$_/$ext", @dirs;
635		959
636	if (@files) {	960	if (@files) {
637	$TERM->register_package (extension_package $files[0], $argv);	961	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
638	} else {	962	} else {
639	warn "perl extension '$ext' not found in perl library search path\n";	963	warn "perl extension '$ext' not found in perl library search path\n";
640	}	964	}
641	}	965	}
642		966
…		…
648		972
649	if (my $cb = $TERM->{_hook}[$htype]) {	973	if (my $cb = $TERM->{_hook}[$htype]) {
650	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	974	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
651	if $verbosity >= 10;	975	if $verbosity >= 10;
652		976
653	keys %$cb;	977	for my $pkg (keys %$cb) {
654
655	while (my ($pkg, $cb) = each %$cb) {
656	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	978	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
657	and last;	979	$retval ||= $retval_;
658		980
659	if ($@) {	981	if ($@) {
660	$TERM->ungrab; # better to lose the grab than the session	982	$TERM->ungrab; # better to lose the grab than the session
661	warn $@;	983	warn $@;
662	}	984	}
…		…
665	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	987	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
666	if $verbosity >= 11;	988	if $verbosity >= 11;
667	}	989	}
668		990
669	if ($htype == 1) { # DESTROY	991	if ($htype == 1) { # DESTROY
670	if (my $hook = delete $TERM->{_hook}) {
671	for my $htype (0..$#$hook) {
672	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
673	or set_should_invoke $htype, 0;
674	}
675	}
676
677	# clear package objects	992	# clear package objects
678	%$_ = () for values %{ $TERM->{_pkg} };	993	%$_ = () for values %{ $TERM->{_pkg} };
679		994
680	# clear package	995	# clear package
681	%$TERM = ();	996	%$TERM = ();
682	}	997	}
683		998
684	$retval	999	$retval
685	}	1000	}
686		1001
687	sub exec_async(@) {	1002	sub SET_COLOR($$$) {
688	my $pid = fork;	1003	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1004	}
689		1005
690	return	1006	sub rend2mask {
691	if !defined $pid or $pid;	1007	no strict 'refs';
692		1008	my ($str, $mask) = (@_, 0);
693	%ENV = %{ $TERM->env };	1009	my %color = ( fg => undef, bg => undef );
694		1010	my @failed;
695	exec @_;	1011	for my $spec ( split /\s+/, $str ) {
696	_exit 255;	1012	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1013	$color{lc($1)} = $2;
		1014	} else {
		1015	my $neg = $spec =~ s/^[-^]//;
		1016	unless ( exists &{"RS_$spec"} ) {
		1017	push @failed, $spec;
		1018	next;
		1019	}
		1020	my $cur = &{"RS_$spec"};
		1021	if ( $neg ) {
		1022	$mask &= ~$cur;
		1023	} else {
		1024	$mask |= $cur;
		1025	}
		1026	}
		1027	}
		1028	($mask, @color{qw(fg bg)}, \@failed)
697	}	1029	}
698		1030
699	# urxvt::term::extension	1031	# urxvt::term::extension
700		1032
701	package urxvt::term::extension;	1033	package urxvt::term::extension;
…		…
707	while (my ($name, $cb) = each %hook) {	1039	while (my ($name, $cb) = each %hook) {
708	my $htype = $HOOKTYPE{uc $name};	1040	my $htype = $HOOKTYPE{uc $name};
709	defined $htype	1041	defined $htype
710	or Carp::croak "unsupported hook type '$name'";	1042	or Carp::croak "unsupported hook type '$name'";
711		1043
		1044	$self->set_should_invoke ($htype, +1)
712	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1045	unless exists $self->{term}{_hook}[$htype]{$pkg};
713	$hook_count[$htype]++
714	or urxvt::set_should_invoke $htype, 1;
715	}
716		1046
717	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1047	$self->{term}{_hook}[$htype]{$pkg} = $cb;
718	}	1048	}
719	}	1049	}
720		1050
…		…
725	for my $name (@hook) {	1055	for my $name (@hook) {
726	my $htype = $HOOKTYPE{uc $name};	1056	my $htype = $HOOKTYPE{uc $name};
727	defined $htype	1057	defined $htype
728	or Carp::croak "unsupported hook type '$name'";	1058	or Carp::croak "unsupported hook type '$name'";
729		1059
		1060	$self->set_should_invoke ($htype, -1)
730	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1061	if delete $self->{term}{_hook}[$htype]{$pkg};
731	--$hook_count[$htype]
732	or urxvt::set_should_invoke $htype, 0;
733	}
734	}	1062	}
735	}	1063	}
736		1064
737	our $AUTOLOAD;	1065	our $AUTOLOAD;
738		1066
…		…
776	is that you cannot use blocking APIs, but the non-blocking variant should	1104	is that you cannot use blocking APIs, but the non-blocking variant should
777	work.	1105	work.
778		1106
779	=cut	1107	=cut
780		1108
781	our $VERSION = 1;	1109	our $VERSION = '3.4';
782		1110
783	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
784	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
785		1113
786	sub timer {	1114	sub timer {
…		…
817		1145
818	sub DESTROY {	1146	sub DESTROY {
819	$_[0][1]->stop;	1147	$_[0][1]->stop;
820	}	1148	}
821		1149
822	sub condvar {	1150	sub one_event {
823	bless \my $flag, urxvt::anyevent::condvar::
824	}
825
826	sub urxvt::anyevent::condvar::broadcast {
827	${$_[0]}++;
828	}
829
830	sub urxvt::anyevent::condvar::wait {
831	unless (${$_[0]}) {
832	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1151	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
833	}
834	}	1152	}
835		1153
836	package urxvt::term;	1154	package urxvt::term;
837		1155
838	=head2 The C<urxvt::term> Class	1156	=head2 The C<urxvt::term> Class
…		…
843		1161
844	# find on_xxx subs in the package and register them	1162	# find on_xxx subs in the package and register them
845	# as hooks	1163	# as hooks
846	sub register_package {	1164	sub register_package {
847	my ($self, $pkg, $argv) = @_;	1165	my ($self, $pkg, $argv) = @_;
		1166
		1167	no strict 'refs';
		1168
		1169	urxvt::verbose 6, "register package $pkg to $self";
		1170
		1171	@{"$pkg\::ISA"} = urxvt::term::extension::;
848		1172
849	my $proxy = bless {	1173	my $proxy = bless {
850	_pkg => $pkg,	1174	_pkg => $pkg,
851	argv => $argv,	1175	argv => $argv,
852	}, $pkg;	1176	}, $pkg;
…		…
868	hash which defines the environment of the new terminal.	1192	hash which defines the environment of the new terminal.
869		1193
870	Croaks (and probably outputs an error message) if the new instance	1194	Croaks (and probably outputs an error message) if the new instance
871	couldn't be created. Returns C<undef> if the new instance didn't	1195	couldn't be created. Returns C<undef> if the new instance didn't
872	initialise perl, and the terminal object otherwise. The C<init> and	1196	initialise perl, and the terminal object otherwise. The C<init> and
873	C<start> hooks will be called during this call.	1197	C<start> hooks will be called before this call returns, and are free to
		1198	refer to global data (which is race free).
874		1199
875	=cut	1200	=cut
876		1201
877	sub new {	1202	sub new {
878	my ($class, $env, @args) = @_;	1203	my ($class, $env, @args) = @_;
879		1204
		1205	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1206	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1207
880	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1208	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
881	}	1209	}
882		1210
883	=item $term->destroy	1211	=item $term->destroy
884		1212
885	Destroy the terminal object (close the window, free resources	1213	Destroy the terminal object (close the window, free resources
886	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1214	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
887	watchers (timers, io watchers) are still active.	1215	watchers (timers, io watchers) are still active.
888		1216
		1217	=item $term->exec_async ($cmd[, @args])
		1218
		1219	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1220	("starts") programs in the background. This function takes care of setting
		1221	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1222	be preferred over explicit calls to C<exec> or C<system>.
		1223
		1224	Returns the pid of the subprocess or C<undef> on error.
		1225
		1226	=cut
		1227
		1228	sub exec_async {
		1229	my $self = shift;
		1230
		1231	my $pid = fork;
		1232
		1233	return $pid
		1234	if !defined $pid or $pid;
		1235
		1236	%ENV = %{ $self->env };
		1237
		1238	exec @_;
		1239	urxvt::_exit 255;
		1240	}
		1241
889	=item $isset = $term->option ($optval[, $set])	1242	=item $isset = $term->option ($optval[, $set])
890		1243
891	Returns true if the option specified by C<$optval> is enabled, and	1244	Returns true if the option specified by C<$optval> is enabled, and
892	optionally change it. All option values are stored by name in the hash	1245	optionally change it. All option values are stored by name in the hash
893	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1246	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
894		1247
895	Here is a a likely non-exhaustive list of option names, please see the	1248	Here is a likely non-exhaustive list of option names, please see the
896	source file F</src/optinc.h> to see the actual list:	1249	source file F</src/optinc.h> to see the actual list:
897		1250
898	borderLess console cursorBlink cursorUnderline hold iconic insecure	1251	borderLess console cursorBlink cursorUnderline hold iconic insecure
899	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1252	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
900	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1253	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
901	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1254	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
902	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1255	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
903	tripleclickwords utmpInhibit visualBell	1256	transparent tripleclickwords utmpInhibit visualBell
904		1257
905	=item $value = $term->resource ($name[, $newval])	1258	=item $value = $term->resource ($name[, $newval])
906		1259
907	Returns the current resource value associated with a given name and	1260	Returns the current resource value associated with a given name and
908	optionally sets a new value. Setting values is most useful in the C<init>	1261	optionally sets a new value. Setting values is most useful in the C<init>
…		…
917	likely change).	1270	likely change).
918		1271
919	Please note that resource strings will currently only be freed when the	1272	Please note that resource strings will currently only be freed when the
920	terminal is destroyed, so changing options frequently will eat memory.	1273	terminal is destroyed, so changing options frequently will eat memory.
921		1274
922	Here is a a likely non-exhaustive list of resource names, not all of which	1275	Here is a likely non-exhaustive list of resource names, not all of which
923	are supported in every build, please see the source file F</src/rsinc.h>	1276	are supported in every build, please see the source file F</src/rsinc.h>
924	to see the actual list:	1277	to see the actual list:
925		1278
926	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1279	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
927	borderLess color cursorBlink cursorUnderline cutchars delete_key	1280	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
928	display_name embed ext_bwidth fade font geometry hold iconName	1281	display_name embed ext_bwidth fade font geometry hold iconName
929	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1282	imFont imLocale inputMethod insecure int_bwidth intensityStyles
930	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1283	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
931	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1284	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
932	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1285	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
933	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1286	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
934	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1287	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
935	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1288	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
936	shade term_name title transparent transparent_all tripleclickwords	1289	secondaryScreen secondaryScroll shade term_name title
937	utmpInhibit visualBell	1290	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1291	visualBell
938		1292
939	=cut	1293	=cut
940		1294
941	sub resource($$;$) {	1295	sub resource($$;$) {
942	my ($self, $name) = (shift, shift);	1296	my ($self, $name) = (shift, shift);
943	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1297	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
944	&urxvt::term::_resource	1298	goto &urxvt::term::_resource
945	}	1299	}
946		1300
947	=item $value = $term->x_resource ($pattern)	1301	=item $value = $term->x_resource ($pattern)
948		1302
949	Returns the X-Resource for the given pattern, excluding the program or	1303	Returns the X-Resource for the given pattern, excluding the program or
…		…
1032		1386
1033	The methods currently supported on C<urxvt::overlay> objects are:	1387	The methods currently supported on C<urxvt::overlay> objects are:
1034		1388
1035	=over 4	1389	=over 4
1036		1390
1037	=item $overlay->set ($x, $y, $text, $rend)	1391	=item $overlay->set ($x, $y, $text[, $rend])
1038		1392
1039	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1393	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1040	text in rxvt-unicode's special encoding and an array of rendition values	1394	text in rxvt-unicode's special encoding and an array of rendition values
1041	at a specific position inside the overlay.	1395	at a specific position inside the overlay.
		1396
		1397	If C<$rend> is missing, then the rendition will not be changed.
1042		1398
1043	=item $overlay->hide	1399	=item $overlay->hide
1044		1400
1045	If visible, hide the overlay, but do not destroy it.	1401	If visible, hide the overlay, but do not destroy it.
1046		1402
…		…
1116		1472
1117	Normally its not a good idea to use this function, as programs might be	1473	Normally its not a good idea to use this function, as programs might be
1118	confused by changes in cursor position or scrolling. Its useful inside a	1474	confused by changes in cursor position or scrolling. Its useful inside a
1119	C<on_add_lines> hook, though.	1475	C<on_add_lines> hook, though.
1120		1476
		1477	=item $term->scr_change_screen ($screen)
		1478
		1479	Switch to given screen - 0 primary, 1 secondary.
		1480
1121	=item $term->cmd_parse ($octets)	1481	=item $term->cmd_parse ($octets)
1122		1482
1123	Similar to C<scr_add_lines>, but the argument must be in the	1483	Similar to C<scr_add_lines>, but the argument must be in the
1124	locale-specific encoding of the terminal and can contain command sequences	1484	locale-specific encoding of the terminal and can contain command sequences
1125	(escape codes) that will be interpreted.	1485	(escape codes) that will be interpreted.
…		…
1135	Replaces the event mask of the pty watcher by the given event mask. Can	1495	Replaces the event mask of the pty watcher by the given event mask. Can
1136	be used to suppress input and output handling to the pty/tty. See the	1496	be used to suppress input and output handling to the pty/tty. See the
1137	description of C<< urxvt::timer->events >>. Make sure to always restore	1497	description of C<< urxvt::timer->events >>. Make sure to always restore
1138	the previous value.	1498	the previous value.
1139		1499
		1500	=item $fd = $term->pty_fd
		1501
		1502	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1503	is used.
		1504
1140	=item $windowid = $term->parent	1505	=item $windowid = $term->parent
1141		1506
1142	Return the window id of the toplevel window.	1507	Return the window id of the toplevel window.
1143		1508
1144	=item $windowid = $term->vt	1509	=item $windowid = $term->vt
1145		1510
1146	Return the window id of the terminal window.	1511	Return the window id of the terminal window.
1147		1512
		1513	=item $term->vt_emask_add ($x_event_mask)
		1514
		1515	Adds the specified events to the vt event mask. Useful e.g. when you want
		1516	to receive pointer events all the times:
		1517
		1518	$term->vt_emask_add (urxvt::PointerMotionMask);
		1519
		1520	=item $term->focus_in
		1521
		1522	=item $term->focus_out
		1523
		1524	=item $term->key_press ($state, $keycode[, $time])
		1525
		1526	=item $term->key_release ($state, $keycode[, $time])
		1527
		1528	Deliver various fake events to to terminal.
		1529
1148	=item $window_width = $term->width	1530	=item $window_width = $term->width
1149		1531
1150	=item $window_height = $term->height	1532	=item $window_height = $term->height
1151		1533
1152	=item $font_width = $term->fwidth	1534	=item $font_width = $term->fwidth
…		…
1165		1547
1166	=item $max_scrollback = $term->saveLines	1548	=item $max_scrollback = $term->saveLines
1167		1549
1168	=item $nrow_plus_saveLines = $term->total_rows	1550	=item $nrow_plus_saveLines = $term->total_rows
1169		1551
1170	=item $lines_in_scrollback = $term->nsaved	1552	=item $topmost_scrollback_row = $term->top_row
1171		1553
1172	Return various integers describing terminal characteristics.	1554	Return various integers describing terminal characteristics.
1173		1555
1174	=item $x_display = $term->display_id	1556	=item $x_display = $term->display_id
1175		1557
…		…
1182	=item $env = $term->env	1564	=item $env = $term->env
1183		1565
1184	Returns a copy of the environment in effect for the terminal as a hashref	1566	Returns a copy of the environment in effect for the terminal as a hashref
1185	similar to C<\%ENV>.	1567	similar to C<\%ENV>.
1186		1568
		1569	=item @envv = $term->envv
		1570
		1571	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1572
		1573	=item @argv = $term->argv
		1574
		1575	Return the argument vector as this terminal, similar to @ARGV, but
		1576	includes the program name as first element.
		1577
1187	=cut	1578	=cut
1188		1579
1189	sub env {	1580	sub env {
1190	if (my $env = $_[0]->_env) {
1191	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1581	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1192	} else {
1193	+{ %ENV }
1194	}
1195	}	1582	}
1196		1583
1197	=item $modifiermask = $term->ModLevel3Mask	1584	=item $modifiermask = $term->ModLevel3Mask
1198		1585
1199	=item $modifiermask = $term->ModMetaMask	1586	=item $modifiermask = $term->ModMetaMask
…		…
1201	=item $modifiermask = $term->ModNumLockMask	1588	=item $modifiermask = $term->ModNumLockMask
1202		1589
1203	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1590	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1204	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1591	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1205		1592
		1593	=item $screen = $term->current_screen
		1594
		1595	Returns the currently displayed screen (0 primary, 1 secondary).
		1596
		1597	=item $cursor_is_hidden = $term->hidden_cursor
		1598
		1599	Returns whether the cursor is currently hidden or not.
		1600
1206	=item $view_start = $term->view_start ([$newvalue])	1601	=item $view_start = $term->view_start ([$newvalue])
1207		1602
1208	Returns the negative row number of the topmost line. Minimum value is	1603	Returns the row number of the topmost displayed line. Maximum value is
1209	C<0>, which displays the normal terminal contents. Larger values scroll	1604	C<0>, which displays the normal terminal contents. Lower values scroll
1210	this many lines into the scrollback buffer.	1605	this many lines into the scrollback buffer.
1211		1606
1212	=item $term->want_refresh	1607	=item $term->want_refresh
1213		1608
1214	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1609	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1217		1612
1218	Used after changing terminal contents to display them.	1613	Used after changing terminal contents to display them.
1219		1614
1220	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1615	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1221		1616
1222	Returns the text of the entire row with number C<$row_number>. Row C<0>	1617	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1223	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1618	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1224	terminal line. The scrollback buffer starts at line C<-1> and extends to
1225	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1619	terminal line. Nothing will be returned if a nonexistent line
1226	is requested.	1620	is requested.
1227		1621
1228	If C<$new_text> is specified, it will replace characters in the current	1622	If C<$new_text> is specified, it will replace characters in the current
1229	line, starting at column C<$start_col> (default C<0>), which is useful	1623	line, starting at column C<$start_col> (default C<0>), which is useful
1230	to replace only parts of a line. The font index in the rendition will	1624	to replace only parts of a line. The font index in the rendition will
1231	automatically be updated.	1625	automatically be updated.
1232		1626
1233	C<$text> is in a special encoding: tabs and wide characters that use more	1627	C<$text> is in a special encoding: tabs and wide characters that use more
1234	than one cell when displayed are padded with urxvt::NOCHAR characters	1628	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1235	(C<chr 65535>). Characters with combining characters and other characters	1629	characters. Characters with combining characters and other characters that
1236	that do not fit into the normal tetx encoding will be replaced with	1630	do not fit into the normal text encoding will be replaced with characters
1237	characters in the private use area.	1631	in the private use area.
1238		1632
1239	You have to obey this encoding when changing text. The advantage is	1633	You have to obey this encoding when changing text. The advantage is
1240	that C<substr> and similar functions work on screen cells and not on	1634	that C<substr> and similar functions work on screen cells and not on
1241	characters.	1635	characters.
1242		1636
…		…
1386	where one character corresponds to one screen cell. See	1780	where one character corresponds to one screen cell. See
1387	C<< $term->ROW_t >> for details.	1781	C<< $term->ROW_t >> for details.
1388		1782
1389	=item $string = $term->special_decode $text	1783	=item $string = $term->special_decode $text
1390		1784
1391	Converts rxvt-unicodes text reprsentation into a perl string. See	1785	Converts rxvt-unicodes text representation into a perl string. See
1392	C<< $term->ROW_t >> for details.	1786	C<< $term->ROW_t >> for details.
1393		1787
1394	=item $success = $term->grab_button ($button, $modifiermask)	1788	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1395		1789
		1790	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1791
1396	Registers a synchronous button grab. See the XGrabButton manpage.	1792	Register/unregister a synchronous button grab. See the XGrabButton
		1793	manpage.
1397		1794
1398	=item $success = $term->grab ($eventtime[, $sync])	1795	=item $success = $term->grab ($eventtime[, $sync])
1399		1796
1400	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1797	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1401	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1798	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1402		1799
1403	=item $term->allow_events_async	1800	=item $term->allow_events_async
1404		1801
1405	Calls XAllowEvents with AsyncBoth for the most recent grab.	1802	Calls XAllowEvents with AsyncBoth for the most recent grab.
1406		1803
…		…
1416	=item $term->ungrab	1813	=item $term->ungrab
1417		1814
1418	Calls XUngrab for the most recent grab. Is called automatically on	1815	Calls XUngrab for the most recent grab. Is called automatically on
1419	evaluation errors, as it is better to lose the grab in the error case as	1816	evaluation errors, as it is better to lose the grab in the error case as
1420	the session.	1817	the session.
		1818
		1819	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1820
		1821	=item $atom_name = $term->XGetAtomName ($atom)
		1822
		1823	=item @atoms = $term->XListProperties ($window)
		1824
		1825	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1826
		1827	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1828
		1829	=item $term->XDeleteProperty ($window, $property)
		1830
		1831	=item $window = $term->DefaultRootWindow
		1832
		1833	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1834
		1835	=item $term->XMapWindow ($window)
		1836
		1837	=item $term->XUnmapWindow ($window)
		1838
		1839	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1840
		1841	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1842
		1843	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1844
		1845	Various X or X-related functions. The C<$term> object only serves as
		1846	the source of the display, otherwise those functions map more-or-less
		1847	directory onto the X functions of the same name.
1421		1848
1422	=back	1849	=back
1423		1850
1424	=cut	1851	=cut
1425		1852
…		…
1489	my ($self, $text, $cb) = @_;	1916	my ($self, $text, $cb) = @_;
1490		1917
1491	$self->add_item ({ type => "button", text => $text, activate => $cb});	1918	$self->add_item ({ type => "button", text => $text, activate => $cb});
1492	}	1919	}
1493		1920
1494	=item $popup->add_toggle ($text, $cb, $initial_value)	1921	=item $popup->add_toggle ($text, $initial_value, $cb)
1495		1922
1496	Adds a toggle/checkbox item to the popup. Teh callback gets called	1923	Adds a toggle/checkbox item to the popup. The callback gets called
1497	whenever it gets toggled, with a boolean indicating its value as its first	1924	whenever it gets toggled, with a boolean indicating its new value as its
1498	argument.	1925	first argument.
1499		1926
1500	=cut	1927	=cut
1501		1928
1502	sub add_toggle {	1929	sub add_toggle {
1503	my ($self, $text, $cb, $value) = @_;	1930	my ($self, $text, $value, $cb) = @_;
1504		1931
1505	my $item; $item = {	1932	my $item; $item = {
1506	type => "button",	1933	type => "button",
1507	text => " $text",	1934	text => " $text",
1508	value => $value,	1935	value => $value,
…		…
1527	my $env = $self->{term}->env;	1954	my $env = $self->{term}->env;
1528	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1955	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1529	delete $env->{LC_ALL};	1956	delete $env->{LC_ALL};
1530	$env->{LC_CTYPE} = $self->{term}->locale;	1957	$env->{LC_CTYPE} = $self->{term}->locale;
1531		1958
1532	urxvt::term->new ($env, $self->{term}->resource ("name"),	1959	my $term = urxvt::term->new (
1533	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1960	$env, "popup",
		1961	"--perl-lib" => "", "--perl-ext-common" => "",
		1962	"-pty-fd" => -1, "-sl" => 0,
		1963	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1534	"--transient-for" => $self->{term}->parent,	1964	"--transient-for" => $self->{term}->parent,
1535	"-display" => $self->{term}->display_id,	1965	"-display" => $self->{term}->display_id,
1536	"-pe" => "urxvt-popup")	1966	"-pe" => "urxvt-popup",
1537	or die "unable to create popup window\n";	1967	) or die "unable to create popup window\n";
		1968
		1969	unless (delete $term->{urxvt_popup_init_done}) {
		1970	$term->ungrab;
		1971	$term->destroy;
		1972	die "unable to initialise popup window\n";
		1973	}
1538	}	1974	}
1539		1975
1540	sub DESTROY {	1976	sub DESTROY {
1541	my ($self) = @_;	1977	my ($self) = @_;
1542		1978
1543	delete $self->{term}{_destroy}{$self};	1979	delete $self->{term}{_destroy}{$self};
1544	$self->{term}->ungrab;	1980	$self->{term}->ungrab;
1545	}	1981	}
1546		1982
1547	=back	1983	=back
		1984
		1985	=cut
		1986
		1987	package urxvt::watcher;
1548		1988
1549	=head2 The C<urxvt::timer> Class	1989	=head2 The C<urxvt::timer> Class
1550		1990
1551	This class implements timer watchers/events. Time is represented as a	1991	This class implements timer watchers/events. Time is represented as a
1552	fractional number of seconds since the epoch. Example:	1992	fractional number of seconds since the epoch. Example:
…		…
1556	->new	1996	->new
1557	->interval (1)	1997	->interval (1)
1558	->cb (sub {	1998	->cb (sub {
1559	$term->{overlay}->set (0, 0,	1999	$term->{overlay}->set (0, 0,
1560	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2000	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1561	});	2001	});
1562		2002
1563	=over 4	2003	=over 4
1564		2004
1565	=item $timer = new urxvt::timer	2005	=item $timer = new urxvt::timer
1566		2006
…		…
1590	Start the timer.	2030	Start the timer.
1591		2031
1592	=item $timer = $timer->start ($tstamp)	2032	=item $timer = $timer->start ($tstamp)
1593		2033
1594	Set the event trigger time to C<$tstamp> and start the timer.	2034	Set the event trigger time to C<$tstamp> and start the timer.
		2035
		2036	=item $timer = $timer->after ($delay)
		2037
		2038	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1595		2039
1596	=item $timer = $timer->stop	2040	=item $timer = $timer->stop
1597		2041
1598	Stop the timer.	2042	Stop the timer.
1599		2043
…		…
1605		2049
1606	$term->{socket} = ...	2050	$term->{socket} = ...
1607	$term->{iow} = urxvt::iow	2051	$term->{iow} = urxvt::iow
1608	->new	2052	->new
1609	->fd (fileno $term->{socket})	2053	->fd (fileno $term->{socket})
1610	->events (urxvt::EVENT_READ)	2054	->events (urxvt::EV_READ)
1611	->start	2055	->start
1612	->cb (sub {	2056	->cb (sub {
1613	my ($iow, $revents) = @_;	2057	my ($iow, $revents) = @_;
1614	# $revents must be 1 here, no need to check	2058	# $revents must be 1 here, no need to check
1615	sysread $term->{socket}, my $buf, 8192	2059	sysread $term->{socket}, my $buf, 8192
…		…
1628	Set the callback to be called when io events are triggered. C<$reventmask>	2072	Set the callback to be called when io events are triggered. C<$reventmask>
1629	is a bitset as described in the C<events> method.	2073	is a bitset as described in the C<events> method.
1630		2074
1631	=item $iow = $iow->fd ($fd)	2075	=item $iow = $iow->fd ($fd)
1632		2076
1633	Set the filedescriptor (not handle) to watch.	2077	Set the file descriptor (not handle) to watch.
1634		2078
1635	=item $iow = $iow->events ($eventmask)	2079	=item $iow = $iow->events ($eventmask)
1636		2080
1637	Set the event mask to watch. The only allowed values are	2081	Set the event mask to watch. The only allowed values are
1638	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2082	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1639	together, or C<urxvt::EVENT_NONE>.	2083	together, or C<urxvt::EV_NONE>.
1640		2084
1641	=item $iow = $iow->start	2085	=item $iow = $iow->start
1642		2086
1643	Start watching for requested events on the given handle.	2087	Start watching for requested events on the given handle.
1644		2088
1645	=item $iow = $iow->stop	2089	=item $iow = $iow->stop
1646		2090
1647	Stop watching for events on the given filehandle.	2091	Stop watching for events on the given file handle.
		2092
		2093	=back
		2094
		2095	=head2 The C<urxvt::iw> Class
		2096
		2097	This class implements idle watchers, that get called automatically when
		2098	the process is idle. They should return as fast as possible, after doing
		2099	some useful work.
		2100
		2101	=over 4
		2102
		2103	=item $iw = new urxvt::iw
		2104
		2105	Create a new idle watcher object in stopped state.
		2106
		2107	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2108
		2109	Set the callback to be called when the watcher triggers.
		2110
		2111	=item $timer = $timer->start
		2112
		2113	Start the watcher.
		2114
		2115	=item $timer = $timer->stop
		2116
		2117	Stop the watcher.
		2118
		2119	=back
		2120
		2121	=head2 The C<urxvt::pw> Class
		2122
		2123	This class implements process watchers. They create an event whenever a
		2124	process exits, after which they stop automatically.
		2125
		2126	my $pid = fork;
		2127	...
		2128	$term->{pw} = urxvt::pw
		2129	->new
		2130	->start ($pid)
		2131	->cb (sub {
		2132	my ($pw, $exit_status) = @_;
		2133	...
		2134	});
		2135
		2136	=over 4
		2137
		2138	=item $pw = new urxvt::pw
		2139
		2140	Create a new process watcher in stopped state.
		2141
		2142	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2143
		2144	Set the callback to be called when the timer triggers.
		2145
		2146	=item $pw = $timer->start ($pid)
		2147
		2148	Tells the watcher to start watching for process C<$pid>.
		2149
		2150	=item $pw = $pw->stop
		2151
		2152	Stop the watcher.
1648		2153
1649	=back	2154	=back
1650		2155
1651	=head1 ENVIRONMENT	2156	=head1 ENVIRONMENT
1652		2157
…		…
1661		2166
1662	=item >= 3 - script loading and management	2167	=item >= 3 - script loading and management
1663		2168
1664	=item >=10 - all called hooks	2169	=item >=10 - all called hooks
1665		2170
1666	=item >=11 - hook reutrn values	2171	=item >=11 - hook return values
1667		2172
1668	=back	2173	=back
1669		2174
1670	=head1 AUTHOR	2175	=head1 AUTHOR
1671		2176
…		…
1673	http://software.schmorp.de/pkg/rxvt-unicode	2178	http://software.schmorp.de/pkg/rxvt-unicode
1674		2179
1675	=cut	2180	=cut
1676		2181
1677	1	2182	1
		2183
		2184	# vim: sw=3:

Diff Legend

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