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

Diff Legend

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