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.99 by root, Tue Jan 17 17:09:26 2006 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 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.
		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.
…		…
125	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/
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/^([^:[: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/
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 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.
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
165	overlays or changes.	396	overlays or changes.
166		397
167	=item selection-pastebin	398	=item confirm-paste
168		399
169	This is a little rarely useful extension that Uploads the selection as	400	Displays a confirmation dialog when a paste containing at least a full
170	textfile to a remote site (or does other things). (The implementation is	401	line is detected.
171	not currently secure for use in a multiuser environment as it writes to
172	F</tmp> directly.).
173
174	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
175	i.e.
176
177	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
178
179	Pressing this combination runs a command with C<%> replaced by the name of
180	the textfile. This command can be set via a resource:
181
182	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
183
184	And the default is likely not useful to anybody but the few people around
185	here :)
186
187	The name of the textfile is the hex encoded md5 sum of the selection, so
188	the same content should lead to the same filename.
189
190	After a successful upload the selection will be replaced by the text given
191	in the C<selection-pastebin-url> resource (again, the % is the placeholder
192	for the filename):
193
194	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
195		402
196	=back	403	=back
197		404
198	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
199		406
…		…
215		422
216	=over 4	423	=over 4
217		424
218	=item $text	425	=item $text
219		426
220	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
221	always represents one screen cell. See L<ROW_t> for a discussion of this format.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
222		429
223	=item $string	430	=item $string
224		431
225	A perl text string, with an emphasis on I<text>. It can store all unicode	432	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
233		440
234	=back	441	=back
235		442
236	=head2 Extension Objects	443	=head2 Extension Objects
237		444
238	Very perl extension is a perl class. A separate perl object is created	445	Every perl extension is a perl class. A separate perl object is created
239	for each terminal and each extension and passed as the first parameter to	446	for each terminal, and each terminal has its own set of extenion objects,
240	hooks. So extensions can use their C<$self> object without having to think	447	which are passed as the first parameter to hooks. So extensions can use
241	about other extensions, with the exception of methods and members that	448	their C<$self> object without having to think about clashes with other
		449	extensions or other terminals, with the exception of methods and members
242	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
243	use.	451	internal use.
244		452
245	Although it isn't a C<urxvt::term> object, you can call all methods of the	453	Although it isn't a C<urxvt::term> object, you can call all methods of the
246	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
247		455
248	It has the following methods and data members:	456	It has the following methods and data members:
…		…
269	=head2 Hooks	477	=head2 Hooks
270		478
271	The following subroutines can be declared in extension files, and will be	479	The following subroutines can be declared in extension files, and will be
272	called whenever the relevant event happens.	480	called whenever the relevant event happens.
273		481
274	The first argument passed to them is an extension oject as described in	482	The first argument passed to them is an extension object as described in
275	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
276		484
277	B<All> of these hooks must return a boolean value. If it is true, then the	485	B<All> of these hooks must return a boolean value. If any of the called
278	event counts as being I<consumed>, and the invocation of other hooks is	486	hooks returns true, then the event counts as being I<consumed>, and the
279	skipped, and the relevant action might not be carried out by the C++ code.	487	relevant action might not be carried out by the C++ code.
280		488
281	I<< When in doubt, return a false value (preferably C<()>). >>	489	I<< When in doubt, return a false value (preferably C<()>). >>
282		490
283	=over 4	491	=over 4
284		492
285	=item on_init $term	493	=item on_init $term
286		494
287	Called after a new terminal object has been initialized, but before	495	Called after a new terminal object has been initialized, but before
288	windows are created or the command gets run. Most methods are unsafe to	496	windows are created or the command gets run. Most methods are unsafe to
289	call or deliver senseless data, as terminal size and other characteristics	497	call or deliver senseless data, as terminal size and other characteristics
290	have not yet been determined. You can safely query and change resources,	498	have not yet been determined. You can safely query and change resources
291	though.	499	and options, though. For many purposes the C<on_start> hook is a better
		500	place.
		501
		502	=item on_start $term
		503
		504	Called at the very end of initialisation of a new terminal, just before
		505	trying to map (display) the toplevel and returning to the main loop.
		506
		507	=item on_destroy $term
		508
		509	Called whenever something tries to destroy terminal, when the terminal is
		510	still fully functional (not for long, though).
292		511
293	=item on_reset $term	512	=item on_reset $term
294		513
295	Called after the screen is "reset" for any reason, such as resizing or	514	Called after the screen is "reset" for any reason, such as resizing or
296	control sequences. Here is where you can react on changes to size-related	515	control sequences. Here is where you can react on changes to size-related
297	variables.	516	variables.
298		517
299	=item on_start $term	518	=item on_child_start $term, $pid
300		519
301	Called at the very end of initialisation of a new terminal, just before	520	Called just after the child process has been C<fork>ed.
302	returning to the mainloop.	521
		522	=item on_child_exit $term, $status
		523
		524	Called just after the child process has exited. C<$status> is the status
		525	from C<waitpid>.
303		526
304	=item on_sel_make $term, $eventtime	527	=item on_sel_make $term, $eventtime
305		528
306	Called whenever a selection has been made by the user, but before the	529	Called whenever a selection has been made by the user, but before the
307	selection text is copied, so changes to the beginning, end or type of the	530	selection text is copied, so changes to the beginning, end or type of the
…		…
314		537
315	Called whenever a selection has been copied, but before the selection is	538	Called whenever a selection has been copied, but before the selection is
316	requested from the server. The selection text can be queried and changed	539	requested from the server. The selection text can be queried and changed
317	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
318		541
319	Returning a true value aborts selection grabbing. It will still be hilighted.	542	Returning a true value aborts selection grabbing. It will still be highlighted.
320		543
321	=item on_sel_extend $term	544	=item on_sel_extend $term
322		545
323	Called whenever the user tries to extend the selection (e.g. with a double	546	Called whenever the user tries to extend the selection (e.g. with a double
324	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
325	should extend the selection itelf and return true to suppress the built-in	548	should extend the selection itself and return true to suppress the built-in
326	processing. This can happen multiple times, as long as the callback	549	processing. This can happen multiple times, as long as the callback
327	returns true, it will be called on every further click by the user and is	550	returns true, it will be called on every further click by the user and is
328	supposed to enlarge the selection more and more, if possible.	551	supposed to enlarge the selection more and more, if possible.
329		552
330	See the F<selection> example extension.	553	See the F<selection> example extension.
331		554
332	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
333		556
334	Called whenever the view offset changes, i..e the user or program	557	Called whenever the view offset changes, i.e. the user or program
335	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
336	show this many lines of scrollback.	559	show this many lines of scrollback.
337		560
338	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
339		562
…		…
343		566
344	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	567	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
345	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	568	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
346	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
347		570
348	=item on_osc_seq $term, $string	571	=item on_osc_seq $term, $op, $args, $resp
		572
		573	Called on every OSC sequence and can be used to suppress it or modify its
		574	behaviour. The default should be to return an empty list. A true value
		575	suppresses execution of the request completely. Make sure you don't get
		576	confused by recursive invocations when you output an OSC sequence within
		577	this callback.
		578
		579	C<on_osc_seq_perl> should be used for new behaviour.
		580
		581	=item on_osc_seq_perl $term, $args, $resp
349		582
350	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
351	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
352	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
353	string should start with the extension name and a colon, to distinguish	586	string should start with the extension name (sans -osc) and a semicolon,
354	it from commands for other extensions, and this might be enforced in the	587	to distinguish it from commands for other extensions, and this might be
355	future.	588	enforced in the future.
		589
		590	For example, C<overlay-osc> uses this:
		591
		592	sub on_osc_seq_perl {
		593	my ($self, $osc, $resp) = @_;
		594
		595	return unless $osc =~ s/^overlay;//;
		596
		597	... process remaining $osc string
		598	}
356		599
357	Be careful not ever to trust (in a security sense) the data you receive,	600	Be careful not ever to trust (in a security sense) the data you receive,
358	as its source can not easily be controleld (e-mail content, messages from	601	as its source can not easily be controlled (e-mail content, messages from
359	other users on the same system etc.).	602	other users on the same system etc.).
		603
		604	For responses, C<$resp> contains the end-of-args separator used by the
		605	sender.
360		606
361	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
362		608
363	Called whenever text is about to be output, with the text as argument. You	609	Called whenever text is about to be output, with the text as argument. You
364	can filter/change and output the text yourself by returning a true value	610	can filter/change and output the text yourself by returning a true value
…		…
369	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
370		616
371	Called whenever some data is written to the tty/pty and can be used to	617	Called whenever some data is written to the tty/pty and can be used to
372	suppress or filter tty input.	618	suppress or filter tty input.
373		619
		620	=item on_tt_paste $term, $octets
		621
		622	Called whenever text is about to be pasted, with the text as argument. You
		623	can filter/change and paste the text yourself by returning a true value
		624	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		625	locale-encoded.
		626
374	=item on_line_update $term, $row	627	=item on_line_update $term, $row
375		628
376	Called whenever a line was updated or changed. Can be used to filter	629	Called whenever a line was updated or changed. Can be used to filter
377	screen output (e.g. underline urls or other useless stuff). Only lines	630	screen output (e.g. underline urls or other useless stuff). Only lines
378	that are being shown will be filtered, and, due to performance reasons,	631	that are being shown will be filtered, and, due to performance reasons,
…		…
385	later with the already-modified line (e.g. if unrelated parts change), so	638	later with the already-modified line (e.g. if unrelated parts change), so
386	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
387		640
388	=item on_refresh_begin $term	641	=item on_refresh_begin $term
389		642
390	Called just before the screen gets redrawn. Can be used for overlay	643	Called just before the screen gets redrawn. Can be used for overlay or
391	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
392	restoring them in refresh_end. The built-in overlay and selection display	645	restoring them in refresh_end. The built-in overlay and selection display
393	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
394		647
395	=item on_refresh_end $term	648	=item on_refresh_end $term
396		649
397	Called just after the screen gets redrawn. See C<on_refresh_begin>.	650	Called just after the screen gets redrawn. See C<on_refresh_begin>.
398		651
399	=item on_keyboard_command $term, $string	652	=item on_user_command $term, $string
400		653
401	Called whenever the user presses a key combination that has a	654	Called whenever a user-configured event is being activated (e.g. via
402	C<perl:string> action bound to it (see description of the B<keysym>	655	a C<perl:string> action bound to a key, see description of the B<keysym>
403	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
		657
		658	The event is simply the action string. This interface is assumed to change
		659	slightly in the future.
		660
		661	=item on_resize_all_windows $term, $new_width, $new_height
		662
		663	Called just after the new window size has been calculated, but before
		664	windows are actually being resized or hints are being set. If this hook
		665	returns TRUE, setting of the window hints is being skipped.
404		666
405	=item on_x_event $term, $event	667	=item on_x_event $term, $event
406		668
407	Called on every X event received on the vt window (and possibly other	669	Called on every X event received on the vt window (and possibly other
408	windows). Should only be used as a last resort. Most event structure	670	windows). Should only be used as a last resort. Most event structure
409	members are not passed.	671	members are not passed.
410		672
		673	=item on_root_event $term, $event
		674
		675	Like C<on_x_event>, but is called for events on the root window.
		676
411	=item on_focus_in $term	677	=item on_focus_in $term
412		678
413	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
414	does focus in processing.	680	does focus in processing.
415		681
416	=item on_focus_out $term	682	=item on_focus_out $term
417		683
418	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
419	focus out processing.	685	focus out processing.
420		686
		687	=item on_configure_notify $term, $event
		688
		689	=item on_property_notify $term, $event
		690
421	=item on_key_press $term, $event, $keysym, $octets	691	=item on_key_press $term, $event, $keysym, $octets
422		692
423	=item on_key_release $term, $event, $keysym	693	=item on_key_release $term, $event, $keysym
424		694
425	=item on_button_press $term, $event	695	=item on_button_press $term, $event
…		…
430		700
431	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
432		702
433	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
434		704
435	Called whenever the corresponding X event is received for the terminal If	705	Called whenever the corresponding X event is received for the terminal. If
436	the hook returns true, then the even will be ignored by rxvt-unicode.	706	the hook returns true, then the event will be ignored by rxvt-unicode.
437		707
438	The event is a hash with most values as named by Xlib (see the XEvent	708	The event is a hash with most values as named by Xlib (see the XEvent
439	manpage), with the additional members C<row> and C<col>, which are the row	709	manpage), with the additional members C<row> and C<col>, which are the
440	and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
441		711
442	C<on_key_press> additionally receives the string rxvt-unicode would	712	C<on_key_press> additionally receives the string rxvt-unicode would
443	output, if any, in locale-specific encoding.	713	output, if any, in locale-specific encoding.
444		714
445	subwindow.	715	subwindow.
		716
		717	=item on_client_message $term, $event
		718
		719	=item on_wm_protocols $term, $event
		720
		721	=item on_wm_delete_window $term, $event
		722
		723	Called when various types of ClientMessage events are received (all with
		724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		725
		726	=item on_bell $term
		727
		728	Called on receipt of a bell character.
446		729
447	=back	730	=back
448		731
449	=cut	732	=cut
450		733
…		…
456	use Scalar::Util ();	739	use Scalar::Util ();
457	use List::Util ();	740	use List::Util ();
458		741
459	our $VERSION = 1;	742	our $VERSION = 1;
460	our $TERM;	743	our $TERM;
		744	our @TERM_INIT;
		745	our @TERM_EXT;
461	our @HOOKNAME;	746	our @HOOKNAME;
462	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	747	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
463	our %OPTION;	748	our %OPTION;
464		749
465	our $LIBDIR;	750	our $LIBDIR;
466	our $RESNAME;	751	our $RESNAME;
467	our $RESCLASS;	752	our $RESCLASS;
468	our $RXVTNAME;	753	our $RXVTNAME;
469		754
		755	our $NOCHAR = chr 0xffff;
		756
470	=head2 Variables in the C<urxvt> Package	757	=head2 Variables in the C<urxvt> Package
471		758
472	=over 4	759	=over 4
473		760
474	=item $urxvt::LIBDIR	761	=item $urxvt::LIBDIR
…		…
486		773
487	=item $urxvt::TERM	774	=item $urxvt::TERM
488		775
489	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
490	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
		778
		779	=item @urxvt::TERM_INIT
		780
		781	All code references in this array will be called as methods of the next newly
		782	created C<urxvt::term> object (during the C<on_init> phase). The array
		783	gets cleared before the code references that were in it are being executed,
		784	so references can push themselves onto it again if they so desire.
		785
		786	This complements to the perl-eval command line option, but gets executed
		787	first.
		788
		789	=item @urxvt::TERM_EXT
		790
		791	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		792	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		793	but before other extensions. Gets cleared just like C<@TERM_INIT>.
491		794
492	=back	795	=back
493		796
494	=head2 Functions in the C<urxvt> Package	797	=head2 Functions in the C<urxvt> Package
495		798
…		…
509		812
510	Using this function has the advantage that its output ends up in the	813	Using this function has the advantage that its output ends up in the
511	correct place, e.g. on stderr of the connecting urxvtc client.	814	correct place, e.g. on stderr of the connecting urxvtc client.
512		815
513	Messages have a size limit of 1023 bytes currently.	816	Messages have a size limit of 1023 bytes currently.
		817
		818	=item @terms = urxvt::termlist
		819
		820	Returns all urxvt::term objects that exist in this process, regardless of
		821	whether they are started, being destroyed etc., so be careful. Only term
		822	objects that have perl extensions attached will be returned (because there
		823	is no urxvt::term objet associated with others).
514		824
515	=item $time = urxvt::NOW	825	=item $time = urxvt::NOW
516		826
517	Returns the "current time" (as per the event loop).	827	Returns the "current time" (as per the event loop).
518		828
…		…
561		871
562	=item $rend = urxvt::OVERLAY_RSTYLE	872	=item $rend = urxvt::OVERLAY_RSTYLE
563		873
564	Return the rendition mask used for overlays by default.	874	Return the rendition mask used for overlays by default.
565		875
566	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	876	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		877	urxvt::RS_RVid, urxvt::RS_Uline
567		878
568	Return the bit that enabled bold, italic, blink, reverse-video and	879	Return the bit that enabled bold, italic, blink, reverse-video and
569	underline, respectively. To enable such a style, just logically OR it into	880	underline, respectively. To enable such a style, just logically OR it into
570	the bitset.	881	the bitset.
571		882
…		…
577		888
578	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	889	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
579		890
580	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	891	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
581		892
		893	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		894
582	Replace the foreground/background colour in the rendition mask with the	895	Replace the foreground/background colour in the rendition mask with the
583	specified one.	896	specified one.
584		897
585	=item $value = urxvt::GET_CUSTOM $rend	898	=item $value = urxvt::GET_CUSTOM $rend
586		899
…		…
595	=back	908	=back
596		909
597	=cut	910	=cut
598		911
599	BEGIN {	912	BEGIN {
600	urxvt->bootstrap;
601
602	# overwrite perl's warn	913	# overwrite perl's warn
603	*CORE::GLOBAL::warn = sub {	914	*CORE::GLOBAL::warn = sub {
604	my $msg = join "", @_;	915	my $msg = join "", @_;
605	$msg .= "\n"	916	$msg .= "\n"
606	unless $msg =~ /\n$/;	917	unless $msg =~ /\n$/;
607	urxvt::warn ($msg);	918	urxvt::warn ($msg);
608	};	919	};
609
610	# %ENV is the original startup environment
611	delete $ENV{IFS};
612	delete $ENV{CDPATH};
613	delete $ENV{BASH_ENV};
614	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
615	}	920	}
		921
		922	no warnings 'utf8';
616		923
617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	924	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
618		925
619	sub verbose {	926	sub verbose {
620	my ($level, $msg) = @_;	927	my ($level, $msg) = @_;
621	warn "$msg\n" if $level <= $verbosity;	928	warn "$msg\n" if $level <= $verbosity;
622	}	929	}
623		930
624	my $extension_pkg = "extension0000";
625	my %extension_pkg;	931	my %extension_pkg;
626		932
627	# load a single script into its own package, once only	933	# load a single script into its own package, once only
628	sub extension_package($) {	934	sub extension_package($) {
629	my ($path) = @_;	935	my ($path) = @_;
630		936
631	$extension_pkg{$path} ||= do {	937	$extension_pkg{$path} ||= do {
632	my $pkg = "urxvt::" . ($extension_pkg++);	938	$path =~ /([^\/\\]+)$/;
		939	my $pkg = $1;
		940	$pkg =~ s/[^[:word:]]/_/g;
		941	$pkg = "urxvt::ext::$pkg";
633		942
634	verbose 3, "loading extension '$path' into package '$pkg'";	943	verbose 3, "loading extension '$path' into package '$pkg'";
635		944
636	open my $fh, "<:raw", $path	945	open my $fh, "<:raw", $path
637	or die "$path: $!";	946	or die "$path: $!";
638		947
639	my $source =	948	my $source =
640	"package $pkg; use strict; use utf8;\n"	949	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
641	. "use base urxvt::term::extension::;\n"
642	. "#line 1 \"$path\"\n{\n"	950	. "#line 1 \"$path\"\n{\n"
643	. (do { local $/; <$fh> })	951	. (do { local $/; <$fh> })
644	. "\n};\n1";	952	. "\n};\n1";
645		953
646	eval $source	954	eval $source
…		…
657	local $TERM = shift;	965	local $TERM = shift;
658	my $htype = shift;	966	my $htype = shift;
659		967
660	if ($htype == 0) { # INIT	968	if ($htype == 0) { # INIT
661	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	969	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
662		970
663	my %ext_arg;	971	my %ext_arg;
664		972
		973	{
		974	my @init = @TERM_INIT;
		975	@TERM_INIT = ();
		976	$_->($TERM) for @init;
		977	my @pkg = @TERM_EXT;
		978	@TERM_EXT = ();
		979	$TERM->register_package ($_) for @pkg;
		980	}
		981
665	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	982	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
666	if ($_ eq "default") {	983	if ($_ eq "default") {
667	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	984	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
668	} elsif (/^-(.*)$/) {	985	} elsif (/^-(.*)$/) {
669	delete $ext_arg{$1};	986	delete $ext_arg{$1};
670	} elsif (/^([^<]+)<(.*)>$/) {	987	} elsif (/^([^<]+)<(.*)>$/) {
671	push @{ $ext_arg{$1} }, $2;	988	push @{ $ext_arg{$1} }, $2;
672	} else {	989	} else {
673	$ext_arg{$_} ||= [];	990	$ext_arg{$_} ||= [];
674	}	991	}
675	}	992	}
676		993
677	while (my ($ext, $argv) = each %ext_arg) {	994	for my $ext (sort keys %ext_arg) {
678	my @files = grep -f $_, map "$_/$ext", @dirs;	995	my @files = grep -f $_, map "$_/$ext", @dirs;
679		996
680	if (@files) {	997	if (@files) {
681	$TERM->register_package (extension_package $files[0], $argv);	998	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
682	} else {	999	} else {
683	warn "perl extension '$ext' not found in perl library search path\n";	1000	warn "perl extension '$ext' not found in perl library search path\n";
684	}	1001	}
685	}	1002	}
686		1003
…		…
692		1009
693	if (my $cb = $TERM->{_hook}[$htype]) {	1010	if (my $cb = $TERM->{_hook}[$htype]) {
694	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1011	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
695	if $verbosity >= 10;	1012	if $verbosity >= 10;
696		1013
697	keys %$cb;	1014	for my $pkg (keys %$cb) {
698
699	while (my ($pkg, $cb) = each %$cb) {
700	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1015	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
701	and last;	1016	$retval ||= $retval_;
702		1017
703	if ($@) {	1018	if ($@) {
704	$TERM->ungrab; # better to lose the grab than the session	1019	$TERM->ungrab; # better to lose the grab than the session
705	warn $@;	1020	warn $@;
706	}	1021	}
…		…
719	}	1034	}
720		1035
721	$retval	1036	$retval
722	}	1037	}
723		1038
724	sub exec_async(@) {	1039	sub SET_COLOR($$$) {
725	my $pid = fork;	1040	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1041	}
726		1042
727	return	1043	sub rend2mask {
728	if !defined $pid or $pid;	1044	no strict 'refs';
729		1045	my ($str, $mask) = (@_, 0);
730	%ENV = %{ $TERM->env };	1046	my %color = ( fg => undef, bg => undef );
731		1047	my @failed;
732	exec @_;	1048	for my $spec ( split /\s+/, $str ) {
733	_exit 255;	1049	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1050	$color{lc($1)} = $2;
		1051	} else {
		1052	my $neg = $spec =~ s/^[-^]//;
		1053	unless ( exists &{"RS_$spec"} ) {
		1054	push @failed, $spec;
		1055	next;
		1056	}
		1057	my $cur = &{"RS_$spec"};
		1058	if ( $neg ) {
		1059	$mask &= ~$cur;
		1060	} else {
		1061	$mask |= $cur;
		1062	}
		1063	}
		1064	}
		1065	($mask, @color{qw(fg bg)}, \@failed)
734	}	1066	}
735		1067
736	# urxvt::term::extension	1068	# urxvt::term::extension
737		1069
738	package urxvt::term::extension;	1070	package urxvt::term::extension;
…		…
809	is that you cannot use blocking APIs, but the non-blocking variant should	1141	is that you cannot use blocking APIs, but the non-blocking variant should
810	work.	1142	work.
811		1143
812	=cut	1144	=cut
813		1145
814	our $VERSION = 1;	1146	our $VERSION = '5.23';
815		1147
816	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1148	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
817	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1149	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
818		1150
819	sub timer {	1151	sub timer {
…		…
821		1153
822	my $cb = $arg{cb};	1154	my $cb = $arg{cb};
823		1155
824	urxvt::timer	1156	urxvt::timer
825	->new	1157	->new
826	->start (urxvt::NOW + $arg{after})	1158	->after ($arg{after}, $arg{interval})
827	->cb (sub {	1159	->cb ($arg{interval} ? $cb : sub {
828	$_[0]->stop; # need to cancel manually	1160	$_[0]->stop; # need to cancel manually
829	$cb->();	1161	$cb->();
830	})	1162	})
831	}	1163	}
832		1164
833	sub io {	1165	sub io {
834	my ($class, %arg) = @_;	1166	my ($class, %arg) = @_;
835		1167
836	my $cb = $arg{cb};	1168	my $cb = $arg{cb};
		1169	my $fd = fileno $arg{fh};
		1170	defined $fd or $fd = $arg{fh};
837		1171
838	bless [$arg{fh}, urxvt::iow	1172	bless [$arg{fh}, urxvt::iow
839	->new	1173	->new
840	->fd (fileno $arg{fh})	1174	->fd ($fd)
841	->events (($arg{poll} =~ /r/ ? 1 : 0)	1175	->events (($arg{poll} =~ /r/ ? 1 : 0)
842	| ($arg{poll} =~ /w/ ? 2 : 0))	1176	| ($arg{poll} =~ /w/ ? 2 : 0))
843	->start	1177	->start
844	->cb (sub {	1178	->cb ($cb)
845	$cb->(($_[1] & 1 ? 'r' : '')
846	. ($_[1] & 2 ? 'w' : ''));
847	})],
848	urxvt::anyevent::	1179	], urxvt::anyevent::
		1180	}
		1181
		1182	sub idle {
		1183	my ($class, %arg) = @_;
		1184
		1185	my $cb = $arg{cb};
		1186
		1187	urxvt::iw
		1188	->new
		1189	->start
		1190	->cb ($cb)
		1191	}
		1192
		1193	sub child {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::pw
		1199	->new
		1200	->start ($arg{pid})
		1201	->cb (sub {
		1202	$_[0]->stop; # need to cancel manually
		1203	$cb->($_[0]->rpid, $_[0]->rstatus);
		1204	})
849	}	1205	}
850		1206
851	sub DESTROY {	1207	sub DESTROY {
852	$_[0][1]->stop;	1208	$_[0][1]->stop;
853	}	1209	}
854		1210
855	sub condvar {	1211	sub one_event {
856	bless \my $flag, urxvt::anyevent::condvar::
857	}
858
859	sub urxvt::anyevent::condvar::broadcast {
860	${$_[0]}++;
861	}
862
863	sub urxvt::anyevent::condvar::wait {
864	unless (${$_[0]}) {
865	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1212	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
866	}
867	}	1213	}
868		1214
869	package urxvt::term;	1215	package urxvt::term;
870		1216
871	=head2 The C<urxvt::term> Class	1217	=head2 The C<urxvt::term> Class
…		…
876		1222
877	# find on_xxx subs in the package and register them	1223	# find on_xxx subs in the package and register them
878	# as hooks	1224	# as hooks
879	sub register_package {	1225	sub register_package {
880	my ($self, $pkg, $argv) = @_;	1226	my ($self, $pkg, $argv) = @_;
		1227
		1228	no strict 'refs';
		1229
		1230	urxvt::verbose 6, "register package $pkg to $self";
		1231
		1232	@{"$pkg\::ISA"} = urxvt::term::extension::;
881		1233
882	my $proxy = bless {	1234	my $proxy = bless {
883	_pkg => $pkg,	1235	_pkg => $pkg,
884	argv => $argv,	1236	argv => $argv,
885	}, $pkg;	1237	}, $pkg;
…		…
901	hash which defines the environment of the new terminal.	1253	hash which defines the environment of the new terminal.
902		1254
903	Croaks (and probably outputs an error message) if the new instance	1255	Croaks (and probably outputs an error message) if the new instance
904	couldn't be created. Returns C<undef> if the new instance didn't	1256	couldn't be created. Returns C<undef> if the new instance didn't
905	initialise perl, and the terminal object otherwise. The C<init> and	1257	initialise perl, and the terminal object otherwise. The C<init> and
906	C<start> hooks will be called during this call.	1258	C<start> hooks will be called before this call returns, and are free to
		1259	refer to global data (which is race free).
907		1260
908	=cut	1261	=cut
909		1262
910	sub new {	1263	sub new {
911	my ($class, $env, @args) = @_;	1264	my ($class, $env, @args) = @_;
912		1265
		1266	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1267	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1268
913	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1269	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
914	}	1270	}
915		1271
916	=item $term->destroy	1272	=item $term->destroy
917		1273
918	Destroy the terminal object (close the window, free resources	1274	Destroy the terminal object (close the window, free resources
919	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1275	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
920	watchers (timers, io watchers) are still active.	1276	watchers (timers, io watchers) are still active.
921		1277
		1278	=item $term->exec_async ($cmd[, @args])
		1279
		1280	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1281	("starts") programs in the background. This function takes care of setting
		1282	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1283	be preferred over explicit calls to C<exec> or C<system>.
		1284
		1285	Returns the pid of the subprocess or C<undef> on error.
		1286
		1287	=cut
		1288
		1289	sub exec_async {
		1290	my $self = shift;
		1291
		1292	my $pid = fork;
		1293
		1294	return $pid
		1295	if !defined $pid or $pid;
		1296
		1297	%ENV = %{ $self->env };
		1298
		1299	exec @_;
		1300	urxvt::_exit 255;
		1301	}
		1302
922	=item $isset = $term->option ($optval[, $set])	1303	=item $isset = $term->option ($optval[, $set])
923		1304
924	Returns true if the option specified by C<$optval> is enabled, and	1305	Returns true if the option specified by C<$optval> is enabled, and
925	optionally change it. All option values are stored by name in the hash	1306	optionally change it. All option values are stored by name in the hash
926	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1307	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
927		1308
928	Here is a a likely non-exhaustive list of option names, please see the	1309	Here is a likely non-exhaustive list of option names, please see the
929	source file F</src/optinc.h> to see the actual list:	1310	source file F</src/optinc.h> to see the actual list:
930		1311
931	borderLess console cursorBlink cursorUnderline hold iconic insecure	1312	borderLess console cursorBlink cursorUnderline hold iconic insecure
932	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1313	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
933	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1314	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
934	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1315	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
935	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1316	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
936	tripleclickwords utmpInhibit visualBell	1317	transparent tripleclickwords utmpInhibit visualBell
937		1318
938	=item $value = $term->resource ($name[, $newval])	1319	=item $value = $term->resource ($name[, $newval])
939		1320
940	Returns the current resource value associated with a given name and	1321	Returns the current resource value associated with a given name and
941	optionally sets a new value. Setting values is most useful in the C<init>	1322	optionally sets a new value. Setting values is most useful in the C<init>
…		…
950	likely change).	1331	likely change).
951		1332
952	Please note that resource strings will currently only be freed when the	1333	Please note that resource strings will currently only be freed when the
953	terminal is destroyed, so changing options frequently will eat memory.	1334	terminal is destroyed, so changing options frequently will eat memory.
954		1335
955	Here is a a likely non-exhaustive list of resource names, not all of which	1336	Here is a likely non-exhaustive list of resource names, not all of which
956	are supported in every build, please see the source file F</src/rsinc.h>	1337	are supported in every build, please see the source file F</src/rsinc.h>
957	to see the actual list:	1338	to see the actual list:
958		1339
959	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1340	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
960	borderLess color cursorBlink cursorUnderline cutchars delete_key	1341	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
961	display_name embed ext_bwidth fade font geometry hold iconName	1342	display_name embed ext_bwidth fade font geometry hold iconName
962	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1343	imFont imLocale inputMethod insecure int_bwidth intensityStyles
963	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1344	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
964	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1345	modifier mouseWheelScrollPage name override_redirect pastableTabs path
965	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1346	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
966	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1347	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
967	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1348	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
968	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1349	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
969	shade term_name title transparent transparent_all tripleclickwords	1350	secondaryScreen secondaryScroll shade term_name title
970	utmpInhibit visualBell	1351	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1352	visualBell
971		1353
972	=cut	1354	=cut
973		1355
974	sub resource($$;$) {	1356	sub resource($$;$) {
975	my ($self, $name) = (shift, shift);	1357	my ($self, $name) = (shift, shift);
976	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1358	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
977	&urxvt::term::_resource	1359	goto &urxvt::term::_resource
978	}	1360	}
979		1361
980	=item $value = $term->x_resource ($pattern)	1362	=item $value = $term->x_resource ($pattern)
981		1363
982	Returns the X-Resource for the given pattern, excluding the program or	1364	Returns the X-Resource for the given pattern, excluding the program or
…		…
1007		1389
1008	=item ($row, $col) = $term->selection_beg ([$row, $col])	1390	=item ($row, $col) = $term->selection_beg ([$row, $col])
1009		1391
1010	=item ($row, $col) = $term->selection_end ([$row, $col])	1392	=item ($row, $col) = $term->selection_end ([$row, $col])
1011		1393
1012	Return the current values of the selection mark, begin or end positions,	1394	Return the current values of the selection mark, begin or end positions.
1013	and optionally set them to new values.	1395
		1396	When arguments are given, then the selection coordinates are set to
		1397	C<$row> and C<$col>, and the selection screen is set to the current
		1398	screen.
		1399
		1400	=item $screen = $term->selection_screen ([$screen])
		1401
		1402	Returns the current selection screen, and then optionally sets it.
1014		1403
1015	=item $term->selection_make ($eventtime[, $rectangular])	1404	=item $term->selection_make ($eventtime[, $rectangular])
1016		1405
1017	Tries to make a selection as set by C<selection_beg> and	1406	Tries to make a selection as set by C<selection_beg> and
1018	C<selection_end>. If C<$rectangular> is true (default: false), a	1407	C<selection_end>. If C<$rectangular> is true (default: false), a
1019	rectangular selection will be made. This is the prefered function to make	1408	rectangular selection will be made. This is the preferred function to make
1020	a selection.	1409	a selection.
1021		1410
1022	=item $success = $term->selection_grab ($eventtime)	1411	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1023		1412
1024	Try to request the primary selection text from the server (for example, as	1413	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1414	true) selection from the server. The corresponding text can be set
1025	set by the next method). No visual feedback will be given. This function	1415	with the next method. No visual feedback will be given. This function
1026	is mostly useful from within C<on_sel_grab> hooks.	1416	is mostly useful from within C<on_sel_grab> hooks.
1027		1417
1028	=item $oldtext = $term->selection ([$newtext])	1418	=item $oldtext = $term->selection ([$newtext, $clipboard])
1029		1419
1030	Return the current selection text and optionally replace it by C<$newtext>.	1420	Return the current selection (clipboard if C<$clipboard> is true) text
		1421	and optionally replace it by C<$newtext>.
		1422
		1423	=item $term->selection_clear ([$clipboard])
		1424
		1425	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1031		1426
1032	=item $term->overlay_simple ($x, $y, $text)	1427	=item $term->overlay_simple ($x, $y, $text)
1033		1428
1034	Create a simple multi-line overlay box. See the next method for details.	1429	Create a simple multi-line overlay box. See the next method for details.
1035		1430
…		…
1065		1460
1066	The methods currently supported on C<urxvt::overlay> objects are:	1461	The methods currently supported on C<urxvt::overlay> objects are:
1067		1462
1068	=over 4	1463	=over 4
1069		1464
1070	=item $overlay->set ($x, $y, $text, $rend)	1465	=item $overlay->set ($x, $y, $text[, $rend])
1071		1466
1072	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1467	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1073	text in rxvt-unicode's special encoding and an array of rendition values	1468	text in rxvt-unicode's special encoding and an array of rendition values
1074	at a specific position inside the overlay.	1469	at a specific position inside the overlay.
		1470
		1471	If C<$rend> is missing, then the rendition will not be changed.
1075		1472
1076	=item $overlay->hide	1473	=item $overlay->hide
1077		1474
1078	If visible, hide the overlay, but do not destroy it.	1475	If visible, hide the overlay, but do not destroy it.
1079		1476
…		…
1149		1546
1150	Normally its not a good idea to use this function, as programs might be	1547	Normally its not a good idea to use this function, as programs might be
1151	confused by changes in cursor position or scrolling. Its useful inside a	1548	confused by changes in cursor position or scrolling. Its useful inside a
1152	C<on_add_lines> hook, though.	1549	C<on_add_lines> hook, though.
1153		1550
		1551	=item $term->scr_change_screen ($screen)
		1552
		1553	Switch to given screen - 0 primary, 1 secondary.
		1554
1154	=item $term->cmd_parse ($octets)	1555	=item $term->cmd_parse ($octets)
1155		1556
1156	Similar to C<scr_add_lines>, but the argument must be in the	1557	Similar to C<scr_add_lines>, but the argument must be in the
1157	locale-specific encoding of the terminal and can contain command sequences	1558	locale-specific encoding of the terminal and can contain command sequences
1158	(escape codes) that will be interpreted.	1559	(escape codes) that will be interpreted.
1159		1560
1160	=item $term->tt_write ($octets)	1561	=item $term->tt_write ($octets)
1161		1562
1162	Write the octets given in C<$data> to the tty (i.e. as program input). To	1563	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1163	pass characters instead of octets, you should convert your strings first	1564	pass characters instead of octets, you should convert your strings first
1164	to the locale-specific encoding using C<< $term->locale_encode >>.	1565	to the locale-specific encoding using C<< $term->locale_encode >>.
		1566
		1567	=item $term->tt_paste ($octets)
		1568
		1569	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1570	CR and bracketing the data with control sequences if bracketed paste mode
		1571	is set.
1165		1572
1166	=item $old_events = $term->pty_ev_events ([$new_events])	1573	=item $old_events = $term->pty_ev_events ([$new_events])
1167		1574
1168	Replaces the event mask of the pty watcher by the given event mask. Can	1575	Replaces the event mask of the pty watcher by the given event mask. Can
1169	be used to suppress input and output handling to the pty/tty. See the	1576	be used to suppress input and output handling to the pty/tty. See the
1170	description of C<< urxvt::timer->events >>. Make sure to always restore	1577	description of C<< urxvt::timer->events >>. Make sure to always restore
1171	the previous value.	1578	the previous value.
1172		1579
		1580	=item $fd = $term->pty_fd
		1581
		1582	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1583	is used.
		1584
1173	=item $windowid = $term->parent	1585	=item $windowid = $term->parent
1174		1586
1175	Return the window id of the toplevel window.	1587	Return the window id of the toplevel window.
1176		1588
1177	=item $windowid = $term->vt	1589	=item $windowid = $term->vt
…		…
1183	Adds the specified events to the vt event mask. Useful e.g. when you want	1595	Adds the specified events to the vt event mask. Useful e.g. when you want
1184	to receive pointer events all the times:	1596	to receive pointer events all the times:
1185		1597
1186	$term->vt_emask_add (urxvt::PointerMotionMask);	1598	$term->vt_emask_add (urxvt::PointerMotionMask);
1187		1599
		1600	=item $term->focus_in
		1601
		1602	=item $term->focus_out
		1603
		1604	=item $term->key_press ($state, $keycode[, $time])
		1605
		1606	=item $term->key_release ($state, $keycode[, $time])
		1607
		1608	Deliver various fake events to to terminal.
		1609
1188	=item $window_width = $term->width	1610	=item $window_width = $term->width
1189		1611
1190	=item $window_height = $term->height	1612	=item $window_height = $term->height
1191		1613
1192	=item $font_width = $term->fwidth	1614	=item $font_width = $term->fwidth
…		…
1222	=item $env = $term->env	1644	=item $env = $term->env
1223		1645
1224	Returns a copy of the environment in effect for the terminal as a hashref	1646	Returns a copy of the environment in effect for the terminal as a hashref
1225	similar to C<\%ENV>.	1647	similar to C<\%ENV>.
1226		1648
		1649	=item @envv = $term->envv
		1650
		1651	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1652
		1653	=item @argv = $term->argv
		1654
		1655	Return the argument vector as this terminal, similar to @ARGV, but
		1656	includes the program name as first element.
		1657
1227	=cut	1658	=cut
1228		1659
1229	sub env {	1660	sub env {
1230	if (my $env = $_[0]->_env) {
1231	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1661	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1232	} else {
1233	+{ %ENV }
1234	}
1235	}	1662	}
1236		1663
1237	=item $modifiermask = $term->ModLevel3Mask	1664	=item $modifiermask = $term->ModLevel3Mask
1238		1665
1239	=item $modifiermask = $term->ModMetaMask	1666	=item $modifiermask = $term->ModMetaMask
1240		1667
1241	=item $modifiermask = $term->ModNumLockMask	1668	=item $modifiermask = $term->ModNumLockMask
1242		1669
1243	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1670	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1244	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1671	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1672
		1673	=item $screen = $term->current_screen
		1674
		1675	Returns the currently displayed screen (0 primary, 1 secondary).
		1676
		1677	=item $cursor_is_hidden = $term->hidden_cursor
		1678
		1679	Returns whether the cursor is currently hidden or not.
1245		1680
1246	=item $view_start = $term->view_start ([$newvalue])	1681	=item $view_start = $term->view_start ([$newvalue])
1247		1682
1248	Returns the row number of the topmost displayed line. Maximum value is	1683	Returns the row number of the topmost displayed line. Maximum value is
1249	C<0>, which displays the normal terminal contents. Lower values scroll	1684	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1257		1692
1258	Used after changing terminal contents to display them.	1693	Used after changing terminal contents to display them.
1259		1694
1260	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1695	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1261		1696
1262	Returns the text of the entire row with number C<$row_number>. Row C<0>	1697	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1263	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1698	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1264	terminal line. The scrollback buffer starts at line C<-1> and extends to
1265	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1699	terminal line. Nothing will be returned if a nonexistent line
1266	is requested.	1700	is requested.
1267		1701
1268	If C<$new_text> is specified, it will replace characters in the current	1702	If C<$new_text> is specified, it will replace characters in the current
1269	line, starting at column C<$start_col> (default C<0>), which is useful	1703	line, starting at column C<$start_col> (default C<0>), which is useful
1270	to replace only parts of a line. The font index in the rendition will	1704	to replace only parts of a line. The font index in the rendition will
1271	automatically be updated.	1705	automatically be updated.
1272		1706
1273	C<$text> is in a special encoding: tabs and wide characters that use more	1707	C<$text> is in a special encoding: tabs and wide characters that use more
1274	than one cell when displayed are padded with urxvt::NOCHAR characters	1708	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1275	(C<chr 65535>). Characters with combining characters and other characters	1709	characters. Characters with combining characters and other characters that
1276	that do not fit into the normal tetx encoding will be replaced with	1710	do not fit into the normal text encoding will be replaced with characters
1277	characters in the private use area.	1711	in the private use area.
1278		1712
1279	You have to obey this encoding when changing text. The advantage is	1713	You have to obey this encoding when changing text. The advantage is
1280	that C<substr> and similar functions work on screen cells and not on	1714	that C<substr> and similar functions work on screen cells and not on
1281	characters.	1715	characters.
1282		1716
…		…
1426	where one character corresponds to one screen cell. See	1860	where one character corresponds to one screen cell. See
1427	C<< $term->ROW_t >> for details.	1861	C<< $term->ROW_t >> for details.
1428		1862
1429	=item $string = $term->special_decode $text	1863	=item $string = $term->special_decode $text
1430		1864
1431	Converts rxvt-unicodes text reprsentation into a perl string. See	1865	Converts rxvt-unicodes text representation into a perl string. See
1432	C<< $term->ROW_t >> for details.	1866	C<< $term->ROW_t >> for details.
1433		1867
1434	=item $success = $term->grab_button ($button, $modifiermask)	1868	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1435		1869
		1870	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1871
1436	Registers a synchronous button grab. See the XGrabButton manpage.	1872	Register/unregister a synchronous button grab. See the XGrabButton
		1873	manpage.
1437		1874
1438	=item $success = $term->grab ($eventtime[, $sync])	1875	=item $success = $term->grab ($eventtime[, $sync])
1439		1876
1440	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1877	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1441	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1878	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1442		1879
1443	=item $term->allow_events_async	1880	=item $term->allow_events_async
1444		1881
1445	Calls XAllowEvents with AsyncBoth for the most recent grab.	1882	Calls XAllowEvents with AsyncBoth for the most recent grab.
1446		1883
…		…
1453	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1890	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1454	recent grab.	1891	recent grab.
1455		1892
1456	=item $term->ungrab	1893	=item $term->ungrab
1457		1894
1458	Calls XUngrab for the most recent grab. Is called automatically on	1895	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1459	evaluation errors, as it is better to lose the grab in the error case as	1896	evaluation errors, as it is better to lose the grab in the error case as
1460	the session.	1897	the session.
		1898
		1899	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1900
		1901	=item $atom_name = $term->XGetAtomName ($atom)
		1902
		1903	=item @atoms = $term->XListProperties ($window)
		1904
		1905	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1906
		1907	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1908
		1909	=item $term->XDeleteProperty ($window, $property)
		1910
		1911	=item $window = $term->DefaultRootWindow
		1912
		1913	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1914
		1915	=item $term->XMapWindow ($window)
		1916
		1917	=item $term->XUnmapWindow ($window)
		1918
		1919	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1920
		1921	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1922
		1923	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1924
		1925	Various X or X-related functions. The C<$term> object only serves as
		1926	the source of the display, otherwise those functions map more-or-less
		1927	directly onto the X functions of the same name.
1461		1928
1462	=back	1929	=back
1463		1930
1464	=cut	1931	=cut
1465		1932
…		…
1529	my ($self, $text, $cb) = @_;	1996	my ($self, $text, $cb) = @_;
1530		1997
1531	$self->add_item ({ type => "button", text => $text, activate => $cb});	1998	$self->add_item ({ type => "button", text => $text, activate => $cb});
1532	}	1999	}
1533		2000
1534	=item $popup->add_toggle ($text, $cb, $initial_value)	2001	=item $popup->add_toggle ($text, $initial_value, $cb)
1535		2002
1536	Adds a toggle/checkbox item to the popup. Teh callback gets called	2003	Adds a toggle/checkbox item to the popup. The callback gets called
1537	whenever it gets toggled, with a boolean indicating its value as its first	2004	whenever it gets toggled, with a boolean indicating its new value as its
1538	argument.	2005	first argument.
1539		2006
1540	=cut	2007	=cut
1541		2008
1542	sub add_toggle {	2009	sub add_toggle {
1543	my ($self, $text, $cb, $value) = @_;	2010	my ($self, $text, $value, $cb) = @_;
1544		2011
1545	my $item; $item = {	2012	my $item; $item = {
1546	type => "button",	2013	type => "button",
1547	text => " $text",	2014	text => " $text",
1548	value => $value,	2015	value => $value,
…		…
1567	my $env = $self->{term}->env;	2034	my $env = $self->{term}->env;
1568	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2035	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1569	delete $env->{LC_ALL};	2036	delete $env->{LC_ALL};
1570	$env->{LC_CTYPE} = $self->{term}->locale;	2037	$env->{LC_CTYPE} = $self->{term}->locale;
1571		2038
1572	urxvt::term->new ($env, $self->{term}->resource ("name"),	2039	my $term = urxvt::term->new (
1573	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2040	$env, "popup",
		2041	"--perl-lib" => "", "--perl-ext-common" => "",
		2042	"-pty-fd" => -1, "-sl" => 0,
		2043	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1574	"--transient-for" => $self->{term}->parent,	2044	"--transient-for" => $self->{term}->parent,
1575	"-display" => $self->{term}->display_id,	2045	"-display" => $self->{term}->display_id,
1576	"-pe" => "urxvt-popup")	2046	"-pe" => "urxvt-popup",
1577	or die "unable to create popup window\n";	2047	) or die "unable to create popup window\n";
		2048
		2049	unless (delete $term->{urxvt_popup_init_done}) {
		2050	$term->ungrab;
		2051	$term->destroy;
		2052	die "unable to initialise popup window\n";
		2053	}
1578	}	2054	}
1579		2055
1580	sub DESTROY {	2056	sub DESTROY {
1581	my ($self) = @_;	2057	my ($self) = @_;
1582		2058
1583	delete $self->{term}{_destroy}{$self};	2059	delete $self->{term}{_destroy}{$self};
1584	$self->{term}->ungrab;	2060	$self->{term}->ungrab;
1585	}	2061	}
1586		2062
1587	=back	2063	=back
		2064
		2065	=cut
		2066
		2067	package urxvt::watcher;
1588		2068
1589	=head2 The C<urxvt::timer> Class	2069	=head2 The C<urxvt::timer> Class
1590		2070
1591	This class implements timer watchers/events. Time is represented as a	2071	This class implements timer watchers/events. Time is represented as a
1592	fractional number of seconds since the epoch. Example:	2072	fractional number of seconds since the epoch. Example:
…		…
1596	->new	2076	->new
1597	->interval (1)	2077	->interval (1)
1598	->cb (sub {	2078	->cb (sub {
1599	$term->{overlay}->set (0, 0,	2079	$term->{overlay}->set (0, 0,
1600	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2080	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1601	});	2081	});
1602		2082
1603	=over 4	2083	=over 4
1604		2084
1605	=item $timer = new urxvt::timer	2085	=item $timer = new urxvt::timer
1606		2086
…		…
1609		2089
1610	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2090	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1611		2091
1612	Set the callback to be called when the timer triggers.	2092	Set the callback to be called when the timer triggers.
1613		2093
1614	=item $tstamp = $timer->at
1615
1616	Return the time this watcher will fire next.
1617
1618	=item $timer = $timer->set ($tstamp)	2094	=item $timer = $timer->set ($tstamp[, $interval])
1619		2095
1620	Set the time the event is generated to $tstamp.	2096	Set the time the event is generated to $tstamp (and optionally specifies a
		2097	new $interval).
1621		2098
1622	=item $timer = $timer->interval ($interval)	2099	=item $timer = $timer->interval ($interval)
1623		2100
1624	Normally (and when C<$interval> is C<0>), the timer will automatically	2101	By default (and when C<$interval> is C<0>), the timer will automatically
1625	stop after it has fired once. If C<$interval> is non-zero, then the timer	2102	stop after it has fired once. If C<$interval> is non-zero, then the timer
1626	is automatically rescheduled at the given intervals.	2103	is automatically rescheduled at the given intervals.
1627		2104
1628	=item $timer = $timer->start	2105	=item $timer = $timer->start
1629		2106
1630	Start the timer.	2107	Start the timer.
1631		2108
1632	=item $timer = $timer->start ($tstamp)	2109	=item $timer = $timer->start ($tstamp[, $interval])
1633		2110
1634	Set the event trigger time to C<$tstamp> and start the timer.	2111	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2112	also replaces the interval.
		2113
		2114	=item $timer = $timer->after ($delay[, $interval])
		2115
		2116	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1635		2117
1636	=item $timer = $timer->stop	2118	=item $timer = $timer->stop
1637		2119
1638	Stop the timer.	2120	Stop the timer.
1639		2121
…		…
1645		2127
1646	$term->{socket} = ...	2128	$term->{socket} = ...
1647	$term->{iow} = urxvt::iow	2129	$term->{iow} = urxvt::iow
1648	->new	2130	->new
1649	->fd (fileno $term->{socket})	2131	->fd (fileno $term->{socket})
1650	->events (urxvt::EVENT_READ)	2132	->events (urxvt::EV_READ)
1651	->start	2133	->start
1652	->cb (sub {	2134	->cb (sub {
1653	my ($iow, $revents) = @_;	2135	my ($iow, $revents) = @_;
1654	# $revents must be 1 here, no need to check	2136	# $revents must be 1 here, no need to check
1655	sysread $term->{socket}, my $buf, 8192	2137	sysread $term->{socket}, my $buf, 8192
…		…
1668	Set the callback to be called when io events are triggered. C<$reventmask>	2150	Set the callback to be called when io events are triggered. C<$reventmask>
1669	is a bitset as described in the C<events> method.	2151	is a bitset as described in the C<events> method.
1670		2152
1671	=item $iow = $iow->fd ($fd)	2153	=item $iow = $iow->fd ($fd)
1672		2154
1673	Set the filedescriptor (not handle) to watch.	2155	Set the file descriptor (not handle) to watch.
1674		2156
1675	=item $iow = $iow->events ($eventmask)	2157	=item $iow = $iow->events ($eventmask)
1676		2158
1677	Set the event mask to watch. The only allowed values are	2159	Set the event mask to watch. The only allowed values are
1678	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2160	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1679	together, or C<urxvt::EVENT_NONE>.	2161	together, or C<urxvt::EV_NONE>.
1680		2162
1681	=item $iow = $iow->start	2163	=item $iow = $iow->start
1682		2164
1683	Start watching for requested events on the given handle.	2165	Start watching for requested events on the given handle.
1684		2166
1685	=item $iow = $iow->stop	2167	=item $iow = $iow->stop
1686		2168
1687	Stop watching for events on the given filehandle.	2169	Stop watching for events on the given file handle.
		2170
		2171	=back
		2172
		2173	=head2 The C<urxvt::iw> Class
		2174
		2175	This class implements idle watchers, that get called automatically when
		2176	the process is idle. They should return as fast as possible, after doing
		2177	some useful work.
		2178
		2179	=over 4
		2180
		2181	=item $iw = new urxvt::iw
		2182
		2183	Create a new idle watcher object in stopped state.
		2184
		2185	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2186
		2187	Set the callback to be called when the watcher triggers.
		2188
		2189	=item $timer = $timer->start
		2190
		2191	Start the watcher.
		2192
		2193	=item $timer = $timer->stop
		2194
		2195	Stop the watcher.
		2196
		2197	=back
		2198
		2199	=head2 The C<urxvt::pw> Class
		2200
		2201	This class implements process watchers. They create an event whenever a
		2202	process exits, after which they stop automatically.
		2203
		2204	my $pid = fork;
		2205	...
		2206	$term->{pw} = urxvt::pw
		2207	->new
		2208	->start ($pid)
		2209	->cb (sub {
		2210	my ($pw, $exit_status) = @_;
		2211	...
		2212	});
		2213
		2214	=over 4
		2215
		2216	=item $pw = new urxvt::pw
		2217
		2218	Create a new process watcher in stopped state.
		2219
		2220	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2221
		2222	Set the callback to be called when the timer triggers.
		2223
		2224	=item $pw = $timer->start ($pid)
		2225
		2226	Tells the watcher to start watching for process C<$pid>.
		2227
		2228	=item $pw = $pw->stop
		2229
		2230	Stop the watcher.
1688		2231
1689	=back	2232	=back
1690		2233
1691	=head1 ENVIRONMENT	2234	=head1 ENVIRONMENT
1692		2235
…		…
1701		2244
1702	=item >= 3 - script loading and management	2245	=item >= 3 - script loading and management
1703		2246
1704	=item >=10 - all called hooks	2247	=item >=10 - all called hooks
1705		2248
1706	=item >=11 - hook reutrn values	2249	=item >=11 - hook return values
1707		2250
1708	=back	2251	=back
1709		2252
1710	=head1 AUTHOR	2253	=head1 AUTHOR
1711		2254
…		…
1713	http://software.schmorp.de/pkg/rxvt-unicode	2256	http://software.schmorp.de/pkg/rxvt-unicode
1714		2257
1715	=cut	2258	=cut
1716		2259
1717	1	2260	1
		2261
		2262	# vim: sw=3:

Diff Legend

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