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.113 by root, Fri Jan 20 10:27:08 2006 UTC vs.
Revision 1.200 by sf-exg, Sun Nov 20 10:58:58 2011 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	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
66	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
67	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
68	between two vertical bars:	71	between two vertical bars:
69		72
70	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: ^(/[^:]+):\
71		81
72	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
73	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
74		84
75	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
87	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
88		98
89	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
90	runtime.	100	runtime.
91		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
92	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
93		120
94	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
95	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
96	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
97		124
98	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100	popup is displayed.	127	popup is being displayed.
101		128
102	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
103	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.
104	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
105	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
106	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
107		134
108	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
109	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
110	C<a>s:	137	C<a>s:
111		138
112	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
114	: ()	141	: ()
115	};	142	};
116		143
117	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
118		145
…		…
125	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>
126	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
127	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
128	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
129	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
130	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.
131		189
132	=item selection-autotransform	190	=item selection-autotransform
133		191
134	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
135	whenever a selection is made.	193	whenever a selection is made.
…		…
162		220
163	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
164	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
165	the message into vi commands to load the file.	223	the message into vi commands to load the file.
166		224
167	=item mark-urls	225	=item tabbed
168		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
169	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
170	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
171	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
172	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.
173		258
174	=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.
175		263
176	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 or a list of matches
177	to the window position, in effect creating the same effect as pseudo transparency with	265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
178	a custom pixmap. No scaling is supported in this mode. Exmaple:	266	"perl:matcher:list" as seen in the example below.
179		267
180	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	268	Example configuration:
		269
		270	URxvt.perl-ext: default,matcher
		271	URxvt.urlLauncher: sensible-browser
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
		274	URxvt.matcher.button: 1
		275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		277	URxvt.matcher.launcher.2: gvim +$2 $1
		278
		279	=item xim-onthespot
		280
		281	This (experimental) perl extension implements OnTheSpot editing. It does
		282	not work perfectly, and some input methods don't seem to work well with
		283	OnTheSpot editing in general, but it seems to work at least for SCIM and
		284	kinput2.
		285
		286	You enable it by specifying this extension and a preedit style of
		287	C<OnTheSpot>, i.e.:
		288
		289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		290
		291	=item kuake<hotkey>
		292
		293	A very primitive quake-console-like extension. It was inspired by a
		294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		295	user presses a global accelerator key (by default C<F10>), the terminal
		296	will show or hide itself. Another press of the accelerator key will hide
		297	or show it again.
		298
		299	Initially, the window will not be shown when using this extension.
		300
		301	This is useful if you need a single terminal that is not using any desktop
		302	space most of the time but is quickly available at the press of a key.
		303
		304	The accelerator key is grabbed regardless of any modifiers, so this
		305	extension will actually grab a physical key just for this function.
		306
		307	If you want a quake-like animation, tell your window manager to do so
		308	(fvwm can do it).
		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
181		315
182	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
183		317
184	A not very useful example of filtering all text output to the terminal,	318	A not very useful example of filtering all text output to the terminal
185	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
186	similar-looking ascii character.	320	similar-looking ascii character.
187		321
188	=item digital-clock	322	=item digital-clock
189		323
190	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
		325
		326	=item remote-clipboard
		327
		328	Somewhat of a misnomer, this extension adds two menu entries to the
		329	selection popup that allows one to run external commands to store the
		330	selection somewhere and fetch it again.
		331
		332	We use it to implement a "distributed selection mechanism", which just
		333	means that one command uploads the file to a remote server, and another
		334	reads it.
		335
		336	The commands can be set using the C<URxvt.remote-selection.store> and
		337	C<URxvt.remote-selection.fetch> resources. The first should read the
		338	selection to store from STDIN (always in UTF-8), the second should provide
		339	the selection data on STDOUT (also in UTF-8).
		340
		341	The defaults (which are likely useless to you) use rsh and cat:
		342
		343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		345
		346	=item selection-pastebin
		347
		348	This is a little rarely useful extension that uploads the selection as
		349	textfile to a remote site (or does other things). (The implementation is
		350	not currently secure for use in a multiuser environment as it writes to
		351	F</tmp> directly.).
		352
		353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		354	i.e.
		355
		356	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		357
		358	Pressing this combination runs a command with C<%> replaced by the name of
		359	the textfile. This command can be set via a resource:
		360
		361	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		362
		363	And the default is likely not useful to anybody but the few people around
		364	here :)
		365
		366	The name of the textfile is the hex encoded md5 sum of the selection, so
		367	the same content should lead to the same filename.
		368
		369	After a successful upload the selection will be replaced by the text given
		370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		371	for the filename):
		372
		373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		374
		375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		376	the double C</> characters as comment start. Use C<\057\057> instead,
		377	which works regardless of whether xrdb is used to parse the resource file
		378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
191		393
192	=item example-refresh-hooks	394	=item example-refresh-hooks
193		395
194	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
195	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
196	overlays or changes.	398	overlays or changes.
197		399
198	=item selection-pastebin	400	=item confirm-paste
199		401
200	This is a little rarely useful extension that Uploads the selection as	402	Displays a confirmation dialog when a paste containing at least a full
201	textfile to a remote site (or does other things). (The implementation is	403	line is detected.
202	not currently secure for use in a multiuser environment as it writes to
203	F</tmp> directly.).
204		404
205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	405	=item bell-command
206	i.e.
207		406
208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin	407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
209		410
210	Pressing this combination runs a command with C<%> replaced by the name of	411	URxvt.bell-command: notify-send "Beep, Beep"
211	the textfile. This command can be set via a resource:
212
213	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214
215	And the default is likely not useful to anybody but the few people around
216	here :)
217
218	The name of the textfile is the hex encoded md5 sum of the selection, so
219	the same content should lead to the same filename.
220
221	After a successful upload the selection will be replaced by the text given
222	in the C<selection-pastebin-url> resource (again, the % is the placeholder
223	for the filename):
224
225	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
226		412
227	=back	413	=back
228		414
229	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
230		416
…		…
246		432
247	=over 4	433	=over 4
248		434
249	=item $text	435	=item $text
250		436
251	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
252	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
253		439
254	=item $string	440	=item $string
255		441
256	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
264		450
265	=back	451	=back
266		452
267	=head2 Extension Objects	453	=head2 Extension Objects
268		454
269	Very perl extension is a perl class. A separate perl object is created	455	Every perl extension is a perl class. A separate perl object is created
270	for each terminal and each extension and passed as the first parameter to	456	for each terminal, and each terminal has its own set of extension objects,
271	hooks. So extensions can use their C<$self> object without having to think	457	which are passed as the first parameter to hooks. So extensions can use
272	about other extensions, with the exception of methods and members that	458	their C<$self> object without having to think about clashes with other
		459	extensions or other terminals, with the exception of methods and members
273	begin with an underscore character C<_>: these are reserved for internal	460	that begin with an underscore character C<_>: these are reserved for
274	use.	461	internal use.
275		462
276	Although it isn't a C<urxvt::term> object, you can call all methods of the	463	Although it isn't a C<urxvt::term> object, you can call all methods of the
277	C<urxvt::term> class on this object.	464	C<urxvt::term> class on this object.
278		465
279	It has the following methods and data members:	466	It has the following methods and data members:
…		…
300	=head2 Hooks	487	=head2 Hooks
301		488
302	The following subroutines can be declared in extension files, and will be	489	The following subroutines can be declared in extension files, and will be
303	called whenever the relevant event happens.	490	called whenever the relevant event happens.
304		491
305	The first argument passed to them is an extension oject as described in	492	The first argument passed to them is an extension object as described in
306	the in the C<Extension Objects> section.	493	the in the C<Extension Objects> section.
307		494
308	B<All> of these hooks must return a boolean value. If any of the called	495	B<All> of these hooks must return a boolean value. If any of the called
309	hooks returns true, then the event counts as being I<consumed>, and the	496	hooks returns true, then the event counts as being I<consumed>, and the
310	relevant action might not be carried out by the C++ code.	497	relevant action might not be carried out by the C++ code.
…		…
323	place.	510	place.
324		511
325	=item on_start $term	512	=item on_start $term
326		513
327	Called at the very end of initialisation of a new terminal, just before	514	Called at the very end of initialisation of a new terminal, just before
328	trying to map (display) the toplevel and returning to the mainloop.	515	trying to map (display) the toplevel and returning to the main loop.
329		516
330	=item on_destroy $term	517	=item on_destroy $term
331		518
332	Called whenever something tries to destroy terminal, before doing anything	519	Called whenever something tries to destroy terminal, when the terminal is
333	yet. If this hook returns true, then destruction is skipped, but this is	520	still fully functional (not for long, though).
334	rarely a good idea.
335		521
336	=item on_reset $term	522	=item on_reset $term
337		523
338	Called after the screen is "reset" for any reason, such as resizing or	524	Called after the screen is "reset" for any reason, such as resizing or
339	control sequences. Here is where you can react on changes to size-related	525	control sequences. Here is where you can react on changes to size-related
…		…
361		547
362	Called whenever a selection has been copied, but before the selection is	548	Called whenever a selection has been copied, but before the selection is
363	requested from the server. The selection text can be queried and changed	549	requested from the server. The selection text can be queried and changed
364	by calling C<< $term->selection >>.	550	by calling C<< $term->selection >>.
365		551
366	Returning a true value aborts selection grabbing. It will still be hilighted.	552	Returning a true value aborts selection grabbing. It will still be highlighted.
367		553
368	=item on_sel_extend $term	554	=item on_sel_extend $term
369		555
370	Called whenever the user tries to extend the selection (e.g. with a double	556	Called whenever the user tries to extend the selection (e.g. with a double
371	click) and is either supposed to return false (normal operation), or	557	click) and is either supposed to return false (normal operation), or
372	should extend the selection itelf and return true to suppress the built-in	558	should extend the selection itself and return true to suppress the built-in
373	processing. This can happen multiple times, as long as the callback	559	processing. This can happen multiple times, as long as the callback
374	returns true, it will be called on every further click by the user and is	560	returns true, it will be called on every further click by the user and is
375	supposed to enlarge the selection more and more, if possible.	561	supposed to enlarge the selection more and more, if possible.
376		562
377	See the F<selection> example extension.	563	See the F<selection> example extension.
378		564
379	=item on_view_change $term, $offset	565	=item on_view_change $term, $offset
380		566
381	Called whenever the view offset changes, i..e the user or program	567	Called whenever the view offset changes, i.e. the user or program
382	scrolls. Offset C<0> means display the normal terminal, positive values	568	scrolls. Offset C<0> means display the normal terminal, positive values
383	show this many lines of scrollback.	569	show this many lines of scrollback.
384		570
385	=item on_scroll_back $term, $lines, $saved	571	=item on_scroll_back $term, $lines, $saved
386		572
…		…
390		576
391	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	577	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
392	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	578	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
393	number of lines that will be in the scrollback buffer.	579	number of lines that will be in the scrollback buffer.
394		580
395	=item on_osc_seq $term, $string	581	=item on_osc_seq $term, $op, $args, $resp
		582
		583	Called on every OSC sequence and can be used to suppress it or modify its
		584	behaviour. The default should be to return an empty list. A true value
		585	suppresses execution of the request completely. Make sure you don't get
		586	confused by recursive invocations when you output an OSC sequence within
		587	this callback.
		588
		589	C<on_osc_seq_perl> should be used for new behaviour.
		590
		591	=item on_osc_seq_perl $term, $args, $resp
396		592
397	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	593	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
398	operating system command) is processed. Cursor position and other state	594	operating system command) is processed. Cursor position and other state
399	information is up-to-date when this happens. For interoperability, the	595	information is up-to-date when this happens. For interoperability, the
400	string should start with the extension name and a colon, to distinguish	596	string should start with the extension name (sans -osc) and a semicolon,
401	it from commands for other extensions, and this might be enforced in the	597	to distinguish it from commands for other extensions, and this might be
402	future.	598	enforced in the future.
		599
		600	For example, C<overlay-osc> uses this:
		601
		602	sub on_osc_seq_perl {
		603	my ($self, $osc, $resp) = @_;
		604
		605	return unless $osc =~ s/^overlay;//;
		606
		607	... process remaining $osc string
		608	}
403		609
404	Be careful not ever to trust (in a security sense) the data you receive,	610	Be careful not ever to trust (in a security sense) the data you receive,
405	as its source can not easily be controleld (e-mail content, messages from	611	as its source can not easily be controlled (e-mail content, messages from
406	other users on the same system etc.).	612	other users on the same system etc.).
		613
		614	For responses, C<$resp> contains the end-of-args separator used by the
		615	sender.
407		616
408	=item on_add_lines $term, $string	617	=item on_add_lines $term, $string
409		618
410	Called whenever text is about to be output, with the text as argument. You	619	Called whenever text is about to be output, with the text as argument. You
411	can filter/change and output the text yourself by returning a true value	620	can filter/change and output the text yourself by returning a true value
…		…
416	=item on_tt_write $term, $octets	625	=item on_tt_write $term, $octets
417		626
418	Called whenever some data is written to the tty/pty and can be used to	627	Called whenever some data is written to the tty/pty and can be used to
419	suppress or filter tty input.	628	suppress or filter tty input.
420		629
		630	=item on_tt_paste $term, $octets
		631
		632	Called whenever text is about to be pasted, with the text as argument. You
		633	can filter/change and paste the text yourself by returning a true value
		634	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		635	locale-encoded.
		636
421	=item on_line_update $term, $row	637	=item on_line_update $term, $row
422		638
423	Called whenever a line was updated or changed. Can be used to filter	639	Called whenever a line was updated or changed. Can be used to filter
424	screen output (e.g. underline urls or other useless stuff). Only lines	640	screen output (e.g. underline urls or other useless stuff). Only lines
425	that are being shown will be filtered, and, due to performance reasons,	641	that are being shown will be filtered, and, due to performance reasons,
…		…
432	later with the already-modified line (e.g. if unrelated parts change), so	648	later with the already-modified line (e.g. if unrelated parts change), so
433	you cannot just toggle rendition bits, but only set them.	649	you cannot just toggle rendition bits, but only set them.
434		650
435	=item on_refresh_begin $term	651	=item on_refresh_begin $term
436		652
437	Called just before the screen gets redrawn. Can be used for overlay	653	Called just before the screen gets redrawn. Can be used for overlay or
438	or similar effects by modify terminal contents in refresh_begin, and	654	similar effects by modifying the terminal contents in refresh_begin, and
439	restoring them in refresh_end. The built-in overlay and selection display	655	restoring them in refresh_end. The built-in overlay and selection display
440	code is run after this hook, and takes precedence.	656	code is run after this hook, and takes precedence.
441		657
442	=item on_refresh_end $term	658	=item on_refresh_end $term
443		659
444	Called just after the screen gets redrawn. See C<on_refresh_begin>.	660	Called just after the screen gets redrawn. See C<on_refresh_begin>.
445		661
446	=item on_keyboard_command $term, $string	662	=item on_user_command $term, $string
447		663
448	Called whenever the user presses a key combination that has a	664	Called whenever a user-configured event is being activated (e.g. via
449	C<perl:string> action bound to it (see description of the B<keysym>	665	a C<perl:string> action bound to a key, see description of the B<keysym>
450	resource in the @@RXVT_NAME@@(1) manpage).	666	resource in the @@RXVT_NAME@@(1) manpage).
		667
		668	The event is simply the action string. This interface is assumed to change
		669	slightly in the future.
		670
		671	=item on_resize_all_windows $term, $new_width, $new_height
		672
		673	Called just after the new window size has been calculated, but before
		674	windows are actually being resized or hints are being set. If this hook
		675	returns TRUE, setting of the window hints is being skipped.
451		676
452	=item on_x_event $term, $event	677	=item on_x_event $term, $event
453		678
454	Called on every X event received on the vt window (and possibly other	679	Called on every X event received on the vt window (and possibly other
455	windows). Should only be used as a last resort. Most event structure	680	windows). Should only be used as a last resort. Most event structure
456	members are not passed.	681	members are not passed.
457		682
		683	=item on_root_event $term, $event
		684
		685	Like C<on_x_event>, but is called for events on the root window.
		686
458	=item on_focus_in $term	687	=item on_focus_in $term
459		688
460	Called whenever the window gets the keyboard focus, before rxvt-unicode	689	Called whenever the window gets the keyboard focus, before rxvt-unicode
461	does focus in processing.	690	does focus in processing.
462		691
463	=item on_focus_out $term	692	=item on_focus_out $term
464		693
465	Called wheneever the window loses keyboard focus, before rxvt-unicode does	694	Called whenever the window loses keyboard focus, before rxvt-unicode does
466	focus out processing.	695	focus out processing.
467		696
468	=item on_configure_notify $term, $event	697	=item on_configure_notify $term, $event
469		698
		699	=item on_property_notify $term, $event
		700
470	=item on_key_press $term, $event, $keysym, $octets	701	=item on_key_press $term, $event, $keysym, $octets
471		702
472	=item on_key_release $term, $event, $keysym	703	=item on_key_release $term, $event, $keysym
473		704
474	=item on_button_press $term, $event	705	=item on_button_press $term, $event
…		…
479		710
480	=item on_map_notify $term, $event	711	=item on_map_notify $term, $event
481		712
482	=item on_unmap_notify $term, $event	713	=item on_unmap_notify $term, $event
483		714
484	Called whenever the corresponding X event is received for the terminal If	715	Called whenever the corresponding X event is received for the terminal. If
485	the hook returns true, then the even will be ignored by rxvt-unicode.	716	the hook returns true, then the event will be ignored by rxvt-unicode.
486		717
487	The event is a hash with most values as named by Xlib (see the XEvent	718	The event is a hash with most values as named by Xlib (see the XEvent
488	manpage), with the additional members C<row> and C<col>, which are the row	719	manpage), with the additional members C<row> and C<col>, which are the
489	and column under the mouse cursor.	720	(real, not screen-based) row and column under the mouse cursor.
490		721
491	C<on_key_press> additionally receives the string rxvt-unicode would	722	C<on_key_press> additionally receives the string rxvt-unicode would
492	output, if any, in locale-specific encoding.	723	output, if any, in locale-specific encoding.
493		724
494	subwindow.	725	subwindow.
		726
		727	=item on_client_message $term, $event
		728
		729	=item on_wm_protocols $term, $event
		730
		731	=item on_wm_delete_window $term, $event
		732
		733	Called when various types of ClientMessage events are received (all with
		734	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		735
		736	=item on_bell $term
		737
		738	Called on receipt of a bell character.
495		739
496	=back	740	=back
497		741
498	=cut	742	=cut
499		743
…		…
516	our $LIBDIR;	760	our $LIBDIR;
517	our $RESNAME;	761	our $RESNAME;
518	our $RESCLASS;	762	our $RESCLASS;
519	our $RXVTNAME;	763	our $RXVTNAME;
520		764
		765	our $NOCHAR = chr 0xffff;
		766
521	=head2 Variables in the C<urxvt> Package	767	=head2 Variables in the C<urxvt> Package
522		768
523	=over 4	769	=over 4
524		770
525	=item $urxvt::LIBDIR	771	=item $urxvt::LIBDIR
…		…
540	The current terminal. This variable stores the current C<urxvt::term>	786	The current terminal. This variable stores the current C<urxvt::term>
541	object, whenever a callback/hook is executing.	787	object, whenever a callback/hook is executing.
542		788
543	=item @urxvt::TERM_INIT	789	=item @urxvt::TERM_INIT
544		790
545	All coderefs in this array will be called as methods of the next newly	791	All code references in this array will be called as methods of the next newly
546	created C<urxvt::term> object (during the C<on_init> phase). The array	792	created C<urxvt::term> object (during the C<on_init> phase). The array
547	gets cleared before the codereferences that were in it are being executed,	793	gets cleared before the code references that were in it are being executed,
548	so coderefs can push themselves onto it again if they so desire.	794	so references can push themselves onto it again if they so desire.
549		795
550	This complements to the perl-eval commandline option, but gets executed	796	This complements to the perl-eval command line option, but gets executed
551	first.	797	first.
552		798
553	=item @urxvt::TERM_EXT	799	=item @urxvt::TERM_EXT
554		800
555	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	801	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
562		808
563	=over 4	809	=over 4
564		810
565	=item urxvt::fatal $errormessage	811	=item urxvt::fatal $errormessage
566		812
567	Fatally aborts execution with the given error message. Avoid at all	813	Fatally aborts execution with the given error message (which should
568	costs! The only time this is acceptable is when the terminal process	814	include a trailing newline). Avoid at all costs! The only time this
569	starts up.	815	is acceptable (and useful) is in the init hook, where it prevents the
		816	terminal from starting up.
570		817
571	=item urxvt::warn $string	818	=item urxvt::warn $string
572		819
573	Calls C<rxvt_warn> with the given string which should not include a	820	Calls C<rxvt_warn> with the given string which should include a trailing
574	newline. The module also overwrites the C<warn> builtin with a function	821	newline. The module also overwrites the C<warn> builtin with a function
575	that calls this function.	822	that calls this function.
576		823
577	Using this function has the advantage that its output ends up in the	824	Using this function has the advantage that its output ends up in the
578	correct place, e.g. on stderr of the connecting urxvtc client.	825	correct place, e.g. on stderr of the connecting urxvtc client.
579		826
580	Messages have a size limit of 1023 bytes currently.	827	Messages have a size limit of 1023 bytes currently.
		828
		829	=item @terms = urxvt::termlist
		830
		831	Returns all urxvt::term objects that exist in this process, regardless of
		832	whether they are started, being destroyed etc., so be careful. Only term
		833	objects that have perl extensions attached will be returned (because there
		834	is no urxvt::term object associated with others).
581		835
582	=item $time = urxvt::NOW	836	=item $time = urxvt::NOW
583		837
584	Returns the "current time" (as per the event loop).	838	Returns the "current time" (as per the event loop).
585		839
…		…
628		882
629	=item $rend = urxvt::OVERLAY_RSTYLE	883	=item $rend = urxvt::OVERLAY_RSTYLE
630		884
631	Return the rendition mask used for overlays by default.	885	Return the rendition mask used for overlays by default.
632		886
633	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	887	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		888	urxvt::RS_RVid, urxvt::RS_Uline
634		889
635	Return the bit that enabled bold, italic, blink, reverse-video and	890	Return the bit that enabled bold, italic, blink, reverse-video and
636	underline, respectively. To enable such a style, just logically OR it into	891	underline, respectively. To enable such a style, just logically OR it into
637	the bitset.	892	the bitset.
638		893
…		…
643	Return the foreground/background colour index, respectively.	898	Return the foreground/background colour index, respectively.
644		899
645	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	900	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
646		901
647	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	902	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		903
		904	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
648		905
649	Replace the foreground/background colour in the rendition mask with the	906	Replace the foreground/background colour in the rendition mask with the
650	specified one.	907	specified one.
651		908
652	=item $value = urxvt::GET_CUSTOM $rend	909	=item $value = urxvt::GET_CUSTOM $rend
…		…
671	unless $msg =~ /\n$/;	928	unless $msg =~ /\n$/;
672	urxvt::warn ($msg);	929	urxvt::warn ($msg);
673	};	930	};
674	}	931	}
675		932
		933	no warnings 'utf8';
		934
676	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	935	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
677		936
678	sub verbose {	937	sub verbose {
679	my ($level, $msg) = @_;	938	my ($level, $msg) = @_;
680	warn "$msg\n" if $level <= $verbosity;	939	warn "$msg\n" if $level <= $verbosity;
…		…
696		955
697	open my $fh, "<:raw", $path	956	open my $fh, "<:raw", $path
698	or die "$path: $!";	957	or die "$path: $!";
699		958
700	my $source =	959	my $source =
701	"package $pkg; use strict; use utf8;\n"	960	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
702	. "#line 1 \"$path\"\n{\n"	961	. "#line 1 \"$path\"\n{\n"
703	. (do { local $/; <$fh> })	962	. (do { local $/; <$fh> })
704	. "\n};\n1";	963	. "\n};\n1";
705		964
706	eval $source	965	eval $source
…		…
716	sub invoke {	975	sub invoke {
717	local $TERM = shift;	976	local $TERM = shift;
718	my $htype = shift;	977	my $htype = shift;
719		978
720	if ($htype == 0) { # INIT	979	if ($htype == 0) { # INIT
721	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	980	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
722		981
723	my %ext_arg;	982	my %ext_arg;
724		983
725	{	984	{
726	my @init = @TERM_INIT;	985	my @init = @TERM_INIT;
727	@TERM_INIT = ();	986	@TERM_INIT = ();
…		…
731	$TERM->register_package ($_) for @pkg;	990	$TERM->register_package ($_) for @pkg;
732	}	991	}
733		992
734	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	993	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
735	if ($_ eq "default") {	994	if ($_ eq "default") {
736	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	995	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
737	} elsif (/^-(.*)$/) {	996	} elsif (/^-(.*)$/) {
738	delete $ext_arg{$1};	997	delete $ext_arg{$1};
739	} elsif (/^([^<]+)<(.*)>$/) {	998	} elsif (/^([^<]+)<(.*)>$/) {
740	push @{ $ext_arg{$1} }, $2;	999	push @{ $ext_arg{$1} }, $2;
741	} else {	1000	} else {
742	$ext_arg{$_} ||= [];	1001	$ext_arg{$_} ||= [];
743	}	1002	}
744	}	1003	}
745		1004
746	while (my ($ext, $argv) = each %ext_arg) {	1005	for my $ext (sort keys %ext_arg) {
747	my @files = grep -f $_, map "$_/$ext", @dirs;	1006	my @files = grep -f $_, map "$_/$ext", @dirs;
748		1007
749	if (@files) {	1008	if (@files) {
750	$TERM->register_package (extension_package $files[0], $argv);	1009	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
751	} else {	1010	} else {
752	warn "perl extension '$ext' not found in perl library search path\n";	1011	warn "perl extension '$ext' not found in perl library search path\n";
753	}	1012	}
754	}	1013	}
755		1014
…		…
761		1020
762	if (my $cb = $TERM->{_hook}[$htype]) {	1021	if (my $cb = $TERM->{_hook}[$htype]) {
763	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1022	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
764	if $verbosity >= 10;	1023	if $verbosity >= 10;
765		1024
766	keys %$cb;	1025	for my $pkg (keys %$cb) {
767
768	while (my ($pkg, $cb) = each %$cb) {
769	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1026	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
770	$retval ||= $retval_;	1027	$retval ||= $retval_;
771		1028
772	if ($@) {	1029	if ($@) {
773	$TERM->ungrab; # better to lose the grab than the session	1030	$TERM->ungrab; # better to lose the grab than the session
774	warn $@;	1031	warn $@;
…		…
786	# clear package	1043	# clear package
787	%$TERM = ();	1044	%$TERM = ();
788	}	1045	}
789		1046
790	$retval	1047	$retval
		1048	}
		1049
		1050	sub SET_COLOR($$$) {
		1051	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1052	}
		1053
		1054	sub rend2mask {
		1055	no strict 'refs';
		1056	my ($str, $mask) = (@_, 0);
		1057	my %color = ( fg => undef, bg => undef );
		1058	my @failed;
		1059	for my $spec ( split /\s+/, $str ) {
		1060	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1061	$color{lc($1)} = $2;
		1062	} else {
		1063	my $neg = $spec =~ s/^[-^]//;
		1064	unless ( exists &{"RS_$spec"} ) {
		1065	push @failed, $spec;
		1066	next;
		1067	}
		1068	my $cur = &{"RS_$spec"};
		1069	if ( $neg ) {
		1070	$mask &= ~$cur;
		1071	} else {
		1072	$mask |= $cur;
		1073	}
		1074	}
		1075	}
		1076	($mask, @color{qw(fg bg)}, \@failed)
791	}	1077	}
792		1078
793	# urxvt::term::extension	1079	# urxvt::term::extension
794		1080
795	package urxvt::term::extension;	1081	package urxvt::term::extension;
…		…
866	is that you cannot use blocking APIs, but the non-blocking variant should	1152	is that you cannot use blocking APIs, but the non-blocking variant should
867	work.	1153	work.
868		1154
869	=cut	1155	=cut
870		1156
871	our $VERSION = 1;	1157	our $VERSION = '5.23';
872		1158
873	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1159	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
874	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1160	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
875		1161
876	sub timer {	1162	sub timer {
…		…
878		1164
879	my $cb = $arg{cb};	1165	my $cb = $arg{cb};
880		1166
881	urxvt::timer	1167	urxvt::timer
882	->new	1168	->new
883	->start (urxvt::NOW + $arg{after})	1169	->after ($arg{after}, $arg{interval})
884	->cb (sub {	1170	->cb ($arg{interval} ? $cb : sub {
885	$_[0]->stop; # need to cancel manually	1171	$_[0]->stop; # need to cancel manually
886	$cb->();	1172	$cb->();
887	})	1173	})
888	}	1174	}
889		1175
890	sub io {	1176	sub io {
891	my ($class, %arg) = @_;	1177	my ($class, %arg) = @_;
892		1178
893	my $cb = $arg{cb};	1179	my $cb = $arg{cb};
		1180	my $fd = fileno $arg{fh};
		1181	defined $fd or $fd = $arg{fh};
894		1182
895	bless [$arg{fh}, urxvt::iow	1183	bless [$arg{fh}, urxvt::iow
896	->new	1184	->new
897	->fd (fileno $arg{fh})	1185	->fd ($fd)
898	->events (($arg{poll} =~ /r/ ? 1 : 0)	1186	->events (($arg{poll} =~ /r/ ? 1 : 0)
899	| ($arg{poll} =~ /w/ ? 2 : 0))	1187	| ($arg{poll} =~ /w/ ? 2 : 0))
900	->start	1188	->start
901	->cb (sub {	1189	->cb ($cb)
902	$cb->(($_[1] & 1 ? 'r' : '')
903	. ($_[1] & 2 ? 'w' : ''));
904	})],
905	urxvt::anyevent::	1190	], urxvt::anyevent::
		1191	}
		1192
		1193	sub idle {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::iw
		1199	->new
		1200	->start
		1201	->cb ($cb)
		1202	}
		1203
		1204	sub child {
		1205	my ($class, %arg) = @_;
		1206
		1207	my $cb = $arg{cb};
		1208
		1209	urxvt::pw
		1210	->new
		1211	->start ($arg{pid})
		1212	->cb (sub {
		1213	$_[0]->stop; # need to cancel manually
		1214	$cb->($_[0]->rpid, $_[0]->rstatus);
		1215	})
906	}	1216	}
907		1217
908	sub DESTROY {	1218	sub DESTROY {
909	$_[0][1]->stop;	1219	$_[0][1]->stop;
910	}	1220	}
911		1221
912	sub condvar {	1222	# only needed for AnyEvent < 6 compatibility
913	bless \my $flag, urxvt::anyevent::condvar::	1223	sub one_event {
914	}
915
916	sub urxvt::anyevent::condvar::broadcast {
917	${$_[0]}++;
918	}
919
920	sub urxvt::anyevent::condvar::wait {
921	unless (${$_[0]}) {
922	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1224	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
923	}
924	}	1225	}
925		1226
926	package urxvt::term;	1227	package urxvt::term;
927		1228
928	=head2 The C<urxvt::term> Class	1229	=head2 The C<urxvt::term> Class
…		…
964	hash which defines the environment of the new terminal.	1265	hash which defines the environment of the new terminal.
965		1266
966	Croaks (and probably outputs an error message) if the new instance	1267	Croaks (and probably outputs an error message) if the new instance
967	couldn't be created. Returns C<undef> if the new instance didn't	1268	couldn't be created. Returns C<undef> if the new instance didn't
968	initialise perl, and the terminal object otherwise. The C<init> and	1269	initialise perl, and the terminal object otherwise. The C<init> and
969	C<start> hooks will be called during this call.	1270	C<start> hooks will be called before this call returns, and are free to
		1271	refer to global data (which is race free).
970		1272
971	=cut	1273	=cut
972		1274
973	sub new {	1275	sub new {
974	my ($class, $env, @args) = @_;	1276	my ($class, $env, @args) = @_;
975		1277
		1278	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1279	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1280
976	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1281	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
977	}	1282	}
978		1283
979	=item $term->destroy	1284	=item $term->destroy
980		1285
981	Destroy the terminal object (close the window, free resources	1286	Destroy the terminal object (close the window, free resources
…		…
1011		1316
1012	Returns true if the option specified by C<$optval> is enabled, and	1317	Returns true if the option specified by C<$optval> is enabled, and
1013	optionally change it. All option values are stored by name in the hash	1318	optionally change it. All option values are stored by name in the hash
1014	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1319	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1015		1320
1016	Here is a a likely non-exhaustive list of option names, please see the	1321	Here is a likely non-exhaustive list of option names, please see the
1017	source file F</src/optinc.h> to see the actual list:	1322	source file F</src/optinc.h> to see the actual list:
1018		1323
1019	borderLess console cursorBlink cursorUnderline hold iconic insecure	1324	borderLess buffered console cursorBlink cursorUnderline hold iconic
1020	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1325	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1021	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1326	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1022	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1327	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1023	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1328	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1024	transparent tripleclickwords utmpInhibit visualBell	1329	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1330	urgentOnBell utmpInhibit visualBell
1025		1331
1026	=item $value = $term->resource ($name[, $newval])	1332	=item $value = $term->resource ($name[, $newval])
1027		1333
1028	Returns the current resource value associated with a given name and	1334	Returns the current resource value associated with a given name and
1029	optionally sets a new value. Setting values is most useful in the C<init>	1335	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1038	likely change).	1344	likely change).
1039		1345
1040	Please note that resource strings will currently only be freed when the	1346	Please note that resource strings will currently only be freed when the
1041	terminal is destroyed, so changing options frequently will eat memory.	1347	terminal is destroyed, so changing options frequently will eat memory.
1042		1348
1043	Here is a a likely non-exhaustive list of resource names, not all of which	1349	Here is a likely non-exhaustive list of resource names, not all of which
1044	are supported in every build, please see the source file F</src/rsinc.h>	1350	are supported in every build, please see the source file F</src/rsinc.h>
1045	to see the actual list:	1351	to see the actual list:
1046		1352
1047	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1353	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1048	borderLess color cursorBlink cursorUnderline cutchars delete_key	1354	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1049	display_name embed ext_bwidth fade font geometry hold iconName	1355	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1050	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1356	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1357	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1051	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1358	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1052	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1359	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1053	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1360	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1054	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1361	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1055	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1362	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1056	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1057	secondaryScreen secondaryScroll selectstyle shade term_name title	1364	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1058	transient_for transparent transparent_all tripleclickwords utmpInhibit	1365	term_name title transient_for transparent tripleclickwords urgentOnBell
1059	visualBell	1366	utmpInhibit visualBell
1060		1367
1061	=cut	1368	=cut
1062		1369
1063	sub resource($$;$) {	1370	sub resource($$;$) {
1064	my ($self, $name) = (shift, shift);	1371	my ($self, $name) = (shift, shift);
1065	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1372	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1066	&urxvt::term::_resource	1373	goto &urxvt::term::_resource
1067	}	1374	}
1068		1375
1069	=item $value = $term->x_resource ($pattern)	1376	=item $value = $term->x_resource ($pattern)
1070		1377
1071	Returns the X-Resource for the given pattern, excluding the program or	1378	Returns the X-Resource for the given pattern, excluding the program or
…		…
1096		1403
1097	=item ($row, $col) = $term->selection_beg ([$row, $col])	1404	=item ($row, $col) = $term->selection_beg ([$row, $col])
1098		1405
1099	=item ($row, $col) = $term->selection_end ([$row, $col])	1406	=item ($row, $col) = $term->selection_end ([$row, $col])
1100		1407
1101	Return the current values of the selection mark, begin or end positions,	1408	Return the current values of the selection mark, begin or end positions.
1102	and optionally set them to new values.	1409
		1410	When arguments are given, then the selection coordinates are set to
		1411	C<$row> and C<$col>, and the selection screen is set to the current
		1412	screen.
		1413
		1414	=item $screen = $term->selection_screen ([$screen])
		1415
		1416	Returns the current selection screen, and then optionally sets it.
1103		1417
1104	=item $term->selection_make ($eventtime[, $rectangular])	1418	=item $term->selection_make ($eventtime[, $rectangular])
1105		1419
1106	Tries to make a selection as set by C<selection_beg> and	1420	Tries to make a selection as set by C<selection_beg> and
1107	C<selection_end>. If C<$rectangular> is true (default: false), a	1421	C<selection_end>. If C<$rectangular> is true (default: false), a
1108	rectangular selection will be made. This is the prefered function to make	1422	rectangular selection will be made. This is the preferred function to make
1109	a selection.	1423	a selection.
1110		1424
1111	=item $success = $term->selection_grab ($eventtime)	1425	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1112		1426
1113	Try to request the primary selection text from the server (for example, as	1427	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1428	true) selection from the server. The corresponding text can be set
1114	set by the next method). No visual feedback will be given. This function	1429	with the next method. No visual feedback will be given. This function
1115	is mostly useful from within C<on_sel_grab> hooks.	1430	is mostly useful from within C<on_sel_grab> hooks.
1116		1431
1117	=item $oldtext = $term->selection ([$newtext])	1432	=item $oldtext = $term->selection ([$newtext, $clipboard])
1118		1433
1119	Return the current selection text and optionally replace it by C<$newtext>.	1434	Return the current selection (clipboard if C<$clipboard> is true) text
		1435	and optionally replace it by C<$newtext>.
		1436
		1437	=item $term->selection_clear ([$clipboard])
		1438
		1439	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1120		1440
1121	=item $term->overlay_simple ($x, $y, $text)	1441	=item $term->overlay_simple ($x, $y, $text)
1122		1442
1123	Create a simple multi-line overlay box. See the next method for details.	1443	Create a simple multi-line overlay box. See the next method for details.
1124		1444
…		…
1154		1474
1155	The methods currently supported on C<urxvt::overlay> objects are:	1475	The methods currently supported on C<urxvt::overlay> objects are:
1156		1476
1157	=over 4	1477	=over 4
1158		1478
1159	=item $overlay->set ($x, $y, $text, $rend)	1479	=item $overlay->set ($x, $y, $text[, $rend])
1160		1480
1161	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1481	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1162	text in rxvt-unicode's special encoding and an array of rendition values	1482	text in rxvt-unicode's special encoding and an array of rendition values
1163	at a specific position inside the overlay.	1483	at a specific position inside the overlay.
		1484
		1485	If C<$rend> is missing, then the rendition will not be changed.
1164		1486
1165	=item $overlay->hide	1487	=item $overlay->hide
1166		1488
1167	If visible, hide the overlay, but do not destroy it.	1489	If visible, hide the overlay, but do not destroy it.
1168		1490
…		…
1238		1560
1239	Normally its not a good idea to use this function, as programs might be	1561	Normally its not a good idea to use this function, as programs might be
1240	confused by changes in cursor position or scrolling. Its useful inside a	1562	confused by changes in cursor position or scrolling. Its useful inside a
1241	C<on_add_lines> hook, though.	1563	C<on_add_lines> hook, though.
1242		1564
		1565	=item $term->scr_change_screen ($screen)
		1566
		1567	Switch to given screen - 0 primary, 1 secondary.
		1568
1243	=item $term->cmd_parse ($octets)	1569	=item $term->cmd_parse ($octets)
1244		1570
1245	Similar to C<scr_add_lines>, but the argument must be in the	1571	Similar to C<scr_add_lines>, but the argument must be in the
1246	locale-specific encoding of the terminal and can contain command sequences	1572	locale-specific encoding of the terminal and can contain command sequences
1247	(escape codes) that will be interpreted.	1573	(escape codes) that will be interpreted.
1248		1574
1249	=item $term->tt_write ($octets)	1575	=item $term->tt_write ($octets)
1250		1576
1251	Write the octets given in C<$data> to the tty (i.e. as program input). To	1577	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1252	pass characters instead of octets, you should convert your strings first	1578	pass characters instead of octets, you should convert your strings first
1253	to the locale-specific encoding using C<< $term->locale_encode >>.	1579	to the locale-specific encoding using C<< $term->locale_encode >>.
		1580
		1581	=item $term->tt_paste ($octets)
		1582
		1583	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1584	CR and bracketing the data with control sequences if bracketed paste mode
		1585	is set.
1254		1586
1255	=item $old_events = $term->pty_ev_events ([$new_events])	1587	=item $old_events = $term->pty_ev_events ([$new_events])
1256		1588
1257	Replaces the event mask of the pty watcher by the given event mask. Can	1589	Replaces the event mask of the pty watcher by the given event mask. Can
1258	be used to suppress input and output handling to the pty/tty. See the	1590	be used to suppress input and output handling to the pty/tty. See the
1259	description of C<< urxvt::timer->events >>. Make sure to always restore	1591	description of C<< urxvt::timer->events >>. Make sure to always restore
1260	the previous value.	1592	the previous value.
1261		1593
		1594	=item $fd = $term->pty_fd
		1595
		1596	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1597	is used.
		1598
1262	=item $windowid = $term->parent	1599	=item $windowid = $term->parent
1263		1600
1264	Return the window id of the toplevel window.	1601	Return the window id of the toplevel window.
1265		1602
1266	=item $windowid = $term->vt	1603	=item $windowid = $term->vt
…		…
1272	Adds the specified events to the vt event mask. Useful e.g. when you want	1609	Adds the specified events to the vt event mask. Useful e.g. when you want
1273	to receive pointer events all the times:	1610	to receive pointer events all the times:
1274		1611
1275	$term->vt_emask_add (urxvt::PointerMotionMask);	1612	$term->vt_emask_add (urxvt::PointerMotionMask);
1276		1613
		1614	=item $term->focus_in
		1615
		1616	=item $term->focus_out
		1617
		1618	=item $term->key_press ($state, $keycode[, $time])
		1619
		1620	=item $term->key_release ($state, $keycode[, $time])
		1621
		1622	Deliver various fake events to to terminal.
		1623
1277	=item $window_width = $term->width	1624	=item $window_width = $term->width
1278		1625
1279	=item $window_height = $term->height	1626	=item $window_height = $term->height
1280		1627
1281	=item $font_width = $term->fwidth	1628	=item $font_width = $term->fwidth
…		…
1311	=item $env = $term->env	1658	=item $env = $term->env
1312		1659
1313	Returns a copy of the environment in effect for the terminal as a hashref	1660	Returns a copy of the environment in effect for the terminal as a hashref
1314	similar to C<\%ENV>.	1661	similar to C<\%ENV>.
1315		1662
		1663	=item @envv = $term->envv
		1664
		1665	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1666
		1667	=item @argv = $term->argv
		1668
		1669	Return the argument vector as this terminal, similar to @ARGV, but
		1670	includes the program name as first element.
		1671
1316	=cut	1672	=cut
1317		1673
1318	sub env {	1674	sub env {
1319	if (my $env = $_[0]->_env) {
1320	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1675	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1321	} else {
1322	+{ %ENV }
1323	}
1324	}	1676	}
1325		1677
1326	=item $modifiermask = $term->ModLevel3Mask	1678	=item $modifiermask = $term->ModLevel3Mask
1327		1679
1328	=item $modifiermask = $term->ModMetaMask	1680	=item $modifiermask = $term->ModMetaMask
1329		1681
1330	=item $modifiermask = $term->ModNumLockMask	1682	=item $modifiermask = $term->ModNumLockMask
1331		1683
1332	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1684	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1333	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1685	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1686
		1687	=item $screen = $term->current_screen
		1688
		1689	Returns the currently displayed screen (0 primary, 1 secondary).
		1690
		1691	=item $cursor_is_hidden = $term->hidden_cursor
		1692
		1693	Returns whether the cursor is currently hidden or not.
1334		1694
1335	=item $view_start = $term->view_start ([$newvalue])	1695	=item $view_start = $term->view_start ([$newvalue])
1336		1696
1337	Returns the row number of the topmost displayed line. Maximum value is	1697	Returns the row number of the topmost displayed line. Maximum value is
1338	C<0>, which displays the normal terminal contents. Lower values scroll	1698	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1346		1706
1347	Used after changing terminal contents to display them.	1707	Used after changing terminal contents to display them.
1348		1708
1349	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1709	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1350		1710
1351	Returns the text of the entire row with number C<$row_number>. Row C<0>	1711	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1352	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1712	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1353	terminal line. The scrollback buffer starts at line C<-1> and extends to
1354	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1713	terminal line. Nothing will be returned if a nonexistent line
1355	is requested.	1714	is requested.
1356		1715
1357	If C<$new_text> is specified, it will replace characters in the current	1716	If C<$new_text> is specified, it will replace characters in the current
1358	line, starting at column C<$start_col> (default C<0>), which is useful	1717	line, starting at column C<$start_col> (default C<0>), which is useful
1359	to replace only parts of a line. The font index in the rendition will	1718	to replace only parts of a line. The font index in the rendition will
1360	automatically be updated.	1719	automatically be updated.
1361		1720
1362	C<$text> is in a special encoding: tabs and wide characters that use more	1721	C<$text> is in a special encoding: tabs and wide characters that use more
1363	than one cell when displayed are padded with urxvt::NOCHAR characters	1722	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1364	(C<chr 65535>). Characters with combining characters and other characters	1723	characters. Characters with combining characters and other characters that
1365	that do not fit into the normal tetx encoding will be replaced with	1724	do not fit into the normal text encoding will be replaced with characters
1366	characters in the private use area.	1725	in the private use area.
1367		1726
1368	You have to obey this encoding when changing text. The advantage is	1727	You have to obey this encoding when changing text. The advantage is
1369	that C<substr> and similar functions work on screen cells and not on	1728	that C<substr> and similar functions work on screen cells and not on
1370	characters.	1729	characters.
1371		1730
…		…
1515	where one character corresponds to one screen cell. See	1874	where one character corresponds to one screen cell. See
1516	C<< $term->ROW_t >> for details.	1875	C<< $term->ROW_t >> for details.
1517		1876
1518	=item $string = $term->special_decode $text	1877	=item $string = $term->special_decode $text
1519		1878
1520	Converts rxvt-unicodes text reprsentation into a perl string. See	1879	Converts rxvt-unicodes text representation into a perl string. See
1521	C<< $term->ROW_t >> for details.	1880	C<< $term->ROW_t >> for details.
1522		1881
1523	=item $success = $term->grab_button ($button, $modifiermask)	1882	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1524		1883
		1884	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1885
1525	Registers a synchronous button grab. See the XGrabButton manpage.	1886	Register/unregister a synchronous button grab. See the XGrabButton
		1887	manpage.
1526		1888
1527	=item $success = $term->grab ($eventtime[, $sync])	1889	=item $success = $term->grab ($eventtime[, $sync])
1528		1890
1529	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1891	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1530	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1892	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1531		1893
1532	=item $term->allow_events_async	1894	=item $term->allow_events_async
1533		1895
1534	Calls XAllowEvents with AsyncBoth for the most recent grab.	1896	Calls XAllowEvents with AsyncBoth for the most recent grab.
1535		1897
…		…
1542	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1904	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1543	recent grab.	1905	recent grab.
1544		1906
1545	=item $term->ungrab	1907	=item $term->ungrab
1546		1908
1547	Calls XUngrab for the most recent grab. Is called automatically on	1909	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1548	evaluation errors, as it is better to lose the grab in the error case as	1910	evaluation errors, as it is better to lose the grab in the error case as
1549	the session.	1911	the session.
		1912
		1913	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1914
		1915	=item $atom_name = $term->XGetAtomName ($atom)
		1916
		1917	=item @atoms = $term->XListProperties ($window)
		1918
		1919	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1920
		1921	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1922
		1923	=item $term->XDeleteProperty ($window, $property)
		1924
		1925	=item $window = $term->DefaultRootWindow
		1926
		1927	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1928
		1929	=item $term->XMapWindow ($window)
		1930
		1931	=item $term->XUnmapWindow ($window)
		1932
		1933	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1934
		1935	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1936
		1937	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1938
		1939	Various X or X-related functions. The C<$term> object only serves as
		1940	the source of the display, otherwise those functions map more-or-less
		1941	directly onto the X functions of the same name.
1550		1942
1551	=back	1943	=back
1552		1944
1553	=cut	1945	=cut
1554		1946
…		…
1618	my ($self, $text, $cb) = @_;	2010	my ($self, $text, $cb) = @_;
1619		2011
1620	$self->add_item ({ type => "button", text => $text, activate => $cb});	2012	$self->add_item ({ type => "button", text => $text, activate => $cb});
1621	}	2013	}
1622		2014
1623	=item $popup->add_toggle ($text, $cb, $initial_value)	2015	=item $popup->add_toggle ($text, $initial_value, $cb)
1624		2016
1625	Adds a toggle/checkbox item to the popup. Teh callback gets called	2017	Adds a toggle/checkbox item to the popup. The callback gets called
1626	whenever it gets toggled, with a boolean indicating its value as its first	2018	whenever it gets toggled, with a boolean indicating its new value as its
1627	argument.	2019	first argument.
1628		2020
1629	=cut	2021	=cut
1630		2022
1631	sub add_toggle {	2023	sub add_toggle {
1632	my ($self, $text, $cb, $value) = @_;	2024	my ($self, $text, $value, $cb) = @_;
1633		2025
1634	my $item; $item = {	2026	my $item; $item = {
1635	type => "button",	2027	type => "button",
1636	text => " $text",	2028	text => " $text",
1637	value => $value,	2029	value => $value,
…		…
1656	my $env = $self->{term}->env;	2048	my $env = $self->{term}->env;
1657	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2049	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1658	delete $env->{LC_ALL};	2050	delete $env->{LC_ALL};
1659	$env->{LC_CTYPE} = $self->{term}->locale;	2051	$env->{LC_CTYPE} = $self->{term}->locale;
1660		2052
1661	urxvt::term->new ($env, "popup",	2053	my $term = urxvt::term->new (
		2054	$env, "popup",
1662	"--perl-lib" => "", "--perl-ext-common" => "",	2055	"--perl-lib" => "", "--perl-ext-common" => "",
1663	"-pty-fd" => -1, "-sl" => 0,	2056	"-pty-fd" => -1, "-sl" => 0,
1664	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2057	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1665	"--transient-for" => $self->{term}->parent,	2058	"--transient-for" => $self->{term}->parent,
1666	"-display" => $self->{term}->display_id,	2059	"-display" => $self->{term}->display_id,
1667	"-pe" => "urxvt-popup")	2060	"-pe" => "urxvt-popup",
1668	or die "unable to create popup window\n";	2061	) or die "unable to create popup window\n";
		2062
		2063	unless (delete $term->{urxvt_popup_init_done}) {
		2064	$term->ungrab;
		2065	$term->destroy;
		2066	die "unable to initialise popup window\n";
		2067	}
1669	}	2068	}
1670		2069
1671	sub DESTROY {	2070	sub DESTROY {
1672	my ($self) = @_;	2071	my ($self) = @_;
1673		2072
…		…
1678	=back	2077	=back
1679		2078
1680	=cut	2079	=cut
1681		2080
1682	package urxvt::watcher;	2081	package urxvt::watcher;
1683
1684	@urxvt::timer::ISA = __PACKAGE__;
1685	@urxvt::iow::ISA = __PACKAGE__;
1686	@urxvt::pw::ISA = __PACKAGE__;
1687	@urxvt::iw::ISA = __PACKAGE__;
1688		2082
1689	=head2 The C<urxvt::timer> Class	2083	=head2 The C<urxvt::timer> Class
1690		2084
1691	This class implements timer watchers/events. Time is represented as a	2085	This class implements timer watchers/events. Time is represented as a
1692	fractional number of seconds since the epoch. Example:	2086	fractional number of seconds since the epoch. Example:
…		…
1696	->new	2090	->new
1697	->interval (1)	2091	->interval (1)
1698	->cb (sub {	2092	->cb (sub {
1699	$term->{overlay}->set (0, 0,	2093	$term->{overlay}->set (0, 0,
1700	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2094	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1701	});	2095	});
1702		2096
1703	=over 4	2097	=over 4
1704		2098
1705	=item $timer = new urxvt::timer	2099	=item $timer = new urxvt::timer
1706		2100
…		…
1709		2103
1710	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2104	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1711		2105
1712	Set the callback to be called when the timer triggers.	2106	Set the callback to be called when the timer triggers.
1713		2107
1714	=item $tstamp = $timer->at
1715
1716	Return the time this watcher will fire next.
1717
1718	=item $timer = $timer->set ($tstamp)	2108	=item $timer = $timer->set ($tstamp[, $interval])
1719		2109
1720	Set the time the event is generated to $tstamp.	2110	Set the time the event is generated to $tstamp (and optionally specifies a
		2111	new $interval).
1721		2112
1722	=item $timer = $timer->interval ($interval)	2113	=item $timer = $timer->interval ($interval)
1723		2114
1724	Normally (and when C<$interval> is C<0>), the timer will automatically	2115	By default (and when C<$interval> is C<0>), the timer will automatically
1725	stop after it has fired once. If C<$interval> is non-zero, then the timer	2116	stop after it has fired once. If C<$interval> is non-zero, then the timer
1726	is automatically rescheduled at the given intervals.	2117	is automatically rescheduled at the given intervals.
1727		2118
1728	=item $timer = $timer->start	2119	=item $timer = $timer->start
1729		2120
1730	Start the timer.	2121	Start the timer.
1731		2122
1732	=item $timer = $timer->start ($tstamp)	2123	=item $timer = $timer->start ($tstamp[, $interval])
1733		2124
1734	Set the event trigger time to C<$tstamp> and start the timer.	2125	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2126	also replaces the interval.
1735		2127
1736	=item $timer = $timer->after ($delay)	2128	=item $timer = $timer->after ($delay[, $interval])
1737		2129
1738	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2130	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1739		2131
1740	=item $timer = $timer->stop	2132	=item $timer = $timer->stop
1741		2133
…		…
1749		2141
1750	$term->{socket} = ...	2142	$term->{socket} = ...
1751	$term->{iow} = urxvt::iow	2143	$term->{iow} = urxvt::iow
1752	->new	2144	->new
1753	->fd (fileno $term->{socket})	2145	->fd (fileno $term->{socket})
1754	->events (urxvt::EVENT_READ)	2146	->events (urxvt::EV_READ)
1755	->start	2147	->start
1756	->cb (sub {	2148	->cb (sub {
1757	my ($iow, $revents) = @_;	2149	my ($iow, $revents) = @_;
1758	# $revents must be 1 here, no need to check	2150	# $revents must be 1 here, no need to check
1759	sysread $term->{socket}, my $buf, 8192	2151	sysread $term->{socket}, my $buf, 8192
…		…
1772	Set the callback to be called when io events are triggered. C<$reventmask>	2164	Set the callback to be called when io events are triggered. C<$reventmask>
1773	is a bitset as described in the C<events> method.	2165	is a bitset as described in the C<events> method.
1774		2166
1775	=item $iow = $iow->fd ($fd)	2167	=item $iow = $iow->fd ($fd)
1776		2168
1777	Set the filedescriptor (not handle) to watch.	2169	Set the file descriptor (not handle) to watch.
1778		2170
1779	=item $iow = $iow->events ($eventmask)	2171	=item $iow = $iow->events ($eventmask)
1780		2172
1781	Set the event mask to watch. The only allowed values are	2173	Set the event mask to watch. The only allowed values are
1782	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2174	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1783	together, or C<urxvt::EVENT_NONE>.	2175	together, or C<urxvt::EV_NONE>.
1784		2176
1785	=item $iow = $iow->start	2177	=item $iow = $iow->start
1786		2178
1787	Start watching for requested events on the given handle.	2179	Start watching for requested events on the given handle.
1788		2180
1789	=item $iow = $iow->stop	2181	=item $iow = $iow->stop
1790		2182
1791	Stop watching for events on the given filehandle.	2183	Stop watching for events on the given file handle.
		2184
		2185	=back
		2186
		2187	=head2 The C<urxvt::iw> Class
		2188
		2189	This class implements idle watchers, that get called automatically when
		2190	the process is idle. They should return as fast as possible, after doing
		2191	some useful work.
		2192
		2193	=over 4
		2194
		2195	=item $iw = new urxvt::iw
		2196
		2197	Create a new idle watcher object in stopped state.
		2198
		2199	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2200
		2201	Set the callback to be called when the watcher triggers.
		2202
		2203	=item $timer = $timer->start
		2204
		2205	Start the watcher.
		2206
		2207	=item $timer = $timer->stop
		2208
		2209	Stop the watcher.
		2210
		2211	=back
		2212
		2213	=head2 The C<urxvt::pw> Class
		2214
		2215	This class implements process watchers. They create an event whenever a
		2216	process exits, after which they stop automatically.
		2217
		2218	my $pid = fork;
		2219	...
		2220	$term->{pw} = urxvt::pw
		2221	->new
		2222	->start ($pid)
		2223	->cb (sub {
		2224	my ($pw, $exit_status) = @_;
		2225	...
		2226	});
		2227
		2228	=over 4
		2229
		2230	=item $pw = new urxvt::pw
		2231
		2232	Create a new process watcher in stopped state.
		2233
		2234	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2235
		2236	Set the callback to be called when the timer triggers.
		2237
		2238	=item $pw = $timer->start ($pid)
		2239
		2240	Tells the watcher to start watching for process C<$pid>.
		2241
		2242	=item $pw = $pw->stop
		2243
		2244	Stop the watcher.
1792		2245
1793	=back	2246	=back
1794		2247
1795	=head1 ENVIRONMENT	2248	=head1 ENVIRONMENT
1796		2249
…		…
1805		2258
1806	=item >= 3 - script loading and management	2259	=item >= 3 - script loading and management
1807		2260
1808	=item >=10 - all called hooks	2261	=item >=10 - all called hooks
1809		2262
1810	=item >=11 - hook reutrn values	2263	=item >=11 - hook return values
1811		2264
1812	=back	2265	=back
1813		2266
1814	=head1 AUTHOR	2267	=head1 AUTHOR
1815		2268
1816	Marc Lehmann <pcg@goof.com>	2269	Marc Lehmann <schmorp@schmorp.de>
1817	http://software.schmorp.de/pkg/rxvt-unicode	2270	http://software.schmorp.de/pkg/rxvt-unicode
1818		2271
1819	=cut	2272	=cut
1820		2273
1821	1	2274	1
		2275
		2276	# vim: sw=3:

Diff Legend

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