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.109 by root, Thu Jan 19 16:07:09 2006 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	71	between two vertical bars:
65		72
66	URxvt.selection.pattern-0: \\|([^|]+)\\|	73	URxvt.selection.pattern-0: \\|([^|]+)\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
67		81
68	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
83	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
84		98
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.	100	runtime.
87		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
88	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
89		120
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
93		124
94	Other extensions can extend this popup menu by pushing a code reference onto	125	Other extensions can extend this popup menu by pushing a code reference
95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
96		128
97	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
98	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
99	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
100	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
101	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
102		134
103	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
104	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	137	C<a>s:
106		138
107	push urxvt::ext::selection_popup::hook, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
109	: ()	141	: ()
110	};	142	};
111
112	Don't run it in a hook, otherwise the menu will grow and grow. Instead put
113	it at the toplevel of your extension.
114		143
115	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
116		145
117	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
118	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
…		…
123	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>
124	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
125	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
126	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
127	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
128	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.
129		189
130	=item selection-autotransform	190	=item selection-autotransform
131		191
132	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
133	whenever a selection is made.	193	whenever a selection is made.
…		…
160		220
161	The first line tells the selection code to treat the unchanging part of	221	The first line tells the selection code to treat the unchanging part of
162	every error message as a selection pattern, and the second line transforms	222	every error message as a selection pattern, and the second line transforms
163	the message into vi commands to load the file.	223	the message into vi commands to load the file.
164		224
165	=item mark-urls	225	=item tabbed
166		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
167	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
168	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
169	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
170	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.
171		258
172	=item automove-background	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.
173		263
174	This is basically a one-line extension that dynamically changes the background pixmap offset	264	It is possible to activate the most recently seen match from the keyboard.
175	to the window position, in effect creating the same effect as pseudo transparency with	265	Simply bind a keysym to "perl:matcher" as seen in the example below.
176	a custom pixmap. No scaling is supported in this mode. Exmaple:
177		266
178	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	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.
179		313
180	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
181		315
182	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
183	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
184	similar-looking ascii character.	318	similar-looking ascii character.
185		319
186	=item digital-clock	320	=item digital-clock
187		321
188	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
		323
		324	=item remote-clipboard
		325
		326	Somewhat of a misnomer, this extension adds two menu entries to the
		327	selection popup that allows one to run external commands to store the
		328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		343
		344	=item selection-pastebin
		345
		346	This is a little rarely useful extension that uploads the selection as
		347	textfile to a remote site (or does other things). (The implementation is
		348	not currently secure for use in a multiuser environment as it writes to
		349	F</tmp> directly.).
		350
		351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		352	i.e.
		353
		354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		355
		356	Pressing this combination runs a command with C<%> replaced by the name of
		357	the textfile. This command can be set via a resource:
		358
		359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		360
		361	And the default is likely not useful to anybody but the few people around
		362	here :)
		363
		364	The name of the textfile is the hex encoded md5 sum of the selection, so
		365	the same content should lead to the same filename.
		366
		367	After a successful upload the selection will be replaced by the text given
		368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		369	for the filename):
		370
		371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of whether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
189		391
190	=item example-refresh-hooks	392	=item example-refresh-hooks
191		393
192	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
193	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
194	overlays or changes.	396	overlays or changes.
195
196	=item selection-pastebin
197
198	This is a little rarely useful extension that Uploads the selection as
199	textfile to a remote site (or does other things). (The implementation is
200	not currently secure for use in a multiuser environment as it writes to
201	F</tmp> directly.).
202
203	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
204	i.e.
205
206	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
207
208	Pressing this combination runs a command with C<%> replaced by the name of
209	the textfile. This command can be set via a resource:
210
211	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
212
213	And the default is likely not useful to anybody but the few people around
214	here :)
215
216	The name of the textfile is the hex encoded md5 sum of the selection, so
217	the same content should lead to the same filename.
218
219	After a successful upload the selection will be replaced by the text given
220	in the C<selection-pastebin-url> resource (again, the % is the placeholder
221	for the filename):
222
223	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
224		397
225	=back	398	=back
226		399
227	=head1 API DOCUMENTATION	400	=head1 API DOCUMENTATION
228		401
…		…
244		417
245	=over 4	418	=over 4
246		419
247	=item $text	420	=item $text
248		421
249	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
250	always represents one screen cell. See L<ROW_t> for a discussion of this format.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
251		424
252	=item $string	425	=item $string
253		426
254	A perl text string, with an emphasis on I<text>. It can store all unicode	427	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
262		435
263	=back	436	=back
264		437
265	=head2 Extension Objects	438	=head2 Extension Objects
266		439
267	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
268	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,
269	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
270	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
271	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
272	use.	446	internal use.
273		447
274	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
275	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
276		450
277	It has the following methods and data members:	451	It has the following methods and data members:
…		…
298	=head2 Hooks	472	=head2 Hooks
299		473
300	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
301	called whenever the relevant event happens.	475	called whenever the relevant event happens.
302		476
303	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
304	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
305		479
306	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
307	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
308	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.
309		483
310	I<< When in doubt, return a false value (preferably C<()>). >>	484	I<< When in doubt, return a false value (preferably C<()>). >>
311		485
312	=over 4	486	=over 4
313		487
314	=item on_init $term	488	=item on_init $term
315		489
316	Called after a new terminal object has been initialized, but before	490	Called after a new terminal object has been initialized, but before
317	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
318	call or deliver senseless data, as terminal size and other characteristics	492	call or deliver senseless data, as terminal size and other characteristics
319	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
320	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).
321		506
322	=item on_reset $term	507	=item on_reset $term
323		508
324	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
325	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
326	variables.	511	variables.
327		512
328	=item on_start $term
329
330	Called at the very end of initialisation of a new terminal, just before
331	returning to the mainloop.
332
333	=item on_child_start $term, $pid	513	=item on_child_start $term, $pid
334		514
335	Called just after the child process has been C<fork>ed.	515	Called just after the child process has been C<fork>ed.
336		516
337	=item on_child_exit $term, $status	517	=item on_child_exit $term, $status
…		…
352		532
353	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
354	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
355	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
356		536
357	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.
358		538
359	=item on_sel_extend $term	539	=item on_sel_extend $term
360		540
361	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
362	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
363	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
364	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
365	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
366	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
367		547
368	See the F<selection> example extension.	548	See the F<selection> example extension.
369		549
370	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
371		551
372	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
373	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
374	show this many lines of scrollback.	554	show this many lines of scrollback.
375		555
376	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
377		557
…		…
381		561
382	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,
383	$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
384	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
385		565
386	=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
387		577
388	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
389	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
390	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
391	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,
392	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
393	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	}
394		594
395	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,
396	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
397	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.
398		601
399	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
400		603
401	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
402	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
…		…
407	=item on_tt_write $term, $octets	610	=item on_tt_write $term, $octets
408		611
409	Called whenever some data is written to the tty/pty and can be used to	612	Called whenever some data is written to the tty/pty and can be used to
410	suppress or filter tty input.	613	suppress or filter tty input.
411		614
		615	=item on_tt_paste $term, $octets
		616
		617	Called whenever text is about to be pasted, with the text as argument. You
		618	can filter/change and paste the text yourself by returning a true value
		619	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		620	locale-encoded.
		621
412	=item on_line_update $term, $row	622	=item on_line_update $term, $row
413		623
414	Called whenever a line was updated or changed. Can be used to filter	624	Called whenever a line was updated or changed. Can be used to filter
415	screen output (e.g. underline urls or other useless stuff). Only lines	625	screen output (e.g. underline urls or other useless stuff). Only lines
416	that are being shown will be filtered, and, due to performance reasons,	626	that are being shown will be filtered, and, due to performance reasons,
…		…
423	later with the already-modified line (e.g. if unrelated parts change), so	633	later with the already-modified line (e.g. if unrelated parts change), so
424	you cannot just toggle rendition bits, but only set them.	634	you cannot just toggle rendition bits, but only set them.
425		635
426	=item on_refresh_begin $term	636	=item on_refresh_begin $term
427		637
428	Called just before the screen gets redrawn. Can be used for overlay	638	Called just before the screen gets redrawn. Can be used for overlay or
429	or similar effects by modify terminal contents in refresh_begin, and	639	similar effects by modifying the terminal contents in refresh_begin, and
430	restoring them in refresh_end. The built-in overlay and selection display	640	restoring them in refresh_end. The built-in overlay and selection display
431	code is run after this hook, and takes precedence.	641	code is run after this hook, and takes precedence.
432		642
433	=item on_refresh_end $term	643	=item on_refresh_end $term
434		644
435	Called just after the screen gets redrawn. See C<on_refresh_begin>.	645	Called just after the screen gets redrawn. See C<on_refresh_begin>.
436		646
437	=item on_keyboard_command $term, $string	647	=item on_user_command $term, $string
438		648
439	Called whenever the user presses a key combination that has a	649	Called whenever a user-configured event is being activated (e.g. via
440	C<perl:string> action bound to it (see description of the B<keysym>	650	a C<perl:string> action bound to a key, see description of the B<keysym>
441	resource in the @@RXVT_NAME@@(1) manpage).	651	resource in the @@RXVT_NAME@@(1) manpage).
		652
		653	The event is simply the action string. This interface is assumed to change
		654	slightly in the future.
		655
		656	=item on_resize_all_windows $term, $new_width, $new_height
		657
		658	Called just after the new window size has been calculated, but before
		659	windows are actually being resized or hints are being set. If this hook
		660	returns TRUE, setting of the window hints is being skipped.
442		661
443	=item on_x_event $term, $event	662	=item on_x_event $term, $event
444		663
445	Called on every X event received on the vt window (and possibly other	664	Called on every X event received on the vt window (and possibly other
446	windows). Should only be used as a last resort. Most event structure	665	windows). Should only be used as a last resort. Most event structure
447	members are not passed.	666	members are not passed.
448		667
		668	=item on_root_event $term, $event
		669
		670	Like C<on_x_event>, but is called for events on the root window.
		671
449	=item on_focus_in $term	672	=item on_focus_in $term
450		673
451	Called whenever the window gets the keyboard focus, before rxvt-unicode	674	Called whenever the window gets the keyboard focus, before rxvt-unicode
452	does focus in processing.	675	does focus in processing.
453		676
454	=item on_focus_out $term	677	=item on_focus_out $term
455		678
456	Called wheneever the window loses keyboard focus, before rxvt-unicode does	679	Called whenever the window loses keyboard focus, before rxvt-unicode does
457	focus out processing.	680	focus out processing.
458		681
459	=item on_configure_notify $term, $event	682	=item on_configure_notify $term, $event
460		683
		684	=item on_property_notify $term, $event
		685
461	=item on_key_press $term, $event, $keysym, $octets	686	=item on_key_press $term, $event, $keysym, $octets
462		687
463	=item on_key_release $term, $event, $keysym	688	=item on_key_release $term, $event, $keysym
464		689
465	=item on_button_press $term, $event	690	=item on_button_press $term, $event
…		…
470		695
471	=item on_map_notify $term, $event	696	=item on_map_notify $term, $event
472		697
473	=item on_unmap_notify $term, $event	698	=item on_unmap_notify $term, $event
474		699
475	Called whenever the corresponding X event is received for the terminal If	700	Called whenever the corresponding X event is received for the terminal. If
476	the hook returns true, then the even will be ignored by rxvt-unicode.	701	the hook returns true, then the event will be ignored by rxvt-unicode.
477		702
478	The event is a hash with most values as named by Xlib (see the XEvent	703	The event is a hash with most values as named by Xlib (see the XEvent
479	manpage), with the additional members C<row> and C<col>, which are the row	704	manpage), with the additional members C<row> and C<col>, which are the
480	and column under the mouse cursor.	705	(real, not screen-based) row and column under the mouse cursor.
481		706
482	C<on_key_press> additionally receives the string rxvt-unicode would	707	C<on_key_press> additionally receives the string rxvt-unicode would
483	output, if any, in locale-specific encoding.	708	output, if any, in locale-specific encoding.
484		709
485	subwindow.	710	subwindow.
		711
		712	=item on_client_message $term, $event
		713
		714	=item on_wm_protocols $term, $event
		715
		716	=item on_wm_delete_window $term, $event
		717
		718	Called when various types of ClientMessage events are received (all with
		719	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		720
		721	=item on_bell $term
		722
		723	Called on receipt of a bell character.
486		724
487	=back	725	=back
488		726
489	=cut	727	=cut
490		728
…		…
496	use Scalar::Util ();	734	use Scalar::Util ();
497	use List::Util ();	735	use List::Util ();
498		736
499	our $VERSION = 1;	737	our $VERSION = 1;
500	our $TERM;	738	our $TERM;
		739	our @TERM_INIT;
		740	our @TERM_EXT;
501	our @HOOKNAME;	741	our @HOOKNAME;
502	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	742	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
503	our %OPTION;	743	our %OPTION;
504		744
505	our $LIBDIR;	745	our $LIBDIR;
506	our $RESNAME;	746	our $RESNAME;
507	our $RESCLASS;	747	our $RESCLASS;
508	our $RXVTNAME;	748	our $RXVTNAME;
509		749
		750	our $NOCHAR = chr 0xffff;
		751
510	=head2 Variables in the C<urxvt> Package	752	=head2 Variables in the C<urxvt> Package
511		753
512	=over 4	754	=over 4
513		755
514	=item $urxvt::LIBDIR	756	=item $urxvt::LIBDIR
…		…
526		768
527	=item $urxvt::TERM	769	=item $urxvt::TERM
528		770
529	The current terminal. This variable stores the current C<urxvt::term>	771	The current terminal. This variable stores the current C<urxvt::term>
530	object, whenever a callback/hook is executing.	772	object, whenever a callback/hook is executing.
		773
		774	=item @urxvt::TERM_INIT
		775
		776	All code references in this array will be called as methods of the next newly
		777	created C<urxvt::term> object (during the C<on_init> phase). The array
		778	gets cleared before the code references that were in it are being executed,
		779	so references can push themselves onto it again if they so desire.
		780
		781	This complements to the perl-eval command line option, but gets executed
		782	first.
		783
		784	=item @urxvt::TERM_EXT
		785
		786	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		787	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		788	but before other extensions. Gets cleared just like C<@TERM_INIT>.
531		789
532	=back	790	=back
533		791
534	=head2 Functions in the C<urxvt> Package	792	=head2 Functions in the C<urxvt> Package
535		793
…		…
549		807
550	Using this function has the advantage that its output ends up in the	808	Using this function has the advantage that its output ends up in the
551	correct place, e.g. on stderr of the connecting urxvtc client.	809	correct place, e.g. on stderr of the connecting urxvtc client.
552		810
553	Messages have a size limit of 1023 bytes currently.	811	Messages have a size limit of 1023 bytes currently.
		812
		813	=item @terms = urxvt::termlist
		814
		815	Returns all urxvt::term objects that exist in this process, regardless of
		816	whether they are started, being destroyed etc., so be careful. Only term
		817	objects that have perl extensions attached will be returned (because there
		818	is no urxvt::term objet associated with others).
554		819
555	=item $time = urxvt::NOW	820	=item $time = urxvt::NOW
556		821
557	Returns the "current time" (as per the event loop).	822	Returns the "current time" (as per the event loop).
558		823
…		…
616	Return the foreground/background colour index, respectively.	881	Return the foreground/background colour index, respectively.
617		882
618	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	883	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
619		884
620	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	885	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		886
		887	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
621		888
622	Replace the foreground/background colour in the rendition mask with the	889	Replace the foreground/background colour in the rendition mask with the
623	specified one.	890	specified one.
624		891
625	=item $value = urxvt::GET_CUSTOM $rend	892	=item $value = urxvt::GET_CUSTOM $rend
…		…
644	unless $msg =~ /\n$/;	911	unless $msg =~ /\n$/;
645	urxvt::warn ($msg);	912	urxvt::warn ($msg);
646	};	913	};
647	}	914	}
648		915
		916	no warnings 'utf8';
		917
649	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	918	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
650		919
651	sub verbose {	920	sub verbose {
652	my ($level, $msg) = @_;	921	my ($level, $msg) = @_;
653	warn "$msg\n" if $level <= $verbosity;	922	warn "$msg\n" if $level <= $verbosity;
…		…
656	my %extension_pkg;	925	my %extension_pkg;
657		926
658	# load a single script into its own package, once only	927	# load a single script into its own package, once only
659	sub extension_package($) {	928	sub extension_package($) {
660	my ($path) = @_;	929	my ($path) = @_;
661
662	no strict 'refs';
663		930
664	$extension_pkg{$path} ||= do {	931	$extension_pkg{$path} ||= do {
665	$path =~ /([^\/\\]+)$/;	932	$path =~ /([^\/\\]+)$/;
666	my $pkg = $1;	933	my $pkg = $1;
667	$pkg =~ s/[^[:word:]]/_/g;	934	$pkg =~ s/[^[:word:]]/_/g;
…		…
670	verbose 3, "loading extension '$path' into package '$pkg'";	937	verbose 3, "loading extension '$path' into package '$pkg'";
671		938
672	open my $fh, "<:raw", $path	939	open my $fh, "<:raw", $path
673	or die "$path: $!";	940	or die "$path: $!";
674		941
675	@{"$pkg\::ISA"} = urxvt::term::extension::;
676
677	my $source =	942	my $source =
678	"package $pkg; use strict; use utf8;\n"	943	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
679	. "#line 1 \"$path\"\n{\n"	944	. "#line 1 \"$path\"\n{\n"
680	. (do { local $/; <$fh> })	945	. (do { local $/; <$fh> })
681	. "\n};\n1";	946	. "\n};\n1";
682		947
683	eval $source	948	eval $source
…		…
694	local $TERM = shift;	959	local $TERM = shift;
695	my $htype = shift;	960	my $htype = shift;
696		961
697	if ($htype == 0) { # INIT	962	if ($htype == 0) { # INIT
698	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	963	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
699		964
700	my %ext_arg;	965	my %ext_arg;
701		966
		967	{
		968	my @init = @TERM_INIT;
		969	@TERM_INIT = ();
		970	$_->($TERM) for @init;
		971	my @pkg = @TERM_EXT;
		972	@TERM_EXT = ();
		973	$TERM->register_package ($_) for @pkg;
		974	}
		975
702	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	976	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
703	if ($_ eq "default") {	977	if ($_ eq "default") {
704	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	978	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
705	} elsif (/^-(.*)$/) {	979	} elsif (/^-(.*)$/) {
706	delete $ext_arg{$1};	980	delete $ext_arg{$1};
707	} elsif (/^([^<]+)<(.*)>$/) {	981	} elsif (/^([^<]+)<(.*)>$/) {
708	push @{ $ext_arg{$1} }, $2;	982	push @{ $ext_arg{$1} }, $2;
709	} else {	983	} else {
710	$ext_arg{$_} ||= [];	984	$ext_arg{$_} ||= [];
711	}	985	}
712	}	986	}
713		987
714	while (my ($ext, $argv) = each %ext_arg) {	988	for my $ext (sort keys %ext_arg) {
715	my @files = grep -f $_, map "$_/$ext", @dirs;	989	my @files = grep -f $_, map "$_/$ext", @dirs;
716		990
717	if (@files) {	991	if (@files) {
718	$TERM->register_package (extension_package $files[0], $argv);	992	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
719	} else {	993	} else {
720	warn "perl extension '$ext' not found in perl library search path\n";	994	warn "perl extension '$ext' not found in perl library search path\n";
721	}	995	}
722	}	996	}
723		997
…		…
729		1003
730	if (my $cb = $TERM->{_hook}[$htype]) {	1004	if (my $cb = $TERM->{_hook}[$htype]) {
731	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1005	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
732	if $verbosity >= 10;	1006	if $verbosity >= 10;
733		1007
734	keys %$cb;	1008	for my $pkg (keys %$cb) {
735
736	while (my ($pkg, $cb) = each %$cb) {
737	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1009	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
738	and last;	1010	$retval ||= $retval_;
739		1011
740	if ($@) {	1012	if ($@) {
741	$TERM->ungrab; # better to lose the grab than the session	1013	$TERM->ungrab; # better to lose the grab than the session
742	warn $@;	1014	warn $@;
743	}	1015	}
…		…
754	# clear package	1026	# clear package
755	%$TERM = ();	1027	%$TERM = ();
756	}	1028	}
757		1029
758	$retval	1030	$retval
		1031	}
		1032
		1033	sub SET_COLOR($$$) {
		1034	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1035	}
		1036
		1037	sub rend2mask {
		1038	no strict 'refs';
		1039	my ($str, $mask) = (@_, 0);
		1040	my %color = ( fg => undef, bg => undef );
		1041	my @failed;
		1042	for my $spec ( split /\s+/, $str ) {
		1043	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1044	$color{lc($1)} = $2;
		1045	} else {
		1046	my $neg = $spec =~ s/^[-^]//;
		1047	unless ( exists &{"RS_$spec"} ) {
		1048	push @failed, $spec;
		1049	next;
		1050	}
		1051	my $cur = &{"RS_$spec"};
		1052	if ( $neg ) {
		1053	$mask &= ~$cur;
		1054	} else {
		1055	$mask |= $cur;
		1056	}
		1057	}
		1058	}
		1059	($mask, @color{qw(fg bg)}, \@failed)
759	}	1060	}
760		1061
761	# urxvt::term::extension	1062	# urxvt::term::extension
762		1063
763	package urxvt::term::extension;	1064	package urxvt::term::extension;
…		…
834	is that you cannot use blocking APIs, but the non-blocking variant should	1135	is that you cannot use blocking APIs, but the non-blocking variant should
835	work.	1136	work.
836		1137
837	=cut	1138	=cut
838		1139
839	our $VERSION = 1;	1140	our $VERSION = '5.23';
840		1141
841	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1142	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
842	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1143	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
843		1144
844	sub timer {	1145	sub timer {
…		…
846		1147
847	my $cb = $arg{cb};	1148	my $cb = $arg{cb};
848		1149
849	urxvt::timer	1150	urxvt::timer
850	->new	1151	->new
851	->start (urxvt::NOW + $arg{after})	1152	->after ($arg{after}, $arg{interval})
852	->cb (sub {	1153	->cb ($arg{interval} ? $cb : sub {
853	$_[0]->stop; # need to cancel manually	1154	$_[0]->stop; # need to cancel manually
854	$cb->();	1155	$cb->();
855	})	1156	})
856	}	1157	}
857		1158
858	sub io {	1159	sub io {
859	my ($class, %arg) = @_;	1160	my ($class, %arg) = @_;
860		1161
861	my $cb = $arg{cb};	1162	my $cb = $arg{cb};
		1163	my $fd = fileno $arg{fh};
		1164	defined $fd or $fd = $arg{fh};
862		1165
863	bless [$arg{fh}, urxvt::iow	1166	bless [$arg{fh}, urxvt::iow
864	->new	1167	->new
865	->fd (fileno $arg{fh})	1168	->fd ($fd)
866	->events (($arg{poll} =~ /r/ ? 1 : 0)	1169	->events (($arg{poll} =~ /r/ ? 1 : 0)
867	| ($arg{poll} =~ /w/ ? 2 : 0))	1170	| ($arg{poll} =~ /w/ ? 2 : 0))
868	->start	1171	->start
869	->cb (sub {	1172	->cb ($cb)
870	$cb->(($_[1] & 1 ? 'r' : '')
871	. ($_[1] & 2 ? 'w' : ''));
872	})],
873	urxvt::anyevent::	1173	], urxvt::anyevent::
		1174	}
		1175
		1176	sub idle {
		1177	my ($class, %arg) = @_;
		1178
		1179	my $cb = $arg{cb};
		1180
		1181	urxvt::iw
		1182	->new
		1183	->start
		1184	->cb ($cb)
		1185	}
		1186
		1187	sub child {
		1188	my ($class, %arg) = @_;
		1189
		1190	my $cb = $arg{cb};
		1191
		1192	urxvt::pw
		1193	->new
		1194	->start ($arg{pid})
		1195	->cb (sub {
		1196	$_[0]->stop; # need to cancel manually
		1197	$cb->($_[0]->rpid, $_[0]->rstatus);
		1198	})
874	}	1199	}
875		1200
876	sub DESTROY {	1201	sub DESTROY {
877	$_[0][1]->stop;	1202	$_[0][1]->stop;
878	}	1203	}
879		1204
880	sub condvar {	1205	sub one_event {
881	bless \my $flag, urxvt::anyevent::condvar::
882	}
883
884	sub urxvt::anyevent::condvar::broadcast {
885	${$_[0]}++;
886	}
887
888	sub urxvt::anyevent::condvar::wait {
889	unless (${$_[0]}) {
890	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1206	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
891	}
892	}	1207	}
893		1208
894	package urxvt::term;	1209	package urxvt::term;
895		1210
896	=head2 The C<urxvt::term> Class	1211	=head2 The C<urxvt::term> Class
…		…
901		1216
902	# find on_xxx subs in the package and register them	1217	# find on_xxx subs in the package and register them
903	# as hooks	1218	# as hooks
904	sub register_package {	1219	sub register_package {
905	my ($self, $pkg, $argv) = @_;	1220	my ($self, $pkg, $argv) = @_;
		1221
		1222	no strict 'refs';
		1223
		1224	urxvt::verbose 6, "register package $pkg to $self";
		1225
		1226	@{"$pkg\::ISA"} = urxvt::term::extension::;
906		1227
907	my $proxy = bless {	1228	my $proxy = bless {
908	_pkg => $pkg,	1229	_pkg => $pkg,
909	argv => $argv,	1230	argv => $argv,
910	}, $pkg;	1231	}, $pkg;
…		…
926	hash which defines the environment of the new terminal.	1247	hash which defines the environment of the new terminal.
927		1248
928	Croaks (and probably outputs an error message) if the new instance	1249	Croaks (and probably outputs an error message) if the new instance
929	couldn't be created. Returns C<undef> if the new instance didn't	1250	couldn't be created. Returns C<undef> if the new instance didn't
930	initialise perl, and the terminal object otherwise. The C<init> and	1251	initialise perl, and the terminal object otherwise. The C<init> and
931	C<start> hooks will be called during this call.	1252	C<start> hooks will be called before this call returns, and are free to
		1253	refer to global data (which is race free).
932		1254
933	=cut	1255	=cut
934		1256
935	sub new {	1257	sub new {
936	my ($class, $env, @args) = @_;	1258	my ($class, $env, @args) = @_;
937		1259
		1260	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1261	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1262
938	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1263	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
939	}	1264	}
940		1265
941	=item $term->destroy	1266	=item $term->destroy
942		1267
943	Destroy the terminal object (close the window, free resources	1268	Destroy the terminal object (close the window, free resources
…		…
973		1298
974	Returns true if the option specified by C<$optval> is enabled, and	1299	Returns true if the option specified by C<$optval> is enabled, and
975	optionally change it. All option values are stored by name in the hash	1300	optionally change it. All option values are stored by name in the hash
976	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1301	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
977		1302
978	Here is a a likely non-exhaustive list of option names, please see the	1303	Here is a likely non-exhaustive list of option names, please see the
979	source file F</src/optinc.h> to see the actual list:	1304	source file F</src/optinc.h> to see the actual list:
980		1305
981	borderLess console cursorBlink cursorUnderline hold iconic insecure	1306	borderLess console cursorBlink cursorUnderline hold iconic insecure
982	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1307	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
983	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1308	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1000	likely change).	1325	likely change).
1001		1326
1002	Please note that resource strings will currently only be freed when the	1327	Please note that resource strings will currently only be freed when the
1003	terminal is destroyed, so changing options frequently will eat memory.	1328	terminal is destroyed, so changing options frequently will eat memory.
1004		1329
1005	Here is a a likely non-exhaustive list of resource names, not all of which	1330	Here is a likely non-exhaustive list of resource names, not all of which
1006	are supported in every build, please see the source file F</src/rsinc.h>	1331	are supported in every build, please see the source file F</src/rsinc.h>
1007	to see the actual list:	1332	to see the actual list:
1008		1333
1009	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1334	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1010	borderLess color cursorBlink cursorUnderline cutchars delete_key	1335	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1011	display_name embed ext_bwidth fade font geometry hold iconName	1336	display_name embed ext_bwidth fade font geometry hold iconName
1012	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1337	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1013	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1338	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1014	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1339	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1015	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1340	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1016	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1341	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1017	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1342	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1018	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1343	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1019	secondaryScreen secondaryScroll selectstyle shade term_name title	1344	secondaryScreen secondaryScroll shade term_name title
1020	transient_for transparent transparent_all tripleclickwords utmpInhibit	1345	transient_for transparent transparent_all tripleclickwords utmpInhibit
1021	visualBell	1346	visualBell
1022		1347
1023	=cut	1348	=cut
1024		1349
1025	sub resource($$;$) {	1350	sub resource($$;$) {
1026	my ($self, $name) = (shift, shift);	1351	my ($self, $name) = (shift, shift);
1027	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1352	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1028	&urxvt::term::_resource	1353	goto &urxvt::term::_resource
1029	}	1354	}
1030		1355
1031	=item $value = $term->x_resource ($pattern)	1356	=item $value = $term->x_resource ($pattern)
1032		1357
1033	Returns the X-Resource for the given pattern, excluding the program or	1358	Returns the X-Resource for the given pattern, excluding the program or
…		…
1058		1383
1059	=item ($row, $col) = $term->selection_beg ([$row, $col])	1384	=item ($row, $col) = $term->selection_beg ([$row, $col])
1060		1385
1061	=item ($row, $col) = $term->selection_end ([$row, $col])	1386	=item ($row, $col) = $term->selection_end ([$row, $col])
1062		1387
1063	Return the current values of the selection mark, begin or end positions,	1388	Return the current values of the selection mark, begin or end positions.
1064	and optionally set them to new values.	1389
		1390	When arguments are given, then the selection coordinates are set to
		1391	C<$row> and C<$col>, and the selection screen is set to the current
		1392	screen.
		1393
		1394	=item $screen = $term->selection_screen ([$screen])
		1395
		1396	Returns the current selection screen, and then optionally sets it.
1065		1397
1066	=item $term->selection_make ($eventtime[, $rectangular])	1398	=item $term->selection_make ($eventtime[, $rectangular])
1067		1399
1068	Tries to make a selection as set by C<selection_beg> and	1400	Tries to make a selection as set by C<selection_beg> and
1069	C<selection_end>. If C<$rectangular> is true (default: false), a	1401	C<selection_end>. If C<$rectangular> is true (default: false), a
1070	rectangular selection will be made. This is the prefered function to make	1402	rectangular selection will be made. This is the preferred function to make
1071	a selection.	1403	a selection.
1072		1404
1073	=item $success = $term->selection_grab ($eventtime)	1405	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1074		1406
1075	Try to request the primary selection text from the server (for example, as	1407	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1408	true) selection from the server. The corresponding text can be set
1076	set by the next method). No visual feedback will be given. This function	1409	with the next method. No visual feedback will be given. This function
1077	is mostly useful from within C<on_sel_grab> hooks.	1410	is mostly useful from within C<on_sel_grab> hooks.
1078		1411
1079	=item $oldtext = $term->selection ([$newtext])	1412	=item $oldtext = $term->selection ([$newtext, $clipboard])
1080		1413
1081	Return the current selection text and optionally replace it by C<$newtext>.	1414	Return the current selection (clipboard if C<$clipboard> is true) text
		1415	and optionally replace it by C<$newtext>.
		1416
		1417	=item $term->selection_clear ([$clipboard])
		1418
		1419	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1082		1420
1083	=item $term->overlay_simple ($x, $y, $text)	1421	=item $term->overlay_simple ($x, $y, $text)
1084		1422
1085	Create a simple multi-line overlay box. See the next method for details.	1423	Create a simple multi-line overlay box. See the next method for details.
1086		1424
…		…
1116		1454
1117	The methods currently supported on C<urxvt::overlay> objects are:	1455	The methods currently supported on C<urxvt::overlay> objects are:
1118		1456
1119	=over 4	1457	=over 4
1120		1458
1121	=item $overlay->set ($x, $y, $text, $rend)	1459	=item $overlay->set ($x, $y, $text[, $rend])
1122		1460
1123	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1461	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1124	text in rxvt-unicode's special encoding and an array of rendition values	1462	text in rxvt-unicode's special encoding and an array of rendition values
1125	at a specific position inside the overlay.	1463	at a specific position inside the overlay.
		1464
		1465	If C<$rend> is missing, then the rendition will not be changed.
1126		1466
1127	=item $overlay->hide	1467	=item $overlay->hide
1128		1468
1129	If visible, hide the overlay, but do not destroy it.	1469	If visible, hide the overlay, but do not destroy it.
1130		1470
…		…
1200		1540
1201	Normally its not a good idea to use this function, as programs might be	1541	Normally its not a good idea to use this function, as programs might be
1202	confused by changes in cursor position or scrolling. Its useful inside a	1542	confused by changes in cursor position or scrolling. Its useful inside a
1203	C<on_add_lines> hook, though.	1543	C<on_add_lines> hook, though.
1204		1544
		1545	=item $term->scr_change_screen ($screen)
		1546
		1547	Switch to given screen - 0 primary, 1 secondary.
		1548
1205	=item $term->cmd_parse ($octets)	1549	=item $term->cmd_parse ($octets)
1206		1550
1207	Similar to C<scr_add_lines>, but the argument must be in the	1551	Similar to C<scr_add_lines>, but the argument must be in the
1208	locale-specific encoding of the terminal and can contain command sequences	1552	locale-specific encoding of the terminal and can contain command sequences
1209	(escape codes) that will be interpreted.	1553	(escape codes) that will be interpreted.
1210		1554
1211	=item $term->tt_write ($octets)	1555	=item $term->tt_write ($octets)
1212		1556
1213	Write the octets given in C<$data> to the tty (i.e. as program input). To	1557	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1214	pass characters instead of octets, you should convert your strings first	1558	pass characters instead of octets, you should convert your strings first
1215	to the locale-specific encoding using C<< $term->locale_encode >>.	1559	to the locale-specific encoding using C<< $term->locale_encode >>.
		1560
		1561	=item $term->tt_paste ($octets)
		1562
		1563	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1564	CR and bracketing the data with control sequences if bracketed paste mode
		1565	is set.
1216		1566
1217	=item $old_events = $term->pty_ev_events ([$new_events])	1567	=item $old_events = $term->pty_ev_events ([$new_events])
1218		1568
1219	Replaces the event mask of the pty watcher by the given event mask. Can	1569	Replaces the event mask of the pty watcher by the given event mask. Can
1220	be used to suppress input and output handling to the pty/tty. See the	1570	be used to suppress input and output handling to the pty/tty. See the
1221	description of C<< urxvt::timer->events >>. Make sure to always restore	1571	description of C<< urxvt::timer->events >>. Make sure to always restore
1222	the previous value.	1572	the previous value.
1223		1573
		1574	=item $fd = $term->pty_fd
		1575
		1576	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1577	is used.
		1578
1224	=item $windowid = $term->parent	1579	=item $windowid = $term->parent
1225		1580
1226	Return the window id of the toplevel window.	1581	Return the window id of the toplevel window.
1227		1582
1228	=item $windowid = $term->vt	1583	=item $windowid = $term->vt
…		…
1234	Adds the specified events to the vt event mask. Useful e.g. when you want	1589	Adds the specified events to the vt event mask. Useful e.g. when you want
1235	to receive pointer events all the times:	1590	to receive pointer events all the times:
1236		1591
1237	$term->vt_emask_add (urxvt::PointerMotionMask);	1592	$term->vt_emask_add (urxvt::PointerMotionMask);
1238		1593
		1594	=item $term->focus_in
		1595
		1596	=item $term->focus_out
		1597
		1598	=item $term->key_press ($state, $keycode[, $time])
		1599
		1600	=item $term->key_release ($state, $keycode[, $time])
		1601
		1602	Deliver various fake events to to terminal.
		1603
1239	=item $window_width = $term->width	1604	=item $window_width = $term->width
1240		1605
1241	=item $window_height = $term->height	1606	=item $window_height = $term->height
1242		1607
1243	=item $font_width = $term->fwidth	1608	=item $font_width = $term->fwidth
…		…
1273	=item $env = $term->env	1638	=item $env = $term->env
1274		1639
1275	Returns a copy of the environment in effect for the terminal as a hashref	1640	Returns a copy of the environment in effect for the terminal as a hashref
1276	similar to C<\%ENV>.	1641	similar to C<\%ENV>.
1277		1642
		1643	=item @envv = $term->envv
		1644
		1645	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1646
		1647	=item @argv = $term->argv
		1648
		1649	Return the argument vector as this terminal, similar to @ARGV, but
		1650	includes the program name as first element.
		1651
1278	=cut	1652	=cut
1279		1653
1280	sub env {	1654	sub env {
1281	if (my $env = $_[0]->_env) {
1282	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1655	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1283	} else {
1284	+{ %ENV }
1285	}
1286	}	1656	}
1287		1657
1288	=item $modifiermask = $term->ModLevel3Mask	1658	=item $modifiermask = $term->ModLevel3Mask
1289		1659
1290	=item $modifiermask = $term->ModMetaMask	1660	=item $modifiermask = $term->ModMetaMask
1291		1661
1292	=item $modifiermask = $term->ModNumLockMask	1662	=item $modifiermask = $term->ModNumLockMask
1293		1663
1294	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1664	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1295	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1665	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1666
		1667	=item $screen = $term->current_screen
		1668
		1669	Returns the currently displayed screen (0 primary, 1 secondary).
		1670
		1671	=item $cursor_is_hidden = $term->hidden_cursor
		1672
		1673	Returns whether the cursor is currently hidden or not.
1296		1674
1297	=item $view_start = $term->view_start ([$newvalue])	1675	=item $view_start = $term->view_start ([$newvalue])
1298		1676
1299	Returns the row number of the topmost displayed line. Maximum value is	1677	Returns the row number of the topmost displayed line. Maximum value is
1300	C<0>, which displays the normal terminal contents. Lower values scroll	1678	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1308		1686
1309	Used after changing terminal contents to display them.	1687	Used after changing terminal contents to display them.
1310		1688
1311	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1689	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1312		1690
1313	Returns the text of the entire row with number C<$row_number>. Row C<0>	1691	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1314	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1692	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1315	terminal line. The scrollback buffer starts at line C<-1> and extends to
1316	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1693	terminal line. Nothing will be returned if a nonexistent line
1317	is requested.	1694	is requested.
1318		1695
1319	If C<$new_text> is specified, it will replace characters in the current	1696	If C<$new_text> is specified, it will replace characters in the current
1320	line, starting at column C<$start_col> (default C<0>), which is useful	1697	line, starting at column C<$start_col> (default C<0>), which is useful
1321	to replace only parts of a line. The font index in the rendition will	1698	to replace only parts of a line. The font index in the rendition will
1322	automatically be updated.	1699	automatically be updated.
1323		1700
1324	C<$text> is in a special encoding: tabs and wide characters that use more	1701	C<$text> is in a special encoding: tabs and wide characters that use more
1325	than one cell when displayed are padded with urxvt::NOCHAR characters	1702	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1326	(C<chr 65535>). Characters with combining characters and other characters	1703	characters. Characters with combining characters and other characters that
1327	that do not fit into the normal tetx encoding will be replaced with	1704	do not fit into the normal text encoding will be replaced with characters
1328	characters in the private use area.	1705	in the private use area.
1329		1706
1330	You have to obey this encoding when changing text. The advantage is	1707	You have to obey this encoding when changing text. The advantage is
1331	that C<substr> and similar functions work on screen cells and not on	1708	that C<substr> and similar functions work on screen cells and not on
1332	characters.	1709	characters.
1333		1710
…		…
1477	where one character corresponds to one screen cell. See	1854	where one character corresponds to one screen cell. See
1478	C<< $term->ROW_t >> for details.	1855	C<< $term->ROW_t >> for details.
1479		1856
1480	=item $string = $term->special_decode $text	1857	=item $string = $term->special_decode $text
1481		1858
1482	Converts rxvt-unicodes text reprsentation into a perl string. See	1859	Converts rxvt-unicodes text representation into a perl string. See
1483	C<< $term->ROW_t >> for details.	1860	C<< $term->ROW_t >> for details.
1484		1861
1485	=item $success = $term->grab_button ($button, $modifiermask)	1862	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1486		1863
		1864	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1865
1487	Registers a synchronous button grab. See the XGrabButton manpage.	1866	Register/unregister a synchronous button grab. See the XGrabButton
		1867	manpage.
1488		1868
1489	=item $success = $term->grab ($eventtime[, $sync])	1869	=item $success = $term->grab ($eventtime[, $sync])
1490		1870
1491	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1871	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1492	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1872	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1493		1873
1494	=item $term->allow_events_async	1874	=item $term->allow_events_async
1495		1875
1496	Calls XAllowEvents with AsyncBoth for the most recent grab.	1876	Calls XAllowEvents with AsyncBoth for the most recent grab.
1497		1877
…		…
1504	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1884	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1505	recent grab.	1885	recent grab.
1506		1886
1507	=item $term->ungrab	1887	=item $term->ungrab
1508		1888
1509	Calls XUngrab for the most recent grab. Is called automatically on	1889	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1510	evaluation errors, as it is better to lose the grab in the error case as	1890	evaluation errors, as it is better to lose the grab in the error case as
1511	the session.	1891	the session.
		1892
		1893	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1894
		1895	=item $atom_name = $term->XGetAtomName ($atom)
		1896
		1897	=item @atoms = $term->XListProperties ($window)
		1898
		1899	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1900
		1901	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1902
		1903	=item $term->XDeleteProperty ($window, $property)
		1904
		1905	=item $window = $term->DefaultRootWindow
		1906
		1907	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1908
		1909	=item $term->XMapWindow ($window)
		1910
		1911	=item $term->XUnmapWindow ($window)
		1912
		1913	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1914
		1915	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1916
		1917	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1918
		1919	Various X or X-related functions. The C<$term> object only serves as
		1920	the source of the display, otherwise those functions map more-or-less
		1921	directly onto the X functions of the same name.
1512		1922
1513	=back	1923	=back
1514		1924
1515	=cut	1925	=cut
1516		1926
…		…
1580	my ($self, $text, $cb) = @_;	1990	my ($self, $text, $cb) = @_;
1581		1991
1582	$self->add_item ({ type => "button", text => $text, activate => $cb});	1992	$self->add_item ({ type => "button", text => $text, activate => $cb});
1583	}	1993	}
1584		1994
1585	=item $popup->add_toggle ($text, $cb, $initial_value)	1995	=item $popup->add_toggle ($text, $initial_value, $cb)
1586		1996
1587	Adds a toggle/checkbox item to the popup. Teh callback gets called	1997	Adds a toggle/checkbox item to the popup. The callback gets called
1588	whenever it gets toggled, with a boolean indicating its value as its first	1998	whenever it gets toggled, with a boolean indicating its new value as its
1589	argument.	1999	first argument.
1590		2000
1591	=cut	2001	=cut
1592		2002
1593	sub add_toggle {	2003	sub add_toggle {
1594	my ($self, $text, $cb, $value) = @_;	2004	my ($self, $text, $value, $cb) = @_;
1595		2005
1596	my $item; $item = {	2006	my $item; $item = {
1597	type => "button",	2007	type => "button",
1598	text => " $text",	2008	text => " $text",
1599	value => $value,	2009	value => $value,
…		…
1618	my $env = $self->{term}->env;	2028	my $env = $self->{term}->env;
1619	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2029	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1620	delete $env->{LC_ALL};	2030	delete $env->{LC_ALL};
1621	$env->{LC_CTYPE} = $self->{term}->locale;	2031	$env->{LC_CTYPE} = $self->{term}->locale;
1622		2032
1623	urxvt::term->new ($env, "popup",	2033	my $term = urxvt::term->new (
		2034	$env, "popup",
1624	"--perl-lib" => "", "--perl-ext-common" => "",	2035	"--perl-lib" => "", "--perl-ext-common" => "",
1625	"-pty-fd" => -1, "-sl" => 0,	2036	"-pty-fd" => -1, "-sl" => 0,
1626	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2037	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1627	"--transient-for" => $self->{term}->parent,	2038	"--transient-for" => $self->{term}->parent,
1628	"-display" => $self->{term}->display_id,	2039	"-display" => $self->{term}->display_id,
1629	"-pe" => "urxvt-popup")	2040	"-pe" => "urxvt-popup",
1630	or die "unable to create popup window\n";	2041	) or die "unable to create popup window\n";
		2042
		2043	unless (delete $term->{urxvt_popup_init_done}) {
		2044	$term->ungrab;
		2045	$term->destroy;
		2046	die "unable to initialise popup window\n";
		2047	}
1631	}	2048	}
1632		2049
1633	sub DESTROY {	2050	sub DESTROY {
1634	my ($self) = @_;	2051	my ($self) = @_;
1635		2052
1636	delete $self->{term}{_destroy}{$self};	2053	delete $self->{term}{_destroy}{$self};
1637	$self->{term}->ungrab;	2054	$self->{term}->ungrab;
1638	}	2055	}
1639		2056
1640	=back	2057	=back
		2058
		2059	=cut
		2060
		2061	package urxvt::watcher;
1641		2062
1642	=head2 The C<urxvt::timer> Class	2063	=head2 The C<urxvt::timer> Class
1643		2064
1644	This class implements timer watchers/events. Time is represented as a	2065	This class implements timer watchers/events. Time is represented as a
1645	fractional number of seconds since the epoch. Example:	2066	fractional number of seconds since the epoch. Example:
…		…
1649	->new	2070	->new
1650	->interval (1)	2071	->interval (1)
1651	->cb (sub {	2072	->cb (sub {
1652	$term->{overlay}->set (0, 0,	2073	$term->{overlay}->set (0, 0,
1653	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2074	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1654	});	2075	});
1655		2076
1656	=over 4	2077	=over 4
1657		2078
1658	=item $timer = new urxvt::timer	2079	=item $timer = new urxvt::timer
1659		2080
…		…
1662		2083
1663	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2084	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1664		2085
1665	Set the callback to be called when the timer triggers.	2086	Set the callback to be called when the timer triggers.
1666		2087
1667	=item $tstamp = $timer->at
1668
1669	Return the time this watcher will fire next.
1670
1671	=item $timer = $timer->set ($tstamp)	2088	=item $timer = $timer->set ($tstamp[, $interval])
1672		2089
1673	Set the time the event is generated to $tstamp.	2090	Set the time the event is generated to $tstamp (and optionally specifies a
		2091	new $interval).
1674		2092
1675	=item $timer = $timer->interval ($interval)	2093	=item $timer = $timer->interval ($interval)
1676		2094
1677	Normally (and when C<$interval> is C<0>), the timer will automatically	2095	By default (and when C<$interval> is C<0>), the timer will automatically
1678	stop after it has fired once. If C<$interval> is non-zero, then the timer	2096	stop after it has fired once. If C<$interval> is non-zero, then the timer
1679	is automatically rescheduled at the given intervals.	2097	is automatically rescheduled at the given intervals.
1680		2098
1681	=item $timer = $timer->start	2099	=item $timer = $timer->start
1682		2100
1683	Start the timer.	2101	Start the timer.
1684		2102
1685	=item $timer = $timer->start ($tstamp)	2103	=item $timer = $timer->start ($tstamp[, $interval])
1686		2104
1687	Set the event trigger time to C<$tstamp> and start the timer.	2105	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2106	also replaces the interval.
1688		2107
1689	=item $timer = $timer->after ($delay)	2108	=item $timer = $timer->after ($delay[, $interval])
1690		2109
1691	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2110	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1692		2111
1693	=item $timer = $timer->stop	2112	=item $timer = $timer->stop
1694		2113
…		…
1702		2121
1703	$term->{socket} = ...	2122	$term->{socket} = ...
1704	$term->{iow} = urxvt::iow	2123	$term->{iow} = urxvt::iow
1705	->new	2124	->new
1706	->fd (fileno $term->{socket})	2125	->fd (fileno $term->{socket})
1707	->events (urxvt::EVENT_READ)	2126	->events (urxvt::EV_READ)
1708	->start	2127	->start
1709	->cb (sub {	2128	->cb (sub {
1710	my ($iow, $revents) = @_;	2129	my ($iow, $revents) = @_;
1711	# $revents must be 1 here, no need to check	2130	# $revents must be 1 here, no need to check
1712	sysread $term->{socket}, my $buf, 8192	2131	sysread $term->{socket}, my $buf, 8192
…		…
1725	Set the callback to be called when io events are triggered. C<$reventmask>	2144	Set the callback to be called when io events are triggered. C<$reventmask>
1726	is a bitset as described in the C<events> method.	2145	is a bitset as described in the C<events> method.
1727		2146
1728	=item $iow = $iow->fd ($fd)	2147	=item $iow = $iow->fd ($fd)
1729		2148
1730	Set the filedescriptor (not handle) to watch.	2149	Set the file descriptor (not handle) to watch.
1731		2150
1732	=item $iow = $iow->events ($eventmask)	2151	=item $iow = $iow->events ($eventmask)
1733		2152
1734	Set the event mask to watch. The only allowed values are	2153	Set the event mask to watch. The only allowed values are
1735	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2154	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1736	together, or C<urxvt::EVENT_NONE>.	2155	together, or C<urxvt::EV_NONE>.
1737		2156
1738	=item $iow = $iow->start	2157	=item $iow = $iow->start
1739		2158
1740	Start watching for requested events on the given handle.	2159	Start watching for requested events on the given handle.
1741		2160
1742	=item $iow = $iow->stop	2161	=item $iow = $iow->stop
1743		2162
1744	Stop watching for events on the given filehandle.	2163	Stop watching for events on the given file handle.
		2164
		2165	=back
		2166
		2167	=head2 The C<urxvt::iw> Class
		2168
		2169	This class implements idle watchers, that get called automatically when
		2170	the process is idle. They should return as fast as possible, after doing
		2171	some useful work.
		2172
		2173	=over 4
		2174
		2175	=item $iw = new urxvt::iw
		2176
		2177	Create a new idle watcher object in stopped state.
		2178
		2179	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2180
		2181	Set the callback to be called when the watcher triggers.
		2182
		2183	=item $timer = $timer->start
		2184
		2185	Start the watcher.
		2186
		2187	=item $timer = $timer->stop
		2188
		2189	Stop the watcher.
		2190
		2191	=back
		2192
		2193	=head2 The C<urxvt::pw> Class
		2194
		2195	This class implements process watchers. They create an event whenever a
		2196	process exits, after which they stop automatically.
		2197
		2198	my $pid = fork;
		2199	...
		2200	$term->{pw} = urxvt::pw
		2201	->new
		2202	->start ($pid)
		2203	->cb (sub {
		2204	my ($pw, $exit_status) = @_;
		2205	...
		2206	});
		2207
		2208	=over 4
		2209
		2210	=item $pw = new urxvt::pw
		2211
		2212	Create a new process watcher in stopped state.
		2213
		2214	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2215
		2216	Set the callback to be called when the timer triggers.
		2217
		2218	=item $pw = $timer->start ($pid)
		2219
		2220	Tells the watcher to start watching for process C<$pid>.
		2221
		2222	=item $pw = $pw->stop
		2223
		2224	Stop the watcher.
1745		2225
1746	=back	2226	=back
1747		2227
1748	=head1 ENVIRONMENT	2228	=head1 ENVIRONMENT
1749		2229
…		…
1758		2238
1759	=item >= 3 - script loading and management	2239	=item >= 3 - script loading and management
1760		2240
1761	=item >=10 - all called hooks	2241	=item >=10 - all called hooks
1762		2242
1763	=item >=11 - hook reutrn values	2243	=item >=11 - hook return values
1764		2244
1765	=back	2245	=back
1766		2246
1767	=head1 AUTHOR	2247	=head1 AUTHOR
1768		2248
…		…
1770	http://software.schmorp.de/pkg/rxvt-unicode	2250	http://software.schmorp.de/pkg/rxvt-unicode
1771		2251
1772	=cut	2252	=cut
1773		2253
1774	1	2254	1
		2255
		2256	# vim: sw=3:

Diff Legend

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