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.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.175 by root, Sat May 30 08:51:23 2009 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
…		…
48	C<--quoting-style=shell>.	55	C<--quoting-style=shell>.
49		56
50	A double-click usually selects the word under the cursor, further clicks	57	A double-click usually selects the word under the cursor, further clicks
51	will enlarge the selection.	58	will enlarge the selection.
52		59
		60	The selection works by trying to match a number of regexes and displaying
		61	them in increasing order of length. You can add your own regexes by
		62	specifying resources of the form:
		63
		64	URxvt.selection.pattern-0: perl-regex
		65	URxvt.selection.pattern-1: perl-regex
		66	...
		67
		68	The index number (0, 1...) must not have any holes, and each regex must
		69	contain at least one pair of capturing parentheses, which will be used for
		70	the match. For example, the following adds a regex that matches everything
		71	between two vertical bars:
		72
		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: ^(/[^:]+):\
		81
		82	You can look at the source of the selection extension to see more
		83	interesting uses, such as parsing a line from beginning to end.
		84
53	It also offers the following bindable keyboard command:	85	This extension also offers following bindable keyboard commands:
54		86
55	=over 4	87	=over 4
56		88
57	=item rot13	89	=item rot13
58		90
…		…
65	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
66		98
67	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
68	runtime.	100	runtime.
69		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
70	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
71		120
72	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
73	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
74	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	};
75		143
76	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
77		145
78	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
79	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
…		…
84	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>
85	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
86	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
87	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
88	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
89	selection.	157	selection if the C<Shift> modifier is active.
90		158
91	=item digital-clock	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.
92		162
93	Displays a digital clock using the built-in overlay.	163	See L<perlre> for more info about perl regular expression syntax.
94		164
95	=item mark-urls	165	=item readline (enabled by default)
96		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.
		189
		190	=item selection-autotransform
		191
		192	This selection allows you to do automatic transforms on a selection
		193	whenever a selection is made.
		194
		195	It works by specifying perl snippets (most useful is a single C<s///>
		196	operator) that modify C<$_> as resources:
		197
		198	URxvt.selection-autotransform.0: transform
		199	URxvt.selection-autotransform.1: transform
		200	...
		201
		202	For example, the following will transform selections of the form
		203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		204	$word>:
		205
		206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		207
		208	And this example matches the same,but replaces it with vi-commands you can
		209	paste directly into your (vi :) editor:
		210
		211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		212
		213	Of course, this can be modified to suit your needs and your editor :)
		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
97	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
98	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
99	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
100	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.
101		313
102	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
103		315
104	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
105	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
106	similar-looking ascii character.	318	similar-looking ascii character.
		319
		320	=item digital-clock
		321
		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.
		377
		378	=item macosx-pastebin and macosx-pastebin-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<maxosx-pastebin> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
107		391
108	=item example-refresh-hooks	392	=item example-refresh-hooks
109		393
110	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
111	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
151		435
152	=back	436	=back
153		437
154	=head2 Extension Objects	438	=head2 Extension Objects
155		439
156	Very perl extension is a perl class. A separate perl object is created	440	Every perl extension is a perl class. A separate perl object is created
157	for each terminal and each extension and passed as the first parameter to	441	for each terminal, and each terminal has its own set of extenion objects,
158	hooks. So extensions can use their C<$self> object without having to think	442	which are passed as the first parameter to hooks. So extensions can use
159	about other extensions, with the exception of methods and members that	443	their C<$self> object without having to think about clashes with other
		444	extensions or other terminals, with the exception of methods and members
160	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
161	use.	446	internal use.
162		447
163	Although it isn't a C<urxvt::term> object, you can call all methods of the	448	Although it isn't a C<urxvt::term> object, you can call all methods of the
164	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
165		450
166	It has the following methods and data members:	451	It has the following methods and data members:
…		…
187	=head2 Hooks	472	=head2 Hooks
188		473
189	The following subroutines can be declared in extension files, and will be	474	The following subroutines can be declared in extension files, and will be
190	called whenever the relevant event happens.	475	called whenever the relevant event happens.
191		476
192	The first argument passed to them is an extension oject as described in	477	The first argument passed to them is an extension object as described in
193	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
194		479
195	B<All> of these hooks must return a boolean value. If it is true, then the	480	B<All> of these hooks must return a boolean value. If any of the called
196	event counts as being I<consumed>, and the invocation of other hooks is	481	hooks returns true, then the event counts as being I<consumed>, and the
197	skipped, and the relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
198		483
199	I<< When in doubt, return a false value (preferably C<()>). >>	484	I<< When in doubt, return a false value (preferably C<()>). >>
200		485
201	=over 4	486	=over 4
202		487
203	=item on_init $term	488	=item on_init $term
204		489
205	Called after a new terminal object has been initialized, but before	490	Called after a new terminal object has been initialized, but before
206	windows are created or the command gets run. Most methods are unsafe to	491	windows are created or the command gets run. Most methods are unsafe to
207	call or deliver senseless data, as terminal size and other characteristics	492	call or deliver senseless data, as terminal size and other characteristics
208	have not yet been determined. You can safely query and change resources,	493	have not yet been determined. You can safely query and change resources
209	though.	494	and options, though. For many purposes the C<on_start> hook is a better
		495	place.
		496
		497	=item on_start $term
		498
		499	Called at the very end of initialisation of a new terminal, just before
		500	trying to map (display) the toplevel and returning to the main loop.
		501
		502	=item on_destroy $term
		503
		504	Called whenever something tries to destroy terminal, when the terminal is
		505	still fully functional (not for long, though).
210		506
211	=item on_reset $term	507	=item on_reset $term
212		508
213	Called after the screen is "reset" for any reason, such as resizing or	509	Called after the screen is "reset" for any reason, such as resizing or
214	control sequences. Here is where you can react on changes to size-related	510	control sequences. Here is where you can react on changes to size-related
215	variables.	511	variables.
216		512
217	=item on_start $term	513	=item on_child_start $term, $pid
218		514
219	Called at the very end of initialisation of a new terminal, just before	515	Called just after the child process has been C<fork>ed.
220	returning to the mainloop.	516
		517	=item on_child_exit $term, $status
		518
		519	Called just after the child process has exited. C<$status> is the status
		520	from C<waitpid>.
221		521
222	=item on_sel_make $term, $eventtime	522	=item on_sel_make $term, $eventtime
223		523
224	Called whenever a selection has been made by the user, but before the	524	Called whenever a selection has been made by the user, but before the
225	selection text is copied, so changes to the beginning, end or type of the	525	selection text is copied, so changes to the beginning, end or type of the
…		…
232		532
233	Called whenever a selection has been copied, but before the selection is	533	Called whenever a selection has been copied, but before the selection is
234	requested from the server. The selection text can be queried and changed	534	requested from the server. The selection text can be queried and changed
235	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
236		536
237	Returning a true value aborts selection grabbing. It will still be hilighted.	537	Returning a true value aborts selection grabbing. It will still be highlighted.
238		538
239	=item on_sel_extend $term	539	=item on_sel_extend $term
240		540
241	Called whenever the user tries to extend the selection (e.g. with a double	541	Called whenever the user tries to extend the selection (e.g. with a double
242	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
243	should extend the selection itelf and return true to suppress the built-in	543	should extend the selection itself and return true to suppress the built-in
244	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
245	returns true, it will be called on every further click by the user and is	545	returns true, it will be called on every further click by the user and is
246	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
247		547
248	See the F<selection> example extension.	548	See the F<selection> example extension.
249		549
250	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
251		551
252	Called whenever the view offset changes, i..e the user or program	552	Called whenever the view offset changes, i.e. the user or program
253	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
254	show this many lines of scrollback.	554	show this many lines of scrollback.
255		555
256	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
257		557
…		…
261		561
262	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
263	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
264	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
265		565
266	=item on_osc_seq $term, $string	566	=item on_osc_seq $term, $op, $args, $resp
		567
		568	Called on every OSC sequence and can be used to suppress it or modify its
		569	behaviour. The default should be to return an empty list. A true value
		570	suppresses execution of the request completely. Make sure you don't get
		571	confused by recursive invocations when you output an OSC sequence within
		572	this callback.
		573
		574	C<on_osc_seq_perl> should be used for new behaviour.
		575
		576	=item on_osc_seq_perl $term, $args, $resp
267		577
268	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
269	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
270	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
271	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
272	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
273	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
274		594
275	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
276	as its source can not easily be controleld (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
277	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
278		601
279	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
280		603
281	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
282	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
…		…
303	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
304	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
305		628
306	=item on_refresh_begin $term	629	=item on_refresh_begin $term
307		630
308	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
309	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
310	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
311	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
312		635
313	=item on_refresh_end $term	636	=item on_refresh_end $term
314		637
315	Called just after the screen gets redrawn. See C<on_refresh_begin>.	638	Called just after the screen gets redrawn. See C<on_refresh_begin>.
316		639
317	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
318		641
319	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
320	C<perl:string> action bound to it (see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
321	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
		645
		646	The event is simply the action string. This interface is assumed to change
		647	slightly in the future.
		648
		649	=item on_resize_all_windows $tern, $new_width, $new_height
		650
		651	Called just after the new window size has been calculated, but before
		652	windows are actually being resized or hints are being set. If this hook
		653	returns TRUE, setting of the window hints is being skipped.
		654
		655	=item on_x_event $term, $event
		656
		657	Called on every X event received on the vt window (and possibly other
		658	windows). Should only be used as a last resort. Most event structure
		659	members are not passed.
		660
		661	=item on_root_event $term, $event
		662
		663	Like C<on_x_event>, but is called for events on the root window.
322		664
323	=item on_focus_in $term	665	=item on_focus_in $term
324		666
325	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
326	does focus in processing.	668	does focus in processing.
327		669
328	=item on_focus_out $term	670	=item on_focus_out $term
329		671
330	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
331	focus out processing.	673	focus out processing.
		674
		675	=item on_configure_notify $term, $event
		676
		677	=item on_property_notify $term, $event
332		678
333	=item on_key_press $term, $event, $keysym, $octets	679	=item on_key_press $term, $event, $keysym, $octets
334		680
335	=item on_key_release $term, $event, $keysym	681	=item on_key_release $term, $event, $keysym
336		682
…		…
346		692
347	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal If
348	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the even will be ignored by rxvt-unicode.
349		695
350	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
351	manpage), with the additional members C<row> and C<col>, which are the row	697	manpage), with the additional members C<row> and C<col>, which are the
352	and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
353		699
354	C<on_key_press> additionally receives the string rxvt-unicode would	700	C<on_key_press> additionally receives the string rxvt-unicode would
355	output, if any, in locale-specific encoding.	701	output, if any, in locale-specific encoding.
356		702
357	subwindow.	703	subwindow.
		704
		705	=item on_client_message $term, $event
		706
		707	=item on_wm_protocols $term, $event
		708
		709	=item on_wm_delete_window $term, $event
		710
		711	Called when various types of ClientMessage events are received (all with
		712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
358		713
359	=back	714	=back
360		715
361	=cut	716	=cut
362		717
…		…
368	use Scalar::Util ();	723	use Scalar::Util ();
369	use List::Util ();	724	use List::Util ();
370		725
371	our $VERSION = 1;	726	our $VERSION = 1;
372	our $TERM;	727	our $TERM;
		728	our @TERM_INIT;
		729	our @TERM_EXT;
373	our @HOOKNAME;	730	our @HOOKNAME;
374	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	731	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
375	our %OPTION;	732	our %OPTION;
376		733
377	our $LIBDIR;	734	our $LIBDIR;
378	our $RESNAME;	735	our $RESNAME;
379	our $RESCLASS;	736	our $RESCLASS;
380	our $RXVTNAME;	737	our $RXVTNAME;
381		738
		739	our $NOCHAR = chr 0xffff;
		740
382	=head2 Variables in the C<urxvt> Package	741	=head2 Variables in the C<urxvt> Package
383		742
384	=over 4	743	=over 4
385		744
386	=item $urxvt::LIBDIR	745	=item $urxvt::LIBDIR
…		…
398		757
399	=item $urxvt::TERM	758	=item $urxvt::TERM
400		759
401	The current terminal. This variable stores the current C<urxvt::term>	760	The current terminal. This variable stores the current C<urxvt::term>
402	object, whenever a callback/hook is executing.	761	object, whenever a callback/hook is executing.
		762
		763	=item @urxvt::TERM_INIT
		764
		765	All code references in this array will be called as methods of the next newly
		766	created C<urxvt::term> object (during the C<on_init> phase). The array
		767	gets cleared before the code references that were in it are being executed,
		768	so references can push themselves onto it again if they so desire.
		769
		770	This complements to the perl-eval command line option, but gets executed
		771	first.
		772
		773	=item @urxvt::TERM_EXT
		774
		775	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		776	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		777	but before other extensions. Gets cleared just like C<@TERM_INIT>.
403		778
404	=back	779	=back
405		780
406	=head2 Functions in the C<urxvt> Package	781	=head2 Functions in the C<urxvt> Package
407		782
…		…
422	Using this function has the advantage that its output ends up in the	797	Using this function has the advantage that its output ends up in the
423	correct place, e.g. on stderr of the connecting urxvtc client.	798	correct place, e.g. on stderr of the connecting urxvtc client.
424		799
425	Messages have a size limit of 1023 bytes currently.	800	Messages have a size limit of 1023 bytes currently.
426		801
427	=item $is_safe = urxvt::safe	802	=item @terms = urxvt::termlist
428		803
429	Returns true when it is safe to do potentially unsafe things, such as	804	Returns all urxvt::term objects that exist in this process, regardless of
430	evaluating perl code specified by the user. This is true when urxvt was	805	whether they are started, being destroyed etc., so be careful. Only term
431	started setuid or setgid.	806	objects that have perl extensions attached will be returned (because there
		807	is no urxvt::term objet associated with others).
432		808
433	=item $time = urxvt::NOW	809	=item $time = urxvt::NOW
434		810
435	Returns the "current time" (as per the event loop).	811	Returns the "current time" (as per the event loop).
436		812
437	=item urxvt::CurrentTime	813	=item urxvt::CurrentTime
438		814
439	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	815	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	816	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441	Button4Mask, Button5Mask, AnyModifier	817	Button4Mask, Button5Mask, AnyModifier
		818
		819	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		820	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		821	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		822	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		823	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		824	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		825	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		826
		827	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		828	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		829	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		830	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		831	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		832	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		833	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
442		834
443	Various constants for use in X calls and event processing.	835	Various constants for use in X calls and event processing.
444		836
445	=back	837	=back
446		838
…		…
479		871
480	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	872	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
481		873
482	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	874	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
483		875
		876	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		877
484	Replace the foreground/background colour in the rendition mask with the	878	Replace the foreground/background colour in the rendition mask with the
485	specified one.	879	specified one.
486		880
487	=item $value = urxvt::GET_CUSTOM $rend	881	=item $value = urxvt::GET_CUSTOM $rend
488		882
…		…
497	=back	891	=back
498		892
499	=cut	893	=cut
500		894
501	BEGIN {	895	BEGIN {
502	urxvt->bootstrap;
503
504	# overwrite perl's warn	896	# overwrite perl's warn
505	*CORE::GLOBAL::warn = sub {	897	*CORE::GLOBAL::warn = sub {
506	my $msg = join "", @_;	898	my $msg = join "", @_;
507	$msg .= "\n"	899	$msg .= "\n"
508	unless $msg =~ /\n$/;	900	unless $msg =~ /\n$/;
509	urxvt::warn ($msg);	901	urxvt::warn ($msg);
510	};	902	};
511
512	# %ENV is the original startup environment
513	delete $ENV{IFS};
514	delete $ENV{CDPATH};
515	delete $ENV{BASH_ENV};
516	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
517	}	903	}
518		904
519	my @hook_count;	905	no warnings 'utf8';
		906
520	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	907	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521		908
522	sub verbose {	909	sub verbose {
523	my ($level, $msg) = @_;	910	my ($level, $msg) = @_;
524	warn "$msg\n" if $level <= $verbosity;	911	warn "$msg\n" if $level <= $verbosity;
525	}	912	}
526		913
527	my $extension_pkg = "extension0000";
528	my %extension_pkg;	914	my %extension_pkg;
529		915
530	# load a single script into its own package, once only	916	# load a single script into its own package, once only
531	sub extension_package($) {	917	sub extension_package($) {
532	my ($path) = @_;	918	my ($path) = @_;
533		919
534	$extension_pkg{$path} ||= do {	920	$extension_pkg{$path} ||= do {
535	my $pkg = "urxvt::" . ($extension_pkg++);	921	$path =~ /([^\/\\]+)$/;
		922	my $pkg = $1;
		923	$pkg =~ s/[^[:word:]]/_/g;
		924	$pkg = "urxvt::ext::$pkg";
536		925
537	verbose 3, "loading extension '$path' into package '$pkg'";	926	verbose 3, "loading extension '$path' into package '$pkg'";
538		927
539	open my $fh, "<:raw", $path	928	open my $fh, "<:raw", $path
540	or die "$path: $!";	929	or die "$path: $!";
541		930
542	my $source = untaint	931	my $source =
543	"package $pkg; use strict; use utf8;\n"	932	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
544	. "use base urxvt::term::extension::;\n"
545	. "#line 1 \"$path\"\n{\n"	933	. "#line 1 \"$path\"\n{\n"
546	. (do { local $/; <$fh> })	934	. (do { local $/; <$fh> })
547	. "\n};\n1";	935	. "\n};\n1";
548		936
549	eval $source	937	eval $source
…		…
560	local $TERM = shift;	948	local $TERM = shift;
561	my $htype = shift;	949	my $htype = shift;
562		950
563	if ($htype == 0) { # INIT	951	if ($htype == 0) { # INIT
564	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
565		953
566	my %ext_arg;	954	my %ext_arg;
567		955
		956	{
		957	my @init = @TERM_INIT;
		958	@TERM_INIT = ();
		959	$_->($TERM) for @init;
		960	my @pkg = @TERM_EXT;
		961	@TERM_EXT = ();
		962	$TERM->register_package ($_) for @pkg;
		963	}
		964
568	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	965	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
569	if ($_ eq "default") {	966	if ($_ eq "default") {
570	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	967	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
571	} elsif (/^-(.*)$/) {	968	} elsif (/^-(.*)$/) {
572	delete $ext_arg{$1};	969	delete $ext_arg{$1};
573	} elsif (/^([^<]+)<(.*)>$/) {	970	} elsif (/^([^<]+)<(.*)>$/) {
574	push @{ $ext_arg{$1} }, $2;	971	push @{ $ext_arg{$1} }, $2;
575	} else {	972	} else {
576	$ext_arg{$_} ||= [];	973	$ext_arg{$_} ||= [];
577	}	974	}
578	}	975	}
579		976
580	while (my ($ext, $argv) = each %ext_arg) {	977	for my $ext (sort keys %ext_arg) {
581	my @files = grep -f $_, map "$_/$ext", @dirs;	978	my @files = grep -f $_, map "$_/$ext", @dirs;
582		979
583	if (@files) {	980	if (@files) {
584	$TERM->register_package (extension_package $files[0], $argv);	981	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
585	} else {	982	} else {
586	warn "perl extension '$ext' not found in perl library search path\n";	983	warn "perl extension '$ext' not found in perl library search path\n";
587	}	984	}
588	}	985	}
589		986
…		…
595		992
596	if (my $cb = $TERM->{_hook}[$htype]) {	993	if (my $cb = $TERM->{_hook}[$htype]) {
597	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	994	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
598	if $verbosity >= 10;	995	if $verbosity >= 10;
599		996
600	keys %$cb;	997	for my $pkg (keys %$cb) {
601
602	while (my ($pkg, $cb) = each %$cb) {
603	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	998	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
604	and last;	999	$retval ||= $retval_;
605		1000
606	if ($@) {	1001	if ($@) {
607	$TERM->ungrab; # better to lose the grab than the session	1002	$TERM->ungrab; # better to lose the grab than the session
608	warn $@;	1003	warn $@;
609	}	1004	}
…		…
612	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	1007	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613	if $verbosity >= 11;	1008	if $verbosity >= 11;
614	}	1009	}
615		1010
616	if ($htype == 1) { # DESTROY	1011	if ($htype == 1) { # DESTROY
617	if (my $hook = delete $TERM->{_hook}) {
618	for my $htype (0..$#$hook) {
619	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
620	or set_should_invoke $htype, 0;
621	}
622	}
623
624	# clear package objects	1012	# clear package objects
625	%$_ = () for values %{ $TERM->{_pkg} };	1013	%$_ = () for values %{ $TERM->{_pkg} };
626		1014
627	# clear package	1015	# clear package
628	%$TERM = ();	1016	%$TERM = ();
629	}	1017	}
630		1018
631	$retval	1019	$retval
632	}	1020	}
633		1021
634	sub exec_async(@) {	1022	sub SET_COLOR($$$) {
635	my $pid = fork;	1023	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1024	}
636		1025
637	return	1026	sub rend2mask {
638	if !defined $pid or $pid;	1027	no strict 'refs';
639		1028	my ($str, $mask) = (@_, 0);
640	%ENV = %{ $TERM->env };	1029	my %color = ( fg => undef, bg => undef );
641		1030	my @failed;
642	exec @_;	1031	for my $spec ( split /\s+/, $str ) {
643	_exit 255;	1032	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1033	$color{lc($1)} = $2;
		1034	} else {
		1035	my $neg = $spec =~ s/^[-^]//;
		1036	unless ( exists &{"RS_$spec"} ) {
		1037	push @failed, $spec;
		1038	next;
		1039	}
		1040	my $cur = &{"RS_$spec"};
		1041	if ( $neg ) {
		1042	$mask &= ~$cur;
		1043	} else {
		1044	$mask |= $cur;
		1045	}
		1046	}
		1047	}
		1048	($mask, @color{qw(fg bg)}, \@failed)
644	}	1049	}
645		1050
646	# urxvt::term::extension	1051	# urxvt::term::extension
647		1052
648	package urxvt::term::extension;	1053	package urxvt::term::extension;
…		…
654	while (my ($name, $cb) = each %hook) {	1059	while (my ($name, $cb) = each %hook) {
655	my $htype = $HOOKTYPE{uc $name};	1060	my $htype = $HOOKTYPE{uc $name};
656	defined $htype	1061	defined $htype
657	or Carp::croak "unsupported hook type '$name'";	1062	or Carp::croak "unsupported hook type '$name'";
658		1063
		1064	$self->set_should_invoke ($htype, +1)
659	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1065	unless exists $self->{term}{_hook}[$htype]{$pkg};
660	$hook_count[$htype]++
661	or urxvt::set_should_invoke $htype, 1;
662	}
663		1066
664	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1067	$self->{term}{_hook}[$htype]{$pkg} = $cb;
665	}	1068	}
666	}	1069	}
667		1070
…		…
672	for my $name (@hook) {	1075	for my $name (@hook) {
673	my $htype = $HOOKTYPE{uc $name};	1076	my $htype = $HOOKTYPE{uc $name};
674	defined $htype	1077	defined $htype
675	or Carp::croak "unsupported hook type '$name'";	1078	or Carp::croak "unsupported hook type '$name'";
676		1079
		1080	$self->set_should_invoke ($htype, -1)
677	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1081	if delete $self->{term}{_hook}[$htype]{$pkg};
678	--$hook_count[$htype]
679	or urxvt::set_should_invoke $htype, 0;
680	}
681	}	1082	}
682	}	1083	}
683		1084
684	our $AUTOLOAD;	1085	our $AUTOLOAD;
685		1086
…		…
723	is that you cannot use blocking APIs, but the non-blocking variant should	1124	is that you cannot use blocking APIs, but the non-blocking variant should
724	work.	1125	work.
725		1126
726	=cut	1127	=cut
727		1128
728	our $VERSION = 1;	1129	our $VERSION = '3.4';
729		1130
730	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1131	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
731	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1132	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
732		1133
733	sub timer {	1134	sub timer {
…		…
764		1165
765	sub DESTROY {	1166	sub DESTROY {
766	$_[0][1]->stop;	1167	$_[0][1]->stop;
767	}	1168	}
768		1169
769	sub condvar {	1170	sub one_event {
770	bless \my $flag, urxvt::anyevent::condvar::
771	}
772
773	sub urxvt::anyevent::condvar::broadcast {
774	${$_[0]}++;
775	}
776
777	sub urxvt::anyevent::condvar::wait {
778	unless (${$_[0]}) {
779	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1171	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
780	}
781	}	1172	}
782		1173
783	package urxvt::term;	1174	package urxvt::term;
784		1175
785	=head2 The C<urxvt::term> Class	1176	=head2 The C<urxvt::term> Class
…		…
790		1181
791	# find on_xxx subs in the package and register them	1182	# find on_xxx subs in the package and register them
792	# as hooks	1183	# as hooks
793	sub register_package {	1184	sub register_package {
794	my ($self, $pkg, $argv) = @_;	1185	my ($self, $pkg, $argv) = @_;
		1186
		1187	no strict 'refs';
		1188
		1189	urxvt::verbose 6, "register package $pkg to $self";
		1190
		1191	@{"$pkg\::ISA"} = urxvt::term::extension::;
795		1192
796	my $proxy = bless {	1193	my $proxy = bless {
797	_pkg => $pkg,	1194	_pkg => $pkg,
798	argv => $argv,	1195	argv => $argv,
799	}, $pkg;	1196	}, $pkg;
…		…
815	hash which defines the environment of the new terminal.	1212	hash which defines the environment of the new terminal.
816		1213
817	Croaks (and probably outputs an error message) if the new instance	1214	Croaks (and probably outputs an error message) if the new instance
818	couldn't be created. Returns C<undef> if the new instance didn't	1215	couldn't be created. Returns C<undef> if the new instance didn't
819	initialise perl, and the terminal object otherwise. The C<init> and	1216	initialise perl, and the terminal object otherwise. The C<init> and
820	C<start> hooks will be called during this call.	1217	C<start> hooks will be called before this call returns, and are free to
		1218	refer to global data (which is race free).
821		1219
822	=cut	1220	=cut
823		1221
824	sub new {	1222	sub new {
825	my ($class, $env, @args) = @_;	1223	my ($class, $env, @args) = @_;
826		1224
		1225	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1226	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1227
827	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1228	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
828	}	1229	}
829		1230
830	=item $term->destroy	1231	=item $term->destroy
831		1232
832	Destroy the terminal object (close the window, free resources	1233	Destroy the terminal object (close the window, free resources
833	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1234	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
834	watchers (timers, io watchers) are still active.	1235	watchers (timers, io watchers) are still active.
835		1236
		1237	=item $term->exec_async ($cmd[, @args])
		1238
		1239	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1240	("starts") programs in the background. This function takes care of setting
		1241	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1242	be preferred over explicit calls to C<exec> or C<system>.
		1243
		1244	Returns the pid of the subprocess or C<undef> on error.
		1245
		1246	=cut
		1247
		1248	sub exec_async {
		1249	my $self = shift;
		1250
		1251	my $pid = fork;
		1252
		1253	return $pid
		1254	if !defined $pid or $pid;
		1255
		1256	%ENV = %{ $self->env };
		1257
		1258	exec @_;
		1259	urxvt::_exit 255;
		1260	}
		1261
836	=item $isset = $term->option ($optval[, $set])	1262	=item $isset = $term->option ($optval[, $set])
837		1263
838	Returns true if the option specified by C<$optval> is enabled, and	1264	Returns true if the option specified by C<$optval> is enabled, and
839	optionally change it. All option values are stored by name in the hash	1265	optionally change it. All option values are stored by name in the hash
840	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1266	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
841		1267
842	Here is a a likely non-exhaustive list of option names, please see the	1268	Here is a likely non-exhaustive list of option names, please see the
843	source file F</src/optinc.h> to see the actual list:	1269	source file F</src/optinc.h> to see the actual list:
844		1270
845	borderLess console cursorBlink cursorUnderline hold iconic insecure	1271	borderLess console cursorBlink cursorUnderline hold iconic insecure
846	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1272	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
847	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1273	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
848	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1274	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
849	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1275	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
850	tripleclickwords utmpInhibit visualBell	1276	transparent tripleclickwords utmpInhibit visualBell
851		1277
852	=item $value = $term->resource ($name[, $newval])	1278	=item $value = $term->resource ($name[, $newval])
853		1279
854	Returns the current resource value associated with a given name and	1280	Returns the current resource value associated with a given name and
855	optionally sets a new value. Setting values is most useful in the C<init>	1281	optionally sets a new value. Setting values is most useful in the C<init>
…		…
864	likely change).	1290	likely change).
865		1291
866	Please note that resource strings will currently only be freed when the	1292	Please note that resource strings will currently only be freed when the
867	terminal is destroyed, so changing options frequently will eat memory.	1293	terminal is destroyed, so changing options frequently will eat memory.
868		1294
869	Here is a a likely non-exhaustive list of resource names, not all of which	1295	Here is a likely non-exhaustive list of resource names, not all of which
870	are supported in every build, please see the source file F</src/rsinc.h>	1296	are supported in every build, please see the source file F</src/rsinc.h>
871	to see the actual list:	1297	to see the actual list:
872		1298
873	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1299	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
874	borderLess color cursorBlink cursorUnderline cutchars delete_key	1300	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
875	display_name embed ext_bwidth fade font geometry hold iconName	1301	display_name embed ext_bwidth fade font geometry hold iconName
876	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1302	imFont imLocale inputMethod insecure int_bwidth intensityStyles
877	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1303	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
878	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1304	modifier mouseWheelScrollPage name override_redirect pastableTabs path
879	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1305	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
880	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1306	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
881	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1307	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
882	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1308	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
883	shade term_name title transparent transparent_all tripleclickwords	1309	secondaryScreen secondaryScroll shade term_name title
884	utmpInhibit visualBell	1310	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1311	visualBell
885		1312
886	=cut	1313	=cut
887		1314
888	sub resource($$;$) {	1315	sub resource($$;$) {
889	my ($self, $name) = (shift, shift);	1316	my ($self, $name) = (shift, shift);
890	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1317	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
891	&urxvt::term::_resource	1318	goto &urxvt::term::_resource
892	}	1319	}
893		1320
894	=item $value = $term->x_resource ($pattern)	1321	=item $value = $term->x_resource ($pattern)
895		1322
896	Returns the X-Resource for the given pattern, excluding the program or	1323	Returns the X-Resource for the given pattern, excluding the program or
…		…
979		1406
980	The methods currently supported on C<urxvt::overlay> objects are:	1407	The methods currently supported on C<urxvt::overlay> objects are:
981		1408
982	=over 4	1409	=over 4
983		1410
984	=item $overlay->set ($x, $y, $text, $rend)	1411	=item $overlay->set ($x, $y, $text[, $rend])
985		1412
986	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1413	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
987	text in rxvt-unicode's special encoding and an array of rendition values	1414	text in rxvt-unicode's special encoding and an array of rendition values
988	at a specific position inside the overlay.	1415	at a specific position inside the overlay.
		1416
		1417	If C<$rend> is missing, then the rendition will not be changed.
989		1418
990	=item $overlay->hide	1419	=item $overlay->hide
991		1420
992	If visible, hide the overlay, but do not destroy it.	1421	If visible, hide the overlay, but do not destroy it.
993		1422
…		…
1063		1492
1064	Normally its not a good idea to use this function, as programs might be	1493	Normally its not a good idea to use this function, as programs might be
1065	confused by changes in cursor position or scrolling. Its useful inside a	1494	confused by changes in cursor position or scrolling. Its useful inside a
1066	C<on_add_lines> hook, though.	1495	C<on_add_lines> hook, though.
1067		1496
		1497	=item $term->scr_change_screen ($screen)
		1498
		1499	Switch to given screen - 0 primary, 1 secondary.
		1500
1068	=item $term->cmd_parse ($octets)	1501	=item $term->cmd_parse ($octets)
1069		1502
1070	Similar to C<scr_add_lines>, but the argument must be in the	1503	Similar to C<scr_add_lines>, but the argument must be in the
1071	locale-specific encoding of the terminal and can contain command sequences	1504	locale-specific encoding of the terminal and can contain command sequences
1072	(escape codes) that will be interpreted.	1505	(escape codes) that will be interpreted.
…		…
1082	Replaces the event mask of the pty watcher by the given event mask. Can	1515	Replaces the event mask of the pty watcher by the given event mask. Can
1083	be used to suppress input and output handling to the pty/tty. See the	1516	be used to suppress input and output handling to the pty/tty. See the
1084	description of C<< urxvt::timer->events >>. Make sure to always restore	1517	description of C<< urxvt::timer->events >>. Make sure to always restore
1085	the previous value.	1518	the previous value.
1086		1519
		1520	=item $fd = $term->pty_fd
		1521
		1522	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1523	is used.
		1524
1087	=item $windowid = $term->parent	1525	=item $windowid = $term->parent
1088		1526
1089	Return the window id of the toplevel window.	1527	Return the window id of the toplevel window.
1090		1528
1091	=item $windowid = $term->vt	1529	=item $windowid = $term->vt
1092		1530
1093	Return the window id of the terminal window.	1531	Return the window id of the terminal window.
1094		1532
		1533	=item $term->vt_emask_add ($x_event_mask)
		1534
		1535	Adds the specified events to the vt event mask. Useful e.g. when you want
		1536	to receive pointer events all the times:
		1537
		1538	$term->vt_emask_add (urxvt::PointerMotionMask);
		1539
		1540	=item $term->focus_in
		1541
		1542	=item $term->focus_out
		1543
		1544	=item $term->key_press ($state, $keycode[, $time])
		1545
		1546	=item $term->key_release ($state, $keycode[, $time])
		1547
		1548	Deliver various fake events to to terminal.
		1549
1095	=item $window_width = $term->width	1550	=item $window_width = $term->width
1096		1551
1097	=item $window_height = $term->height	1552	=item $window_height = $term->height
1098		1553
1099	=item $font_width = $term->fwidth	1554	=item $font_width = $term->fwidth
…		…
1112		1567
1113	=item $max_scrollback = $term->saveLines	1568	=item $max_scrollback = $term->saveLines
1114		1569
1115	=item $nrow_plus_saveLines = $term->total_rows	1570	=item $nrow_plus_saveLines = $term->total_rows
1116		1571
1117	=item $lines_in_scrollback = $term->nsaved	1572	=item $topmost_scrollback_row = $term->top_row
1118		1573
1119	Return various integers describing terminal characteristics.	1574	Return various integers describing terminal characteristics.
1120		1575
1121	=item $x_display = $term->display_id	1576	=item $x_display = $term->display_id
1122		1577
…		…
1129	=item $env = $term->env	1584	=item $env = $term->env
1130		1585
1131	Returns a copy of the environment in effect for the terminal as a hashref	1586	Returns a copy of the environment in effect for the terminal as a hashref
1132	similar to C<\%ENV>.	1587	similar to C<\%ENV>.
1133		1588
		1589	=item @envv = $term->envv
		1590
		1591	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1592
		1593	=item @argv = $term->argv
		1594
		1595	Return the argument vector as this terminal, similar to @ARGV, but
		1596	includes the program name as first element.
		1597
1134	=cut	1598	=cut
1135		1599
1136	sub env {	1600	sub env {
1137	if (my $env = $_[0]->_env) {
1138	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1601	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1139	} else {
1140	+{ %ENV }
1141	}
1142	}	1602	}
1143		1603
1144	=item $modifiermask = $term->ModLevel3Mask	1604	=item $modifiermask = $term->ModLevel3Mask
1145		1605
1146	=item $modifiermask = $term->ModMetaMask	1606	=item $modifiermask = $term->ModMetaMask
…		…
1148	=item $modifiermask = $term->ModNumLockMask	1608	=item $modifiermask = $term->ModNumLockMask
1149		1609
1150	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1610	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1151	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1611	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1152		1612
		1613	=item $screen = $term->current_screen
		1614
		1615	Returns the currently displayed screen (0 primary, 1 secondary).
		1616
		1617	=item $cursor_is_hidden = $term->hidden_cursor
		1618
		1619	Returns whether the cursor is currently hidden or not.
		1620
1153	=item $view_start = $term->view_start ([$newvalue])	1621	=item $view_start = $term->view_start ([$newvalue])
1154		1622
1155	Returns the negative row number of the topmost line. Minimum value is	1623	Returns the row number of the topmost displayed line. Maximum value is
1156	C<0>, which displays the normal terminal contents. Larger values scroll	1624	C<0>, which displays the normal terminal contents. Lower values scroll
1157	this many lines into the scrollback buffer.	1625	this many lines into the scrollback buffer.
1158		1626
1159	=item $term->want_refresh	1627	=item $term->want_refresh
1160		1628
1161	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1629	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1164		1632
1165	Used after changing terminal contents to display them.	1633	Used after changing terminal contents to display them.
1166		1634
1167	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1635	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1168		1636
1169	Returns the text of the entire row with number C<$row_number>. Row C<0>	1637	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1170	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1638	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1171	terminal line. The scrollback buffer starts at line C<-1> and extends to
1172	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1639	terminal line. Nothing will be returned if a nonexistent line
1173	is requested.	1640	is requested.
1174		1641
1175	If C<$new_text> is specified, it will replace characters in the current	1642	If C<$new_text> is specified, it will replace characters in the current
1176	line, starting at column C<$start_col> (default C<0>), which is useful	1643	line, starting at column C<$start_col> (default C<0>), which is useful
1177	to replace only parts of a line. The font index in the rendition will	1644	to replace only parts of a line. The font index in the rendition will
1178	automatically be updated.	1645	automatically be updated.
1179		1646
1180	C<$text> is in a special encoding: tabs and wide characters that use more	1647	C<$text> is in a special encoding: tabs and wide characters that use more
1181	than one cell when displayed are padded with urxvt::NOCHAR characters	1648	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1182	(C<chr 65535>). Characters with combining characters and other characters	1649	characters. Characters with combining characters and other characters that
1183	that do not fit into the normal tetx encoding will be replaced with	1650	do not fit into the normal text encoding will be replaced with characters
1184	characters in the private use area.	1651	in the private use area.
1185		1652
1186	You have to obey this encoding when changing text. The advantage is	1653	You have to obey this encoding when changing text. The advantage is
1187	that C<substr> and similar functions work on screen cells and not on	1654	that C<substr> and similar functions work on screen cells and not on
1188	characters.	1655	characters.
1189		1656
…		…
1333	where one character corresponds to one screen cell. See	1800	where one character corresponds to one screen cell. See
1334	C<< $term->ROW_t >> for details.	1801	C<< $term->ROW_t >> for details.
1335		1802
1336	=item $string = $term->special_decode $text	1803	=item $string = $term->special_decode $text
1337		1804
1338	Converts rxvt-unicodes text reprsentation into a perl string. See	1805	Converts rxvt-unicodes text representation into a perl string. See
1339	C<< $term->ROW_t >> for details.	1806	C<< $term->ROW_t >> for details.
1340		1807
1341	=item $success = $term->grab_button ($button, $modifiermask)	1808	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1342		1809
		1810	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1811
1343	Registers a synchronous button grab. See the XGrabButton manpage.	1812	Register/unregister a synchronous button grab. See the XGrabButton
		1813	manpage.
1344		1814
1345	=item $success = $term->grab ($eventtime[, $sync])	1815	=item $success = $term->grab ($eventtime[, $sync])
1346		1816
1347	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1817	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1348	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1818	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1349		1819
1350	=item $term->allow_events_async	1820	=item $term->allow_events_async
1351		1821
1352	Calls XAllowEvents with AsyncBoth for the most recent grab.	1822	Calls XAllowEvents with AsyncBoth for the most recent grab.
1353		1823
…		…
1363	=item $term->ungrab	1833	=item $term->ungrab
1364		1834
1365	Calls XUngrab for the most recent grab. Is called automatically on	1835	Calls XUngrab for the most recent grab. Is called automatically on
1366	evaluation errors, as it is better to lose the grab in the error case as	1836	evaluation errors, as it is better to lose the grab in the error case as
1367	the session.	1837	the session.
		1838
		1839	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1840
		1841	=item $atom_name = $term->XGetAtomName ($atom)
		1842
		1843	=item @atoms = $term->XListProperties ($window)
		1844
		1845	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1846
		1847	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1848
		1849	=item $term->XDeleteProperty ($window, $property)
		1850
		1851	=item $window = $term->DefaultRootWindow
		1852
		1853	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1854
		1855	=item $term->XMapWindow ($window)
		1856
		1857	=item $term->XUnmapWindow ($window)
		1858
		1859	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1860
		1861	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1862
		1863	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1864
		1865	Various X or X-related functions. The C<$term> object only serves as
		1866	the source of the display, otherwise those functions map more-or-less
		1867	directory onto the X functions of the same name.
1368		1868
1369	=back	1869	=back
1370		1870
1371	=cut	1871	=cut
1372		1872
…		…
1436	my ($self, $text, $cb) = @_;	1936	my ($self, $text, $cb) = @_;
1437		1937
1438	$self->add_item ({ type => "button", text => $text, activate => $cb});	1938	$self->add_item ({ type => "button", text => $text, activate => $cb});
1439	}	1939	}
1440		1940
1441	=item $popup->add_toggle ($text, $cb, $initial_value)	1941	=item $popup->add_toggle ($text, $initial_value, $cb)
1442		1942
1443	Adds a toggle/checkbox item to the popup. Teh callback gets called	1943	Adds a toggle/checkbox item to the popup. The callback gets called
1444	whenever it gets toggled, with a boolean indicating its value as its first	1944	whenever it gets toggled, with a boolean indicating its new value as its
1445	argument.	1945	first argument.
1446		1946
1447	=cut	1947	=cut
1448		1948
1449	sub add_toggle {	1949	sub add_toggle {
1450	my ($self, $text, $cb, $value) = @_;	1950	my ($self, $text, $value, $cb) = @_;
1451		1951
1452	my $item; $item = {	1952	my $item; $item = {
1453	type => "button",	1953	type => "button",
1454	text => " $text",	1954	text => " $text",
1455	value => $value,	1955	value => $value,
…		…
1474	my $env = $self->{term}->env;	1974	my $env = $self->{term}->env;
1475	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1975	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1476	delete $env->{LC_ALL};	1976	delete $env->{LC_ALL};
1477	$env->{LC_CTYPE} = $self->{term}->locale;	1977	$env->{LC_CTYPE} = $self->{term}->locale;
1478		1978
1479	urxvt::term->new ($env, $self->{term}->resource ("name"),	1979	my $term = urxvt::term->new (
1480	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1980	$env, "popup",
		1981	"--perl-lib" => "", "--perl-ext-common" => "",
		1982	"-pty-fd" => -1, "-sl" => 0,
		1983	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1481	"--transient-for" => $self->{term}->parent,	1984	"--transient-for" => $self->{term}->parent,
1482	"-display" => $self->{term}->display_id,	1985	"-display" => $self->{term}->display_id,
1483	"-pe" => "urxvt-popup")	1986	"-pe" => "urxvt-popup",
1484	or die "unable to create popup window\n";	1987	) or die "unable to create popup window\n";
		1988
		1989	unless (delete $term->{urxvt_popup_init_done}) {
		1990	$term->ungrab;
		1991	$term->destroy;
		1992	die "unable to initialise popup window\n";
		1993	}
1485	}	1994	}
1486		1995
1487	sub DESTROY {	1996	sub DESTROY {
1488	my ($self) = @_;	1997	my ($self) = @_;
1489		1998
1490	delete $self->{term}{_destroy}{$self};	1999	delete $self->{term}{_destroy}{$self};
1491	$self->{term}->ungrab;	2000	$self->{term}->ungrab;
1492	}	2001	}
1493		2002
1494	=back	2003	=back
		2004
		2005	=cut
		2006
		2007	package urxvt::watcher;
1495		2008
1496	=head2 The C<urxvt::timer> Class	2009	=head2 The C<urxvt::timer> Class
1497		2010
1498	This class implements timer watchers/events. Time is represented as a	2011	This class implements timer watchers/events. Time is represented as a
1499	fractional number of seconds since the epoch. Example:	2012	fractional number of seconds since the epoch. Example:
…		…
1503	->new	2016	->new
1504	->interval (1)	2017	->interval (1)
1505	->cb (sub {	2018	->cb (sub {
1506	$term->{overlay}->set (0, 0,	2019	$term->{overlay}->set (0, 0,
1507	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2020	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1508	});	2021	});
1509		2022
1510	=over 4	2023	=over 4
1511		2024
1512	=item $timer = new urxvt::timer	2025	=item $timer = new urxvt::timer
1513		2026
…		…
1537	Start the timer.	2050	Start the timer.
1538		2051
1539	=item $timer = $timer->start ($tstamp)	2052	=item $timer = $timer->start ($tstamp)
1540		2053
1541	Set the event trigger time to C<$tstamp> and start the timer.	2054	Set the event trigger time to C<$tstamp> and start the timer.
		2055
		2056	=item $timer = $timer->after ($delay)
		2057
		2058	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1542		2059
1543	=item $timer = $timer->stop	2060	=item $timer = $timer->stop
1544		2061
1545	Stop the timer.	2062	Stop the timer.
1546		2063
…		…
1552		2069
1553	$term->{socket} = ...	2070	$term->{socket} = ...
1554	$term->{iow} = urxvt::iow	2071	$term->{iow} = urxvt::iow
1555	->new	2072	->new
1556	->fd (fileno $term->{socket})	2073	->fd (fileno $term->{socket})
1557	->events (urxvt::EVENT_READ)	2074	->events (urxvt::EV_READ)
1558	->start	2075	->start
1559	->cb (sub {	2076	->cb (sub {
1560	my ($iow, $revents) = @_;	2077	my ($iow, $revents) = @_;
1561	# $revents must be 1 here, no need to check	2078	# $revents must be 1 here, no need to check
1562	sysread $term->{socket}, my $buf, 8192	2079	sysread $term->{socket}, my $buf, 8192
…		…
1575	Set the callback to be called when io events are triggered. C<$reventmask>	2092	Set the callback to be called when io events are triggered. C<$reventmask>
1576	is a bitset as described in the C<events> method.	2093	is a bitset as described in the C<events> method.
1577		2094
1578	=item $iow = $iow->fd ($fd)	2095	=item $iow = $iow->fd ($fd)
1579		2096
1580	Set the filedescriptor (not handle) to watch.	2097	Set the file descriptor (not handle) to watch.
1581		2098
1582	=item $iow = $iow->events ($eventmask)	2099	=item $iow = $iow->events ($eventmask)
1583		2100
1584	Set the event mask to watch. The only allowed values are	2101	Set the event mask to watch. The only allowed values are
1585	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2102	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1586	together, or C<urxvt::EVENT_NONE>.	2103	together, or C<urxvt::EV_NONE>.
1587		2104
1588	=item $iow = $iow->start	2105	=item $iow = $iow->start
1589		2106
1590	Start watching for requested events on the given handle.	2107	Start watching for requested events on the given handle.
1591		2108
1592	=item $iow = $iow->stop	2109	=item $iow = $iow->stop
1593		2110
1594	Stop watching for events on the given filehandle.	2111	Stop watching for events on the given file handle.
		2112
		2113	=back
		2114
		2115	=head2 The C<urxvt::iw> Class
		2116
		2117	This class implements idle watchers, that get called automatically when
		2118	the process is idle. They should return as fast as possible, after doing
		2119	some useful work.
		2120
		2121	=over 4
		2122
		2123	=item $iw = new urxvt::iw
		2124
		2125	Create a new idle watcher object in stopped state.
		2126
		2127	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2128
		2129	Set the callback to be called when the watcher triggers.
		2130
		2131	=item $timer = $timer->start
		2132
		2133	Start the watcher.
		2134
		2135	=item $timer = $timer->stop
		2136
		2137	Stop the watcher.
		2138
		2139	=back
		2140
		2141	=head2 The C<urxvt::pw> Class
		2142
		2143	This class implements process watchers. They create an event whenever a
		2144	process exits, after which they stop automatically.
		2145
		2146	my $pid = fork;
		2147	...
		2148	$term->{pw} = urxvt::pw
		2149	->new
		2150	->start ($pid)
		2151	->cb (sub {
		2152	my ($pw, $exit_status) = @_;
		2153	...
		2154	});
		2155
		2156	=over 4
		2157
		2158	=item $pw = new urxvt::pw
		2159
		2160	Create a new process watcher in stopped state.
		2161
		2162	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2163
		2164	Set the callback to be called when the timer triggers.
		2165
		2166	=item $pw = $timer->start ($pid)
		2167
		2168	Tells the watcher to start watching for process C<$pid>.
		2169
		2170	=item $pw = $pw->stop
		2171
		2172	Stop the watcher.
1595		2173
1596	=back	2174	=back
1597		2175
1598	=head1 ENVIRONMENT	2176	=head1 ENVIRONMENT
1599		2177
…		…
1608		2186
1609	=item >= 3 - script loading and management	2187	=item >= 3 - script loading and management
1610		2188
1611	=item >=10 - all called hooks	2189	=item >=10 - all called hooks
1612		2190
1613	=item >=11 - hook reutrn values	2191	=item >=11 - hook return values
1614		2192
1615	=back	2193	=back
1616		2194
1617	=head1 AUTHOR	2195	=head1 AUTHOR
1618		2196
…		…
1620	http://software.schmorp.de/pkg/rxvt-unicode	2198	http://software.schmorp.de/pkg/rxvt-unicode
1621		2199
1622	=cut	2200	=cut
1623		2201
1624	1	2202	1
		2203
		2204	# vim: sw=3:

Diff Legend

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