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.101 by root, Wed Jan 18 10:11:03 2006 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC

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

Diff Legend

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