ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC vs.
Revision 1.174 by root, Sat May 30 08:47:07 2009 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	71	between two vertical bars:
65		72
66	URxvt.selection.pattern-0: \\|([^|]+)\\|	73	URxvt.selection.pattern-0: \\|([^|]+)\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
67		81
68	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers the following bindable keyboard command:	85	This extension also offers following bindable keyboard commands:
72		86
73	=over 4	87	=over 4
74		88
75	=item rot13	89	=item rot13
76		90
…		…
83	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
84		98
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.	100	runtime.
87		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
88	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
89		120
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
		124
		125	Other extensions can extend this popup menu by pushing a code reference
		126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
		128
		129	Its sole argument is the popup menu, which can be modified. The selection
		130	is in C<$_>, which can be used to decide whether to add something or not.
		131	It should either return nothing or a string and a code reference. The
		132	string will be used as button text and the code reference will be called
		133	when the button gets activated and should transform C<$_>.
		134
		135	The following will add an entry C<a to b> that transforms all C<a>s in
		136	the selection to C<b>s, but only if the selection currently contains any
		137	C<a>s:
		138
		139	push @{ $self->{term}{selection_popup_hook} }, sub {
		140	/a/ ? ("a to b" => sub { s/a/b/g }
		141	: ()
		142	};
93		143
94	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
95		145
96	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
104	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
107	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
108		189
109	=item selection-autotransform	190	=item selection-autotransform
110		191
111	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	193	whenever a selection is made.
…		…
120		201
121	For example, the following will transform selections of the form	202	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename	203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:	204	$word>:
124		205
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		207
127	And this example matches the same,but replaces it with vi-commands you can	208	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	209	paste directly into your (vi :) editor:
129		210
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		212
132	Of course, this can be modified to suit your needs and your editor :)	213	Of course, this can be modified to suit your needs and your editor :)
133		214
134	To expand the example above to typical perl error messages ("XXX at	215	To expand the example above to typical perl error messages ("XXX at
135	FILENAME line YYY."), you need a slightly more elaborate solution:	216	FILENAME line YYY."), you need a slightly more elaborate solution:
136		217
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139		220
140	The first line tells the selection code to treat the unchanging part of	221	The first line tells the selection code to treat the unchanging part of
141	every error message as a selection pattern, and the second line transforms	222	every error message as a selection pattern, and the second line transforms
142	the message into vi commands to load the file.	223	the message into vi commands to load the file.
143		224
144	=item mark-urls	225	=item tabbed
145		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
146	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
147	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
148	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
149	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		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.
150		313
151	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
152		315
153	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
154	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
155	similar-looking ascii character.	318	similar-looking ascii character.
156		319
157	=item digital-clock	320	=item digital-clock
158		321
159	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
		323
		324	=item remote-clipboard
		325
		326	Somewhat of a misnomer, this extension adds two menu entries to the
		327	selection popup that allows one to run external commands to store the
		328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		343
		344	=item selection-pastebin
		345
		346	This is a little rarely useful extension that Uploads the selection as
		347	textfile to a remote site (or does other things). (The implementation is
		348	not currently secure for use in a multiuser environment as it writes to
		349	F</tmp> directly.).
		350
		351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		352	i.e.
		353
		354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		355
		356	Pressing this combination runs a command with C<%> replaced by the name of
		357	the textfile. This command can be set via a resource:
		358
		359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		360
		361	And the default is likely not useful to anybody but the few people around
		362	here :)
		363
		364	The name of the textfile is the hex encoded md5 sum of the selection, so
		365	the same content should lead to the same filename.
		366
		367	After a successful upload the selection will be replaced by the text given
		368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		369	for the filename):
		370
		371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of wether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-pastebin and macosx-pastebin-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<maxosx-pastebin> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
160		391
161	=item example-refresh-hooks	392	=item example-refresh-hooks
162		393
163	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
164	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
204		435
205	=back	436	=back
206		437
207	=head2 Extension Objects	438	=head2 Extension Objects
208		439
209	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
210	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,
211	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
212	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
213	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
214	use.	446	internal use.
215		447
216	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
217	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
218		450
219	It has the following methods and data members:	451	It has the following methods and data members:
…		…
240	=head2 Hooks	472	=head2 Hooks
241		473
242	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
243	called whenever the relevant event happens.	475	called whenever the relevant event happens.
244		476
245	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
246	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
247		479
248	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
249	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
250	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.
251		483
252	I<< When in doubt, return a false value (preferably C<()>). >>	484	I<< When in doubt, return a false value (preferably C<()>). >>
253		485
254	=over 4	486	=over 4
255		487
256	=item on_init $term	488	=item on_init $term
257		489
258	Called after a new terminal object has been initialized, but before	490	Called after a new terminal object has been initialized, but before
259	windows are created or the command gets run. Most methods are unsafe to	491	windows are created or the command gets run. Most methods are unsafe to
260	call or deliver senseless data, as terminal size and other characteristics	492	call or deliver senseless data, as terminal size and other characteristics
261	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
262	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).
263		506
264	=item on_reset $term	507	=item on_reset $term
265		508
266	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
267	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
268	variables.	511	variables.
269		512
270	=item on_start $term	513	=item on_child_start $term, $pid
271		514
272	Called at the very end of initialisation of a new terminal, just before	515	Called just after the child process has been C<fork>ed.
273	returning to the mainloop.	516
		517	=item on_child_exit $term, $status
		518
		519	Called just after the child process has exited. C<$status> is the status
		520	from C<waitpid>.
274		521
275	=item on_sel_make $term, $eventtime	522	=item on_sel_make $term, $eventtime
276		523
277	Called whenever a selection has been made by the user, but before the	524	Called whenever a selection has been made by the user, but before the
278	selection text is copied, so changes to the beginning, end or type of the	525	selection text is copied, so changes to the beginning, end or type of the
…		…
285		532
286	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
287	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
288	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
289		536
290	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.
291		538
292	=item on_sel_extend $term	539	=item on_sel_extend $term
293		540
294	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
295	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
296	should extend the selection itelf and return true to suppress the built-in	543	should extend the selection itself and return true to suppress the built-in
297	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
298	returns true, it will be called on every further click by the user and is	545	returns true, it will be called on every further click by the user and is
299	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
300		547
301	See the F<selection> example extension.	548	See the F<selection> example extension.
302		549
303	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
304		551
305	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
306	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
307	show this many lines of scrollback.	554	show this many lines of scrollback.
308		555
309	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
310		557
…		…
314		561
315	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,
316	$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
317	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
318		565
319	=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
320		577
321	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
322	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
323	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
324	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,
325	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
326	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	}
327		594
328	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,
329	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
330	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.
331		601
332	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
333		603
334	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
335	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
…		…
356	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
357	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
358		628
359	=item on_refresh_begin $term	629	=item on_refresh_begin $term
360		630
361	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
362	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
363	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
364	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
365		635
366	=item on_refresh_end $term	636	=item on_refresh_end $term
367		637
368	Called just after the screen gets redrawn. See C<on_refresh_begin>.	638	Called just after the screen gets redrawn. See C<on_refresh_begin>.
369		639
370	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
371		641
372	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
373	C<perl:string> action bound to it (see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
374	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
		645
		646	The event is simply the action string. This interface is assumed to change
		647	slightly in the future.
		648
		649	=item on_resize_all_windows $tern, $new_width, $new_height
		650
		651	Called just after the new window size has been calculated, but before
		652	windows are actually being resized or hints are being set. If this hook
		653	returns TRUE, setting of the window hints is being skipped.
		654
		655	=item on_x_event $term, $event
		656
		657	Called on every X event received on the vt window (and possibly other
		658	windows). Should only be used as a last resort. Most event structure
		659	members are not passed.
		660
		661	=item on_root_event $term, $event
		662
		663	Like C<on_x_event>, but is called for events on the root window.
375		664
376	=item on_focus_in $term	665	=item on_focus_in $term
377		666
378	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
379	does focus in processing.	668	does focus in processing.
380		669
381	=item on_focus_out $term	670	=item on_focus_out $term
382		671
383	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
384	focus out processing.	673	focus out processing.
		674
		675	=item on_configure_notify $term, $event
		676
		677	=item on_property_notify $term, $event
385		678
386	=item on_key_press $term, $event, $keysym, $octets	679	=item on_key_press $term, $event, $keysym, $octets
387		680
388	=item on_key_release $term, $event, $keysym	681	=item on_key_release $term, $event, $keysym
389		682
…		…
399		692
400	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal If
401	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the even will be ignored by rxvt-unicode.
402		695
403	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
404	manpage), with the additional members C<row> and C<col>, which are the row	697	manpage), with the additional members C<row> and C<col>, which are the
405	and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
406		699
407	C<on_key_press> additionally receives the string rxvt-unicode would	700	C<on_key_press> additionally receives the string rxvt-unicode would
408	output, if any, in locale-specific encoding.	701	output, if any, in locale-specific encoding.
409		702
410	subwindow.	703	subwindow.
		704
		705	=item on_client_message $term, $event
		706
		707	=item on_wm_protocols $term, $event
		708
		709	=item on_wm_delete_window $term, $event
		710
		711	Called when various types of ClientMessage events are received (all with
		712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
411		713
412	=back	714	=back
413		715
414	=cut	716	=cut
415		717
…		…
421	use Scalar::Util ();	723	use Scalar::Util ();
422	use List::Util ();	724	use List::Util ();
423		725
424	our $VERSION = 1;	726	our $VERSION = 1;
425	our $TERM;	727	our $TERM;
		728	our @TERM_INIT;
		729	our @TERM_EXT;
426	our @HOOKNAME;	730	our @HOOKNAME;
427	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	731	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
428	our %OPTION;	732	our %OPTION;
429		733
430	our $LIBDIR;	734	our $LIBDIR;
431	our $RESNAME;	735	our $RESNAME;
432	our $RESCLASS;	736	our $RESCLASS;
433	our $RXVTNAME;	737	our $RXVTNAME;
434		738
		739	our $NOCHAR = chr 0xffff;
		740
435	=head2 Variables in the C<urxvt> Package	741	=head2 Variables in the C<urxvt> Package
436		742
437	=over 4	743	=over 4
438		744
439	=item $urxvt::LIBDIR	745	=item $urxvt::LIBDIR
…		…
451		757
452	=item $urxvt::TERM	758	=item $urxvt::TERM
453		759
454	The current terminal. This variable stores the current C<urxvt::term>	760	The current terminal. This variable stores the current C<urxvt::term>
455	object, whenever a callback/hook is executing.	761	object, whenever a callback/hook is executing.
		762
		763	=item @urxvt::TERM_INIT
		764
		765	All code references in this array will be called as methods of the next newly
		766	created C<urxvt::term> object (during the C<on_init> phase). The array
		767	gets cleared before the code references that were in it are being executed,
		768	so references can push themselves onto it again if they so desire.
		769
		770	This complements to the perl-eval command line option, but gets executed
		771	first.
		772
		773	=item @urxvt::TERM_EXT
		774
		775	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		776	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		777	but before other extensions. Gets cleared just like C<@TERM_INIT>.
456		778
457	=back	779	=back
458		780
459	=head2 Functions in the C<urxvt> Package	781	=head2 Functions in the C<urxvt> Package
460		782
…		…
475	Using this function has the advantage that its output ends up in the	797	Using this function has the advantage that its output ends up in the
476	correct place, e.g. on stderr of the connecting urxvtc client.	798	correct place, e.g. on stderr of the connecting urxvtc client.
477		799
478	Messages have a size limit of 1023 bytes currently.	800	Messages have a size limit of 1023 bytes currently.
479		801
480	=item $is_safe = urxvt::safe	802	=item @terms = urxvt::termlist
481		803
482	Returns true when it is safe to do potentially unsafe things, such as	804	Returns all urxvt::term objects that exist in this process, regardless of
483	evaluating perl code specified by the user. This is true when urxvt was	805	whether they are started, being destroyed etc., so be careful. Only term
484	started setuid or setgid.	806	objects that have perl extensions attached will be returned (because there
		807	is no urxvt::term objet associated with others).
485		808
486	=item $time = urxvt::NOW	809	=item $time = urxvt::NOW
487		810
488	Returns the "current time" (as per the event loop).	811	Returns the "current time" (as per the event loop).
489		812
490	=item urxvt::CurrentTime	813	=item urxvt::CurrentTime
491		814
492	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	815	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
493	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	816	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
494	Button4Mask, Button5Mask, AnyModifier	817	Button4Mask, Button5Mask, AnyModifier
		818
		819	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		820	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		821	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		822	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		823	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		824	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		825	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		826
		827	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		828	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		829	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		830	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		831	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		832	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		833	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
495		834
496	Various constants for use in X calls and event processing.	835	Various constants for use in X calls and event processing.
497		836
498	=back	837	=back
499		838
…		…
532		871
533	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	872	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
534		873
535	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	874	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
536		875
		876	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		877
537	Replace the foreground/background colour in the rendition mask with the	878	Replace the foreground/background colour in the rendition mask with the
538	specified one.	879	specified one.
539		880
540	=item $value = urxvt::GET_CUSTOM $rend	881	=item $value = urxvt::GET_CUSTOM $rend
541		882
…		…
550	=back	891	=back
551		892
552	=cut	893	=cut
553		894
554	BEGIN {	895	BEGIN {
555	urxvt->bootstrap;
556
557	# overwrite perl's warn	896	# overwrite perl's warn
558	*CORE::GLOBAL::warn = sub {	897	*CORE::GLOBAL::warn = sub {
559	my $msg = join "", @_;	898	my $msg = join "", @_;
560	$msg .= "\n"	899	$msg .= "\n"
561	unless $msg =~ /\n$/;	900	unless $msg =~ /\n$/;
562	urxvt::warn ($msg);	901	urxvt::warn ($msg);
563	};	902	};
564
565	# %ENV is the original startup environment
566	delete $ENV{IFS};
567	delete $ENV{CDPATH};
568	delete $ENV{BASH_ENV};
569	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
570	}	903	}
571		904
572	my @hook_count;	905	no warnings 'utf8';
		906
573	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	907	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
574		908
575	sub verbose {	909	sub verbose {
576	my ($level, $msg) = @_;	910	my ($level, $msg) = @_;
577	warn "$msg\n" if $level <= $verbosity;	911	warn "$msg\n" if $level <= $verbosity;
578	}	912	}
579		913
580	my $extension_pkg = "extension0000";
581	my %extension_pkg;	914	my %extension_pkg;
582		915
583	# load a single script into its own package, once only	916	# load a single script into its own package, once only
584	sub extension_package($) {	917	sub extension_package($) {
585	my ($path) = @_;	918	my ($path) = @_;
586		919
587	$extension_pkg{$path} ||= do {	920	$extension_pkg{$path} ||= do {
588	my $pkg = "urxvt::" . ($extension_pkg++);	921	$path =~ /([^\/\\]+)$/;
		922	my $pkg = $1;
		923	$pkg =~ s/[^[:word:]]/_/g;
		924	$pkg = "urxvt::ext::$pkg";
589		925
590	verbose 3, "loading extension '$path' into package '$pkg'";	926	verbose 3, "loading extension '$path' into package '$pkg'";
591		927
592	open my $fh, "<:raw", $path	928	open my $fh, "<:raw", $path
593	or die "$path: $!";	929	or die "$path: $!";
594		930
595	my $source = untaint	931	my $source =
596	"package $pkg; use strict; use utf8;\n"	932	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
597	. "use base urxvt::term::extension::;\n"
598	. "#line 1 \"$path\"\n{\n"	933	. "#line 1 \"$path\"\n{\n"
599	. (do { local $/; <$fh> })	934	. (do { local $/; <$fh> })
600	. "\n};\n1";	935	. "\n};\n1";
601		936
602	eval $source	937	eval $source
…		…
613	local $TERM = shift;	948	local $TERM = shift;
614	my $htype = shift;	949	my $htype = shift;
615		950
616	if ($htype == 0) { # INIT	951	if ($htype == 0) { # INIT
617	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
618		953
619	my %ext_arg;	954	my %ext_arg;
620		955
		956	{
		957	my @init = @TERM_INIT;
		958	@TERM_INIT = ();
		959	$_->($TERM) for @init;
		960	my @pkg = @TERM_EXT;
		961	@TERM_EXT = ();
		962	$TERM->register_package ($_) for @pkg;
		963	}
		964
621	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	965	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
622	if ($_ eq "default") {	966	if ($_ eq "default") {
623	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	967	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
624	} elsif (/^-(.*)$/) {	968	} elsif (/^-(.*)$/) {
625	delete $ext_arg{$1};	969	delete $ext_arg{$1};
626	} elsif (/^([^<]+)<(.*)>$/) {	970	} elsif (/^([^<]+)<(.*)>$/) {
627	push @{ $ext_arg{$1} }, $2;	971	push @{ $ext_arg{$1} }, $2;
628	} else {	972	} else {
629	$ext_arg{$_} ||= [];	973	$ext_arg{$_} ||= [];
630	}	974	}
631	}	975	}
632		976
633	while (my ($ext, $argv) = each %ext_arg) {	977	for my $ext (sort keys %ext_arg) {
634	my @files = grep -f $_, map "$_/$ext", @dirs;	978	my @files = grep -f $_, map "$_/$ext", @dirs;
635		979
636	if (@files) {	980	if (@files) {
637	$TERM->register_package (extension_package $files[0], $argv);	981	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
638	} else {	982	} else {
639	warn "perl extension '$ext' not found in perl library search path\n";	983	warn "perl extension '$ext' not found in perl library search path\n";
640	}	984	}
641	}	985	}
642		986
…		…
648		992
649	if (my $cb = $TERM->{_hook}[$htype]) {	993	if (my $cb = $TERM->{_hook}[$htype]) {
650	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	994	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
651	if $verbosity >= 10;	995	if $verbosity >= 10;
652		996
653	keys %$cb;	997	for my $pkg (keys %$cb) {
654
655	while (my ($pkg, $cb) = each %$cb) {
656	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	998	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
657	and last;	999	$retval ||= $retval_;
658		1000
659	if ($@) {	1001	if ($@) {
660	$TERM->ungrab; # better to lose the grab than the session	1002	$TERM->ungrab; # better to lose the grab than the session
661	warn $@;	1003	warn $@;
662	}	1004	}
…		…
665	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	1007	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
666	if $verbosity >= 11;	1008	if $verbosity >= 11;
667	}	1009	}
668		1010
669	if ($htype == 1) { # DESTROY	1011	if ($htype == 1) { # DESTROY
670	if (my $hook = delete $TERM->{_hook}) {
671	for my $htype (0..$#$hook) {
672	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
673	or set_should_invoke $htype, 0;
674	}
675	}
676
677	# clear package objects	1012	# clear package objects
678	%$_ = () for values %{ $TERM->{_pkg} };	1013	%$_ = () for values %{ $TERM->{_pkg} };
679		1014
680	# clear package	1015	# clear package
681	%$TERM = ();	1016	%$TERM = ();
682	}	1017	}
683		1018
684	$retval	1019	$retval
685	}	1020	}
686		1021
687	sub exec_async(@) {	1022	sub SET_COLOR($$$) {
688	my $pid = fork;	1023	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1024	}
689		1025
690	return	1026	sub rend2mask {
691	if !defined $pid or $pid;	1027	no strict 'refs';
692		1028	my ($str, $mask) = (@_, 0);
693	%ENV = %{ $TERM->env };	1029	my %color = ( fg => undef, bg => undef );
694		1030	my @failed;
695	exec @_;	1031	for my $spec ( split /\s+/, $str ) {
696	_exit 255;	1032	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1033	$color{lc($1)} = $2;
		1034	} else {
		1035	my $neg = $spec =~ s/^[-^]//;
		1036	unless ( exists &{"RS_$spec"} ) {
		1037	push @failed, $spec;
		1038	next;
		1039	}
		1040	my $cur = &{"RS_$spec"};
		1041	if ( $neg ) {
		1042	$mask &= ~$cur;
		1043	} else {
		1044	$mask |= $cur;
		1045	}
		1046	}
		1047	}
		1048	($mask, @color{qw(fg bg)}, \@failed)
697	}	1049	}
698		1050
699	# urxvt::term::extension	1051	# urxvt::term::extension
700		1052
701	package urxvt::term::extension;	1053	package urxvt::term::extension;
…		…
707	while (my ($name, $cb) = each %hook) {	1059	while (my ($name, $cb) = each %hook) {
708	my $htype = $HOOKTYPE{uc $name};	1060	my $htype = $HOOKTYPE{uc $name};
709	defined $htype	1061	defined $htype
710	or Carp::croak "unsupported hook type '$name'";	1062	or Carp::croak "unsupported hook type '$name'";
711		1063
		1064	$self->set_should_invoke ($htype, +1)
712	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1065	unless exists $self->{term}{_hook}[$htype]{$pkg};
713	$hook_count[$htype]++
714	or urxvt::set_should_invoke $htype, 1;
715	}
716		1066
717	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1067	$self->{term}{_hook}[$htype]{$pkg} = $cb;
718	}	1068	}
719	}	1069	}
720		1070
…		…
725	for my $name (@hook) {	1075	for my $name (@hook) {
726	my $htype = $HOOKTYPE{uc $name};	1076	my $htype = $HOOKTYPE{uc $name};
727	defined $htype	1077	defined $htype
728	or Carp::croak "unsupported hook type '$name'";	1078	or Carp::croak "unsupported hook type '$name'";
729		1079
		1080	$self->set_should_invoke ($htype, -1)
730	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1081	if delete $self->{term}{_hook}[$htype]{$pkg};
731	--$hook_count[$htype]
732	or urxvt::set_should_invoke $htype, 0;
733	}
734	}	1082	}
735	}	1083	}
736		1084
737	our $AUTOLOAD;	1085	our $AUTOLOAD;
738		1086
…		…
776	is that you cannot use blocking APIs, but the non-blocking variant should	1124	is that you cannot use blocking APIs, but the non-blocking variant should
777	work.	1125	work.
778		1126
779	=cut	1127	=cut
780		1128
781	our $VERSION = 1;	1129	our $VERSION = '3.4';
782		1130
783	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1131	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
784	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1132	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
785		1133
786	sub timer {	1134	sub timer {
…		…
817		1165
818	sub DESTROY {	1166	sub DESTROY {
819	$_[0][1]->stop;	1167	$_[0][1]->stop;
820	}	1168	}
821		1169
822	sub condvar {	1170	sub one_event {
823	bless \my $flag, urxvt::anyevent::condvar::
824	}
825
826	sub urxvt::anyevent::condvar::broadcast {
827	${$_[0]}++;
828	}
829
830	sub urxvt::anyevent::condvar::wait {
831	unless (${$_[0]}) {
832	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1171	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
833	}
834	}	1172	}
835		1173
836	package urxvt::term;	1174	package urxvt::term;
837		1175
838	=head2 The C<urxvt::term> Class	1176	=head2 The C<urxvt::term> Class
…		…
843		1181
844	# find on_xxx subs in the package and register them	1182	# find on_xxx subs in the package and register them
845	# as hooks	1183	# as hooks
846	sub register_package {	1184	sub register_package {
847	my ($self, $pkg, $argv) = @_;	1185	my ($self, $pkg, $argv) = @_;
		1186
		1187	no strict 'refs';
		1188
		1189	urxvt::verbose 6, "register package $pkg to $self";
		1190
		1191	@{"$pkg\::ISA"} = urxvt::term::extension::;
848		1192
849	my $proxy = bless {	1193	my $proxy = bless {
850	_pkg => $pkg,	1194	_pkg => $pkg,
851	argv => $argv,	1195	argv => $argv,
852	}, $pkg;	1196	}, $pkg;
…		…
868	hash which defines the environment of the new terminal.	1212	hash which defines the environment of the new terminal.
869		1213
870	Croaks (and probably outputs an error message) if the new instance	1214	Croaks (and probably outputs an error message) if the new instance
871	couldn't be created. Returns C<undef> if the new instance didn't	1215	couldn't be created. Returns C<undef> if the new instance didn't
872	initialise perl, and the terminal object otherwise. The C<init> and	1216	initialise perl, and the terminal object otherwise. The C<init> and
873	C<start> hooks will be called during this call.	1217	C<start> hooks will be called before this call returns, and are free to
		1218	refer to global data (which is race free).
874		1219
875	=cut	1220	=cut
876		1221
877	sub new {	1222	sub new {
878	my ($class, $env, @args) = @_;	1223	my ($class, $env, @args) = @_;
879		1224
		1225	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1226	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1227
880	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1228	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
881	}	1229	}
882		1230
883	=item $term->destroy	1231	=item $term->destroy
884		1232
885	Destroy the terminal object (close the window, free resources	1233	Destroy the terminal object (close the window, free resources
886	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1234	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
887	watchers (timers, io watchers) are still active.	1235	watchers (timers, io watchers) are still active.
888		1236
		1237	=item $term->exec_async ($cmd[, @args])
		1238
		1239	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1240	("starts") programs in the background. This function takes care of setting
		1241	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1242	be preferred over explicit calls to C<exec> or C<system>.
		1243
		1244	Returns the pid of the subprocess or C<undef> on error.
		1245
		1246	=cut
		1247
		1248	sub exec_async {
		1249	my $self = shift;
		1250
		1251	my $pid = fork;
		1252
		1253	return $pid
		1254	if !defined $pid or $pid;
		1255
		1256	%ENV = %{ $self->env };
		1257
		1258	exec @_;
		1259	urxvt::_exit 255;
		1260	}
		1261
889	=item $isset = $term->option ($optval[, $set])	1262	=item $isset = $term->option ($optval[, $set])
890		1263
891	Returns true if the option specified by C<$optval> is enabled, and	1264	Returns true if the option specified by C<$optval> is enabled, and
892	optionally change it. All option values are stored by name in the hash	1265	optionally change it. All option values are stored by name in the hash
893	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1266	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
894		1267
895	Here is a a likely non-exhaustive list of option names, please see the	1268	Here is a likely non-exhaustive list of option names, please see the
896	source file F</src/optinc.h> to see the actual list:	1269	source file F</src/optinc.h> to see the actual list:
897		1270
898	borderLess console cursorBlink cursorUnderline hold iconic insecure	1271	borderLess console cursorBlink cursorUnderline hold iconic insecure
899	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1272	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
900	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1273	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
901	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1274	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
902	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1275	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
903	tripleclickwords utmpInhibit visualBell	1276	transparent tripleclickwords utmpInhibit visualBell
904		1277
905	=item $value = $term->resource ($name[, $newval])	1278	=item $value = $term->resource ($name[, $newval])
906		1279
907	Returns the current resource value associated with a given name and	1280	Returns the current resource value associated with a given name and
908	optionally sets a new value. Setting values is most useful in the C<init>	1281	optionally sets a new value. Setting values is most useful in the C<init>
…		…
917	likely change).	1290	likely change).
918		1291
919	Please note that resource strings will currently only be freed when the	1292	Please note that resource strings will currently only be freed when the
920	terminal is destroyed, so changing options frequently will eat memory.	1293	terminal is destroyed, so changing options frequently will eat memory.
921		1294
922	Here is a a likely non-exhaustive list of resource names, not all of which	1295	Here is a likely non-exhaustive list of resource names, not all of which
923	are supported in every build, please see the source file F</src/rsinc.h>	1296	are supported in every build, please see the source file F</src/rsinc.h>
924	to see the actual list:	1297	to see the actual list:
925		1298
926	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1299	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
927	borderLess color cursorBlink cursorUnderline cutchars delete_key	1300	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
928	display_name embed ext_bwidth fade font geometry hold iconName	1301	display_name embed ext_bwidth fade font geometry hold iconName
929	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1302	imFont imLocale inputMethod insecure int_bwidth intensityStyles
930	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1303	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
931	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1304	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
932	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1305	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
933	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1306	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
934	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1307	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
935	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1308	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
936	shade term_name title transparent transparent_all tripleclickwords	1309	secondaryScreen secondaryScroll shade term_name title
937	utmpInhibit visualBell	1310	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1311	visualBell
938		1312
939	=cut	1313	=cut
940		1314
941	sub resource($$;$) {	1315	sub resource($$;$) {
942	my ($self, $name) = (shift, shift);	1316	my ($self, $name) = (shift, shift);
943	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1317	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
944	&urxvt::term::_resource	1318	goto &urxvt::term::_resource
945	}	1319	}
946		1320
947	=item $value = $term->x_resource ($pattern)	1321	=item $value = $term->x_resource ($pattern)
948		1322
949	Returns the X-Resource for the given pattern, excluding the program or	1323	Returns the X-Resource for the given pattern, excluding the program or
…		…
1032		1406
1033	The methods currently supported on C<urxvt::overlay> objects are:	1407	The methods currently supported on C<urxvt::overlay> objects are:
1034		1408
1035	=over 4	1409	=over 4
1036		1410
1037	=item $overlay->set ($x, $y, $text, $rend)	1411	=item $overlay->set ($x, $y, $text[, $rend])
1038		1412
1039	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1413	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1040	text in rxvt-unicode's special encoding and an array of rendition values	1414	text in rxvt-unicode's special encoding and an array of rendition values
1041	at a specific position inside the overlay.	1415	at a specific position inside the overlay.
		1416
		1417	If C<$rend> is missing, then the rendition will not be changed.
1042		1418
1043	=item $overlay->hide	1419	=item $overlay->hide
1044		1420
1045	If visible, hide the overlay, but do not destroy it.	1421	If visible, hide the overlay, but do not destroy it.
1046		1422
…		…
1116		1492
1117	Normally its not a good idea to use this function, as programs might be	1493	Normally its not a good idea to use this function, as programs might be
1118	confused by changes in cursor position or scrolling. Its useful inside a	1494	confused by changes in cursor position or scrolling. Its useful inside a
1119	C<on_add_lines> hook, though.	1495	C<on_add_lines> hook, though.
1120		1496
		1497	=item $term->scr_change_screen ($screen)
		1498
		1499	Switch to given screen - 0 primary, 1 secondary.
		1500
1121	=item $term->cmd_parse ($octets)	1501	=item $term->cmd_parse ($octets)
1122		1502
1123	Similar to C<scr_add_lines>, but the argument must be in the	1503	Similar to C<scr_add_lines>, but the argument must be in the
1124	locale-specific encoding of the terminal and can contain command sequences	1504	locale-specific encoding of the terminal and can contain command sequences
1125	(escape codes) that will be interpreted.	1505	(escape codes) that will be interpreted.
…		…
1135	Replaces the event mask of the pty watcher by the given event mask. Can	1515	Replaces the event mask of the pty watcher by the given event mask. Can
1136	be used to suppress input and output handling to the pty/tty. See the	1516	be used to suppress input and output handling to the pty/tty. See the
1137	description of C<< urxvt::timer->events >>. Make sure to always restore	1517	description of C<< urxvt::timer->events >>. Make sure to always restore
1138	the previous value.	1518	the previous value.
1139		1519
		1520	=item $fd = $term->pty_fd
		1521
		1522	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1523	is used.
		1524
1140	=item $windowid = $term->parent	1525	=item $windowid = $term->parent
1141		1526
1142	Return the window id of the toplevel window.	1527	Return the window id of the toplevel window.
1143		1528
1144	=item $windowid = $term->vt	1529	=item $windowid = $term->vt
1145		1530
1146	Return the window id of the terminal window.	1531	Return the window id of the terminal window.
1147		1532
		1533	=item $term->vt_emask_add ($x_event_mask)
		1534
		1535	Adds the specified events to the vt event mask. Useful e.g. when you want
		1536	to receive pointer events all the times:
		1537
		1538	$term->vt_emask_add (urxvt::PointerMotionMask);
		1539
		1540	=item $term->focus_in
		1541
		1542	=item $term->focus_out
		1543
		1544	=item $term->key_press ($state, $keycode[, $time])
		1545
		1546	=item $term->key_release ($state, $keycode[, $time])
		1547
		1548	Deliver various fake events to to terminal.
		1549
1148	=item $window_width = $term->width	1550	=item $window_width = $term->width
1149		1551
1150	=item $window_height = $term->height	1552	=item $window_height = $term->height
1151		1553
1152	=item $font_width = $term->fwidth	1554	=item $font_width = $term->fwidth
…		…
1165		1567
1166	=item $max_scrollback = $term->saveLines	1568	=item $max_scrollback = $term->saveLines
1167		1569
1168	=item $nrow_plus_saveLines = $term->total_rows	1570	=item $nrow_plus_saveLines = $term->total_rows
1169		1571
1170	=item $lines_in_scrollback = $term->nsaved	1572	=item $topmost_scrollback_row = $term->top_row
1171		1573
1172	Return various integers describing terminal characteristics.	1574	Return various integers describing terminal characteristics.
1173		1575
1174	=item $x_display = $term->display_id	1576	=item $x_display = $term->display_id
1175		1577
…		…
1182	=item $env = $term->env	1584	=item $env = $term->env
1183		1585
1184	Returns a copy of the environment in effect for the terminal as a hashref	1586	Returns a copy of the environment in effect for the terminal as a hashref
1185	similar to C<\%ENV>.	1587	similar to C<\%ENV>.
1186		1588
		1589	=item @envv = $term->envv
		1590
		1591	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1592
		1593	=item @argv = $term->argv
		1594
		1595	Return the argument vector as this terminal, similar to @ARGV, but
		1596	includes the program name as first element.
		1597
1187	=cut	1598	=cut
1188		1599
1189	sub env {	1600	sub env {
1190	if (my $env = $_[0]->_env) {
1191	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1601	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1192	} else {
1193	+{ %ENV }
1194	}
1195	}	1602	}
1196		1603
1197	=item $modifiermask = $term->ModLevel3Mask	1604	=item $modifiermask = $term->ModLevel3Mask
1198		1605
1199	=item $modifiermask = $term->ModMetaMask	1606	=item $modifiermask = $term->ModMetaMask
…		…
1201	=item $modifiermask = $term->ModNumLockMask	1608	=item $modifiermask = $term->ModNumLockMask
1202		1609
1203	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1610	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1204	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1611	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1205		1612
		1613	=item $screen = $term->current_screen
		1614
		1615	Returns the currently displayed screen (0 primary, 1 secondary).
		1616
		1617	=item $cursor_is_hidden = $term->hidden_cursor
		1618
		1619	Returns whether the cursor is currently hidden or not.
		1620
1206	=item $view_start = $term->view_start ([$newvalue])	1621	=item $view_start = $term->view_start ([$newvalue])
1207		1622
1208	Returns the negative row number of the topmost line. Minimum value is	1623	Returns the row number of the topmost displayed line. Maximum value is
1209	C<0>, which displays the normal terminal contents. Larger values scroll	1624	C<0>, which displays the normal terminal contents. Lower values scroll
1210	this many lines into the scrollback buffer.	1625	this many lines into the scrollback buffer.
1211		1626
1212	=item $term->want_refresh	1627	=item $term->want_refresh
1213		1628
1214	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1629	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1217		1632
1218	Used after changing terminal contents to display them.	1633	Used after changing terminal contents to display them.
1219		1634
1220	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1635	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1221		1636
1222	Returns the text of the entire row with number C<$row_number>. Row C<0>	1637	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1223	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1638	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1224	terminal line. The scrollback buffer starts at line C<-1> and extends to
1225	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1639	terminal line. Nothing will be returned if a nonexistent line
1226	is requested.	1640	is requested.
1227		1641
1228	If C<$new_text> is specified, it will replace characters in the current	1642	If C<$new_text> is specified, it will replace characters in the current
1229	line, starting at column C<$start_col> (default C<0>), which is useful	1643	line, starting at column C<$start_col> (default C<0>), which is useful
1230	to replace only parts of a line. The font index in the rendition will	1644	to replace only parts of a line. The font index in the rendition will
1231	automatically be updated.	1645	automatically be updated.
1232		1646
1233	C<$text> is in a special encoding: tabs and wide characters that use more	1647	C<$text> is in a special encoding: tabs and wide characters that use more
1234	than one cell when displayed are padded with urxvt::NOCHAR characters	1648	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1235	(C<chr 65535>). Characters with combining characters and other characters	1649	characters. Characters with combining characters and other characters that
1236	that do not fit into the normal tetx encoding will be replaced with	1650	do not fit into the normal text encoding will be replaced with characters
1237	characters in the private use area.	1651	in the private use area.
1238		1652
1239	You have to obey this encoding when changing text. The advantage is	1653	You have to obey this encoding when changing text. The advantage is
1240	that C<substr> and similar functions work on screen cells and not on	1654	that C<substr> and similar functions work on screen cells and not on
1241	characters.	1655	characters.
1242		1656
…		…
1386	where one character corresponds to one screen cell. See	1800	where one character corresponds to one screen cell. See
1387	C<< $term->ROW_t >> for details.	1801	C<< $term->ROW_t >> for details.
1388		1802
1389	=item $string = $term->special_decode $text	1803	=item $string = $term->special_decode $text
1390		1804
1391	Converts rxvt-unicodes text reprsentation into a perl string. See	1805	Converts rxvt-unicodes text representation into a perl string. See
1392	C<< $term->ROW_t >> for details.	1806	C<< $term->ROW_t >> for details.
1393		1807
1394	=item $success = $term->grab_button ($button, $modifiermask)	1808	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1395		1809
		1810	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1811
1396	Registers a synchronous button grab. See the XGrabButton manpage.	1812	Register/unregister a synchronous button grab. See the XGrabButton
		1813	manpage.
1397		1814
1398	=item $success = $term->grab ($eventtime[, $sync])	1815	=item $success = $term->grab ($eventtime[, $sync])
1399		1816
1400	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1817	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1401	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1818	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1402		1819
1403	=item $term->allow_events_async	1820	=item $term->allow_events_async
1404		1821
1405	Calls XAllowEvents with AsyncBoth for the most recent grab.	1822	Calls XAllowEvents with AsyncBoth for the most recent grab.
1406		1823
…		…
1416	=item $term->ungrab	1833	=item $term->ungrab
1417		1834
1418	Calls XUngrab for the most recent grab. Is called automatically on	1835	Calls XUngrab for the most recent grab. Is called automatically on
1419	evaluation errors, as it is better to lose the grab in the error case as	1836	evaluation errors, as it is better to lose the grab in the error case as
1420	the session.	1837	the session.
		1838
		1839	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1840
		1841	=item $atom_name = $term->XGetAtomName ($atom)
		1842
		1843	=item @atoms = $term->XListProperties ($window)
		1844
		1845	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1846
		1847	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1848
		1849	=item $term->XDeleteProperty ($window, $property)
		1850
		1851	=item $window = $term->DefaultRootWindow
		1852
		1853	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1854
		1855	=item $term->XMapWindow ($window)
		1856
		1857	=item $term->XUnmapWindow ($window)
		1858
		1859	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1860
		1861	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1862
		1863	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1864
		1865	Various X or X-related functions. The C<$term> object only serves as
		1866	the source of the display, otherwise those functions map more-or-less
		1867	directory onto the X functions of the same name.
1421		1868
1422	=back	1869	=back
1423		1870
1424	=cut	1871	=cut
1425		1872
…		…
1489	my ($self, $text, $cb) = @_;	1936	my ($self, $text, $cb) = @_;
1490		1937
1491	$self->add_item ({ type => "button", text => $text, activate => $cb});	1938	$self->add_item ({ type => "button", text => $text, activate => $cb});
1492	}	1939	}
1493		1940
1494	=item $popup->add_toggle ($text, $cb, $initial_value)	1941	=item $popup->add_toggle ($text, $initial_value, $cb)
1495		1942
1496	Adds a toggle/checkbox item to the popup. Teh callback gets called	1943	Adds a toggle/checkbox item to the popup. The callback gets called
1497	whenever it gets toggled, with a boolean indicating its value as its first	1944	whenever it gets toggled, with a boolean indicating its new value as its
1498	argument.	1945	first argument.
1499		1946
1500	=cut	1947	=cut
1501		1948
1502	sub add_toggle {	1949	sub add_toggle {
1503	my ($self, $text, $cb, $value) = @_;	1950	my ($self, $text, $value, $cb) = @_;
1504		1951
1505	my $item; $item = {	1952	my $item; $item = {
1506	type => "button",	1953	type => "button",
1507	text => " $text",	1954	text => " $text",
1508	value => $value,	1955	value => $value,
…		…
1527	my $env = $self->{term}->env;	1974	my $env = $self->{term}->env;
1528	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1975	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1529	delete $env->{LC_ALL};	1976	delete $env->{LC_ALL};
1530	$env->{LC_CTYPE} = $self->{term}->locale;	1977	$env->{LC_CTYPE} = $self->{term}->locale;
1531		1978
1532	urxvt::term->new ($env, $self->{term}->resource ("name"),	1979	my $term = urxvt::term->new (
1533	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1980	$env, "popup",
		1981	"--perl-lib" => "", "--perl-ext-common" => "",
		1982	"-pty-fd" => -1, "-sl" => 0,
		1983	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1534	"--transient-for" => $self->{term}->parent,	1984	"--transient-for" => $self->{term}->parent,
1535	"-display" => $self->{term}->display_id,	1985	"-display" => $self->{term}->display_id,
1536	"-pe" => "urxvt-popup")	1986	"-pe" => "urxvt-popup",
1537	or die "unable to create popup window\n";	1987	) or die "unable to create popup window\n";
		1988
		1989	unless (delete $term->{urxvt_popup_init_done}) {
		1990	$term->ungrab;
		1991	$term->destroy;
		1992	die "unable to initialise popup window\n";
		1993	}
1538	}	1994	}
1539		1995
1540	sub DESTROY {	1996	sub DESTROY {
1541	my ($self) = @_;	1997	my ($self) = @_;
1542		1998
1543	delete $self->{term}{_destroy}{$self};	1999	delete $self->{term}{_destroy}{$self};
1544	$self->{term}->ungrab;	2000	$self->{term}->ungrab;
1545	}	2001	}
1546		2002
1547	=back	2003	=back
		2004
		2005	=cut
		2006
		2007	package urxvt::watcher;
1548		2008
1549	=head2 The C<urxvt::timer> Class	2009	=head2 The C<urxvt::timer> Class
1550		2010
1551	This class implements timer watchers/events. Time is represented as a	2011	This class implements timer watchers/events. Time is represented as a
1552	fractional number of seconds since the epoch. Example:	2012	fractional number of seconds since the epoch. Example:
…		…
1556	->new	2016	->new
1557	->interval (1)	2017	->interval (1)
1558	->cb (sub {	2018	->cb (sub {
1559	$term->{overlay}->set (0, 0,	2019	$term->{overlay}->set (0, 0,
1560	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2020	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1561	});	2021	});
1562		2022
1563	=over 4	2023	=over 4
1564		2024
1565	=item $timer = new urxvt::timer	2025	=item $timer = new urxvt::timer
1566		2026
…		…
1590	Start the timer.	2050	Start the timer.
1591		2051
1592	=item $timer = $timer->start ($tstamp)	2052	=item $timer = $timer->start ($tstamp)
1593		2053
1594	Set the event trigger time to C<$tstamp> and start the timer.	2054	Set the event trigger time to C<$tstamp> and start the timer.
		2055
		2056	=item $timer = $timer->after ($delay)
		2057
		2058	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1595		2059
1596	=item $timer = $timer->stop	2060	=item $timer = $timer->stop
1597		2061
1598	Stop the timer.	2062	Stop the timer.
1599		2063
…		…
1605		2069
1606	$term->{socket} = ...	2070	$term->{socket} = ...
1607	$term->{iow} = urxvt::iow	2071	$term->{iow} = urxvt::iow
1608	->new	2072	->new
1609	->fd (fileno $term->{socket})	2073	->fd (fileno $term->{socket})
1610	->events (urxvt::EVENT_READ)	2074	->events (urxvt::EV_READ)
1611	->start	2075	->start
1612	->cb (sub {	2076	->cb (sub {
1613	my ($iow, $revents) = @_;	2077	my ($iow, $revents) = @_;
1614	# $revents must be 1 here, no need to check	2078	# $revents must be 1 here, no need to check
1615	sysread $term->{socket}, my $buf, 8192	2079	sysread $term->{socket}, my $buf, 8192
…		…
1628	Set the callback to be called when io events are triggered. C<$reventmask>	2092	Set the callback to be called when io events are triggered. C<$reventmask>
1629	is a bitset as described in the C<events> method.	2093	is a bitset as described in the C<events> method.
1630		2094
1631	=item $iow = $iow->fd ($fd)	2095	=item $iow = $iow->fd ($fd)
1632		2096
1633	Set the filedescriptor (not handle) to watch.	2097	Set the file descriptor (not handle) to watch.
1634		2098
1635	=item $iow = $iow->events ($eventmask)	2099	=item $iow = $iow->events ($eventmask)
1636		2100
1637	Set the event mask to watch. The only allowed values are	2101	Set the event mask to watch. The only allowed values are
1638	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2102	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1639	together, or C<urxvt::EVENT_NONE>.	2103	together, or C<urxvt::EV_NONE>.
1640		2104
1641	=item $iow = $iow->start	2105	=item $iow = $iow->start
1642		2106
1643	Start watching for requested events on the given handle.	2107	Start watching for requested events on the given handle.
1644		2108
1645	=item $iow = $iow->stop	2109	=item $iow = $iow->stop
1646		2110
1647	Stop watching for events on the given filehandle.	2111	Stop watching for events on the given file handle.
		2112
		2113	=back
		2114
		2115	=head2 The C<urxvt::iw> Class
		2116
		2117	This class implements idle watchers, that get called automatically when
		2118	the process is idle. They should return as fast as possible, after doing
		2119	some useful work.
		2120
		2121	=over 4
		2122
		2123	=item $iw = new urxvt::iw
		2124
		2125	Create a new idle watcher object in stopped state.
		2126
		2127	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2128
		2129	Set the callback to be called when the watcher triggers.
		2130
		2131	=item $timer = $timer->start
		2132
		2133	Start the watcher.
		2134
		2135	=item $timer = $timer->stop
		2136
		2137	Stop the watcher.
		2138
		2139	=back
		2140
		2141	=head2 The C<urxvt::pw> Class
		2142
		2143	This class implements process watchers. They create an event whenever a
		2144	process exits, after which they stop automatically.
		2145
		2146	my $pid = fork;
		2147	...
		2148	$term->{pw} = urxvt::pw
		2149	->new
		2150	->start ($pid)
		2151	->cb (sub {
		2152	my ($pw, $exit_status) = @_;
		2153	...
		2154	});
		2155
		2156	=over 4
		2157
		2158	=item $pw = new urxvt::pw
		2159
		2160	Create a new process watcher in stopped state.
		2161
		2162	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2163
		2164	Set the callback to be called when the timer triggers.
		2165
		2166	=item $pw = $timer->start ($pid)
		2167
		2168	Tells the watcher to start watching for process C<$pid>.
		2169
		2170	=item $pw = $pw->stop
		2171
		2172	Stop the watcher.
1648		2173
1649	=back	2174	=back
1650		2175
1651	=head1 ENVIRONMENT	2176	=head1 ENVIRONMENT
1652		2177
…		…
1661		2186
1662	=item >= 3 - script loading and management	2187	=item >= 3 - script loading and management
1663		2188
1664	=item >=10 - all called hooks	2189	=item >=10 - all called hooks
1665		2190
1666	=item >=11 - hook reutrn values	2191	=item >=11 - hook return values
1667		2192
1668	=back	2193	=back
1669		2194
1670	=head1 AUTHOR	2195	=head1 AUTHOR
1671		2196
…		…
1673	http://software.schmorp.de/pkg/rxvt-unicode	2198	http://software.schmorp.de/pkg/rxvt-unicode
1674		2199
1675	=cut	2200	=cut
1676		2201
1677	1	2202	1
		2203
		2204	# vim: sw=3:

Diff Legend

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