[ViewVC] Diff of: 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.172 by root, Fri Oct 10 00:21:15 2008 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).
150		307
151	=item block-graphics-to-ascii	308	=item block-graphics-to-ascii
152		309
153	A not very useful example of filtering all text output to the terminal,	310	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	311	by replacing all line-drawing characters (U+2500 .. U+259F) by a
155	similar-looking ascii character.	312	similar-looking ascii character.
156		313
157	=item digital-clock	314	=item digital-clock
158		315
159	Displays a digital clock using the built-in overlay.	316	Displays a digital clock using the built-in overlay.
160		317
161	=item example-refresh-hooks	318	=item remote-clipboard
162		319
163	Displays a very simple digital clock in the upper right corner of the	320	Somewhat of a misnomer, this extension adds two menu entries to the
164	window. Illustrates overwriting the refresh callbacks to create your own	321	selection popup that allows one to run external commands to store the
165	overlays or changes.	322	selection somewhere and fetch it again.
		323
		324	We use it to implement a "distributed selection mechanism", which just
		325	means that one command uploads the file to a remote server, and another
		326	reads it.
		327
		328	The commands can be set using the C<URxvt.remote-selection.store> and
		329	C<URxvt.remote-selection.fetch> resources. The first should read the
		330	selection to store from STDIN (always in UTF-8), the second should provide
		331	the selection data on STDOUT (also in UTF-8).
		332
		333	The defaults (which are likely useless to you) use rsh and cat:
		334
		335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
166		337
167	=item selection-pastebin	338	=item selection-pastebin
168		339
169	This is a little rarely useful extension that Uploads the selection as	340	This is a little rarely useful extension that Uploads the selection as
170	textfile to a remote site (or does other things). (The implementation is	341	textfile to a remote site (or does other things). (The implementation is
…		…
190	After a successful upload the selection will be replaced by the text given	361	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	362	in the C<selection-pastebin-url> resource (again, the % is the placeholder
192	for the filename):	363	for the filename):
193		364
194	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		366
		367	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		368	the double C</> characters as comment start. Use C<\057\057> instead,
		369	which works regardless of wether xrdb is used to parse the resource file
		370	or not.
		371
		372	=item example-refresh-hooks
		373
		374	Displays a very simple digital clock in the upper right corner of the
		375	window. Illustrates overwriting the refresh callbacks to create your own
		376	overlays or changes.
195		377
196	=back	378	=back
197		379
198	=head1 API DOCUMENTATION	380	=head1 API DOCUMENTATION
199		381
…		…
233		415
234	=back	416	=back
235		417
236	=head2 Extension Objects	418	=head2 Extension Objects
237		419
238	Very perl extension is a perl class. A separate perl object is created	420	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	421	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	422	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	423	their C<$self> object without having to think about clashes with other
		424	extensions or other terminals, with the exception of methods and members
242	begin with an underscore character C<_>: these are reserved for internal	425	that begin with an underscore character C<_>: these are reserved for
243	use.	426	internal use.
244		427
245	Although it isn't a C<urxvt::term> object, you can call all methods of the	428	Although it isn't a C<urxvt::term> object, you can call all methods of the
246	C<urxvt::term> class on this object.	429	C<urxvt::term> class on this object.
247		430
248	It has the following methods and data members:	431	It has the following methods and data members:
…		…
269	=head2 Hooks	452	=head2 Hooks
270		453
271	The following subroutines can be declared in extension files, and will be	454	The following subroutines can be declared in extension files, and will be
272	called whenever the relevant event happens.	455	called whenever the relevant event happens.
273		456
274	The first argument passed to them is an extension oject as described in	457	The first argument passed to them is an extension object as described in
275	the in the C<Extension Objects> section.	458	the in the C<Extension Objects> section.
276		459
277	B<All> of these hooks must return a boolean value. If it is true, then the	460	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	461	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.	462	relevant action might not be carried out by the C++ code.
280		463
281	I<< When in doubt, return a false value (preferably C<()>). >>	464	I<< When in doubt, return a false value (preferably C<()>). >>
282		465
283	=over 4	466	=over 4
284		467
285	=item on_init $term	468	=item on_init $term
286		469
287	Called after a new terminal object has been initialized, but before	470	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	471	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	472	call or deliver senseless data, as terminal size and other characteristics
290	have not yet been determined. You can safely query and change resources,	473	have not yet been determined. You can safely query and change resources
291	though.	474	and options, though. For many purposes the C<on_start> hook is a better
		475	place.
		476
		477	=item on_start $term
		478
		479	Called at the very end of initialisation of a new terminal, just before
		480	trying to map (display) the toplevel and returning to the main loop.
		481
		482	=item on_destroy $term
		483
		484	Called whenever something tries to destroy terminal, when the terminal is
		485	still fully functional (not for long, though).
292		486
293	=item on_reset $term	487	=item on_reset $term
294		488
295	Called after the screen is "reset" for any reason, such as resizing or	489	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	490	control sequences. Here is where you can react on changes to size-related
297	variables.	491	variables.
298		492
299	=item on_start $term	493	=item on_child_start $term, $pid
300		494
301	Called at the very end of initialisation of a new terminal, just before	495	Called just after the child process has been C<fork>ed.
302	returning to the mainloop.	496
		497	=item on_child_exit $term, $status
		498
		499	Called just after the child process has exited. C<$status> is the status
		500	from C<waitpid>.
303		501
304	=item on_sel_make $term, $eventtime	502	=item on_sel_make $term, $eventtime
305		503
306	Called whenever a selection has been made by the user, but before the	504	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	505	selection text is copied, so changes to the beginning, end or type of the
…		…
314		512
315	Called whenever a selection has been copied, but before the selection is	513	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	514	requested from the server. The selection text can be queried and changed
317	by calling C<< $term->selection >>.	515	by calling C<< $term->selection >>.
318		516
319	Returning a true value aborts selection grabbing. It will still be hilighted.	517	Returning a true value aborts selection grabbing. It will still be highlighted.
320		518
321	=item on_sel_extend $term	519	=item on_sel_extend $term
322		520
323	Called whenever the user tries to extend the selection (e.g. with a double	521	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	522	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	523	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	524	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	525	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.	526	supposed to enlarge the selection more and more, if possible.
329		527
330	See the F<selection> example extension.	528	See the F<selection> example extension.
331		529
332	=item on_view_change $term, $offset	530	=item on_view_change $term, $offset
333		531
334	Called whenever the view offset changes, i..e the user or program	532	Called whenever the view offset changes, i.e. the user or program
335	scrolls. Offset C<0> means display the normal terminal, positive values	533	scrolls. Offset C<0> means display the normal terminal, positive values
336	show this many lines of scrollback.	534	show this many lines of scrollback.
337		535
338	=item on_scroll_back $term, $lines, $saved	536	=item on_scroll_back $term, $lines, $saved
339		537
…		…
343		541
344	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	542	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	543	$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.	544	number of lines that will be in the scrollback buffer.
347		545
348	=item on_osc_seq $term, $string	546	=item on_osc_seq $term, $op, $args, $resp
		547
		548	Called on every OSC sequence and can be used to suppress it or modify its
		549	behaviour. The default should be to return an empty list. A true value
		550	suppresses execution of the request completely. Make sure you don't get
		551	confused by recursive invocations when you output an OSC sequence within
		552	this callback.
		553
		554	C<on_osc_seq_perl> should be used for new behaviour.
		555
		556	=item on_osc_seq_perl $term, $args, $resp
349		557
350	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
351	operating system command) is processed. Cursor position and other state	559	operating system command) is processed. Cursor position and other state
352	information is up-to-date when this happens. For interoperability, the	560	information is up-to-date when this happens. For interoperability, the
353	string should start with the extension name and a colon, to distinguish	561	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	562	to distinguish it from commands for other extensions, and this might be
355	future.	563	enforced in the future.
		564
		565	For example, C<overlay-osc> uses this:
		566
		567	sub on_osc_seq_perl {
		568	my ($self, $osc, $resp) = @_;
		569
		570	return unless $osc =~ s/^overlay;//;
		571
		572	... process remaining $osc string
		573	}
356		574
357	Be careful not ever to trust (in a security sense) the data you receive,	575	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	576	as its source can not easily be controlled (e-mail content, messages from
359	other users on the same system etc.).	577	other users on the same system etc.).
		578
		579	For responses, C<$resp> contains the end-of-args separator used by the
		580	sender.
360		581
361	=item on_add_lines $term, $string	582	=item on_add_lines $term, $string
362		583
363	Called whenever text is about to be output, with the text as argument. You	584	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	585	can filter/change and output the text yourself by returning a true value
…		…
385	later with the already-modified line (e.g. if unrelated parts change), so	606	later with the already-modified line (e.g. if unrelated parts change), so
386	you cannot just toggle rendition bits, but only set them.	607	you cannot just toggle rendition bits, but only set them.
387		608
388	=item on_refresh_begin $term	609	=item on_refresh_begin $term
389		610
390	Called just before the screen gets redrawn. Can be used for overlay	611	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	612	similar effects by modifying the terminal contents in refresh_begin, and
392	restoring them in refresh_end. The built-in overlay and selection display	613	restoring them in refresh_end. The built-in overlay and selection display
393	code is run after this hook, and takes precedence.	614	code is run after this hook, and takes precedence.
394		615
395	=item on_refresh_end $term	616	=item on_refresh_end $term
396		617
397	Called just after the screen gets redrawn. See C<on_refresh_begin>.	618	Called just after the screen gets redrawn. See C<on_refresh_begin>.
398		619
399	=item on_keyboard_command $term, $string	620	=item on_user_command $term, $string
400		621
401	Called whenever the user presses a key combination that has a	622	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>	623	a C<perl:string> action bound to a key, see description of the B<keysym>
403	resource in the @@RXVT_NAME@@(1) manpage).	624	resource in the @@RXVT_NAME@@(1) manpage).
		625
		626	The event is simply the action string. This interface is assumed to change
		627	slightly in the future.
		628
		629	=item on_resize_all_windows $tern, $new_width, $new_height
		630
		631	Called just after the new window size has been calculated, but before
		632	windows are actually being resized or hints are being set. If this hook
		633	returns TRUE, setting of the window hints is being skipped.
404		634
405	=item on_x_event $term, $event	635	=item on_x_event $term, $event
406		636
407	Called on every X event received on the vt window (and possibly other	637	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	638	windows). Should only be used as a last resort. Most event structure
409	members are not passed.	639	members are not passed.
410		640
		641	=item on_root_event $term, $event
		642
		643	Like C<on_x_event>, but is called for events on the root window.
		644
411	=item on_focus_in $term	645	=item on_focus_in $term
412		646
413	Called whenever the window gets the keyboard focus, before rxvt-unicode	647	Called whenever the window gets the keyboard focus, before rxvt-unicode
414	does focus in processing.	648	does focus in processing.
415		649
416	=item on_focus_out $term	650	=item on_focus_out $term
417		651
418	Called wheneever the window loses keyboard focus, before rxvt-unicode does	652	Called whenever the window loses keyboard focus, before rxvt-unicode does
419	focus out processing.	653	focus out processing.
		654
		655	=item on_configure_notify $term, $event
		656
		657	=item on_property_notify $term, $event
420		658
421	=item on_key_press $term, $event, $keysym, $octets	659	=item on_key_press $term, $event, $keysym, $octets
422		660
423	=item on_key_release $term, $event, $keysym	661	=item on_key_release $term, $event, $keysym
424		662
…		…
434		672
435	Called whenever the corresponding X event is received for the terminal If	673	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.	674	the hook returns true, then the even will be ignored by rxvt-unicode.
437		675
438	The event is a hash with most values as named by Xlib (see the XEvent	676	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	677	manpage), with the additional members C<row> and C<col>, which are the
440	and column under the mouse cursor.	678	(real, not screen-based) row and column under the mouse cursor.
441		679
442	C<on_key_press> additionally receives the string rxvt-unicode would	680	C<on_key_press> additionally receives the string rxvt-unicode would
443	output, if any, in locale-specific encoding.	681	output, if any, in locale-specific encoding.
444		682
445	subwindow.	683	subwindow.
		684
		685	=item on_client_message $term, $event
		686
		687	=item on_wm_protocols $term, $event
		688
		689	=item on_wm_delete_window $term, $event
		690
		691	Called when various types of ClientMessage events are received (all with
		692	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
446		693
447	=back	694	=back
448		695
449	=cut	696	=cut
450		697
…		…
456	use Scalar::Util ();	703	use Scalar::Util ();
457	use List::Util ();	704	use List::Util ();
458		705
459	our $VERSION = 1;	706	our $VERSION = 1;
460	our $TERM;	707	our $TERM;
		708	our @TERM_INIT;
		709	our @TERM_EXT;
461	our @HOOKNAME;	710	our @HOOKNAME;
462	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	711	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
463	our %OPTION;	712	our %OPTION;
464		713
465	our $LIBDIR;	714	our $LIBDIR;
466	our $RESNAME;	715	our $RESNAME;
467	our $RESCLASS;	716	our $RESCLASS;
468	our $RXVTNAME;	717	our $RXVTNAME;
469		718
		719	our $NOCHAR = chr 0xffff;
		720
470	=head2 Variables in the C<urxvt> Package	721	=head2 Variables in the C<urxvt> Package
471		722
472	=over 4	723	=over 4
473		724
474	=item $urxvt::LIBDIR	725	=item $urxvt::LIBDIR
…		…
486		737
487	=item $urxvt::TERM	738	=item $urxvt::TERM
488		739
489	The current terminal. This variable stores the current C<urxvt::term>	740	The current terminal. This variable stores the current C<urxvt::term>
490	object, whenever a callback/hook is executing.	741	object, whenever a callback/hook is executing.
		742
		743	=item @urxvt::TERM_INIT
		744
		745	All code references in this array will be called as methods of the next newly
		746	created C<urxvt::term> object (during the C<on_init> phase). The array
		747	gets cleared before the code references that were in it are being executed,
		748	so references can push themselves onto it again if they so desire.
		749
		750	This complements to the perl-eval command line option, but gets executed
		751	first.
		752
		753	=item @urxvt::TERM_EXT
		754
		755	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		756	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		757	but before other extensions. Gets cleared just like C<@TERM_INIT>.
491		758
492	=back	759	=back
493		760
494	=head2 Functions in the C<urxvt> Package	761	=head2 Functions in the C<urxvt> Package
495		762
…		…
509		776
510	Using this function has the advantage that its output ends up in the	777	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.	778	correct place, e.g. on stderr of the connecting urxvtc client.
512		779
513	Messages have a size limit of 1023 bytes currently.	780	Messages have a size limit of 1023 bytes currently.
		781
		782	=item @terms = urxvt::termlist
		783
		784	Returns all urxvt::term objects that exist in this process, regardless of
		785	whether they are started, being destroyed etc., so be careful. Only term
		786	objects that have perl extensions attached will be returned (because there
		787	is no urxvt::term objet associated with others).
514		788
515	=item $time = urxvt::NOW	789	=item $time = urxvt::NOW
516		790
517	Returns the "current time" (as per the event loop).	791	Returns the "current time" (as per the event loop).
518		792
…		…
577		851
578	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	852	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
579		853
580	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	854	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
581		855
		856	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		857
582	Replace the foreground/background colour in the rendition mask with the	858	Replace the foreground/background colour in the rendition mask with the
583	specified one.	859	specified one.
584		860
585	=item $value = urxvt::GET_CUSTOM $rend	861	=item $value = urxvt::GET_CUSTOM $rend
586		862
…		…
595	=back	871	=back
596		872
597	=cut	873	=cut
598		874
599	BEGIN {	875	BEGIN {
600	urxvt->bootstrap;
601
602	# overwrite perl's warn	876	# overwrite perl's warn
603	*CORE::GLOBAL::warn = sub {	877	*CORE::GLOBAL::warn = sub {
604	my $msg = join "", @_;	878	my $msg = join "", @_;
605	$msg .= "\n"	879	$msg .= "\n"
606	unless $msg =~ /\n$/;	880	unless $msg =~ /\n$/;
607	urxvt::warn ($msg);	881	urxvt::warn ($msg);
608	};	882	};
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	}	883	}
		884
		885	no warnings 'utf8';
616		886
617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	887	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
618		888
619	sub verbose {	889	sub verbose {
620	my ($level, $msg) = @_;	890	my ($level, $msg) = @_;
621	warn "$msg\n" if $level <= $verbosity;	891	warn "$msg\n" if $level <= $verbosity;
622	}	892	}
623		893
624	my $extension_pkg = "extension0000";
625	my %extension_pkg;	894	my %extension_pkg;
626		895
627	# load a single script into its own package, once only	896	# load a single script into its own package, once only
628	sub extension_package($) {	897	sub extension_package($) {
629	my ($path) = @_;	898	my ($path) = @_;
630		899
631	$extension_pkg{$path} \|\|= do {	900	$extension_pkg{$path} \|\|= do {
632	my $pkg = "urxvt::" . ($extension_pkg++);	901	$path =~ /([^\/\\]+)$/;
		902	my $pkg = $1;
		903	$pkg =~ s/[^[:word:]]/_/g;
		904	$pkg = "urxvt::ext::$pkg";
633		905
634	verbose 3, "loading extension '$path' into package '$pkg'";	906	verbose 3, "loading extension '$path' into package '$pkg'";
635		907
636	open my $fh, "<:raw", $path	908	open my $fh, "<:raw", $path
637	or die "$path: $!";	909	or die "$path: $!";
638		910
639	my $source =	911	my $source =
640	"package $pkg; use strict; use utf8;\n"	912	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
641	. "use base urxvt::term::extension::;\n"
642	. "#line 1 \"$path\"\n{\n"	913	. "#line 1 \"$path\"\n{\n"
643	. (do { local $/; <$fh> })	914	. (do { local $/; <$fh> })
644	. "\n};\n1";	915	. "\n};\n1";
645		916
646	eval $source	917	eval $source
…		…
657	local $TERM = shift;	928	local $TERM = shift;
658	my $htype = shift;	929	my $htype = shift;
659		930
660	if ($htype == 0) { # INIT	931	if ($htype == 0) { # INIT
661	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
662		933
663	my %ext_arg;	934	my %ext_arg;
664		935
		936	{
		937	my @init = @TERM_INIT;
		938	@TERM_INIT = ();
		939	$_->($TERM) for @init;
		940	my @pkg = @TERM_EXT;
		941	@TERM_EXT = ();
		942	$TERM->register_package ($_) for @pkg;
		943	}
		944
665	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	945	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
666	if ($_ eq "default") {	946	if ($_ eq "default") {
667	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	947	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
668	} elsif (/^-(.*)$/) {	948	} elsif (/^-(.*)$/) {
669	delete $ext_arg{$1};	949	delete $ext_arg{$1};
670	} elsif (/^([^<]+)<(.*)>$/) {	950	} elsif (/^([^<]+)<(.*)>$/) {
671	push @{ $ext_arg{$1} }, $2;	951	push @{ $ext_arg{$1} }, $2;
672	} else {	952	} else {
673	$ext_arg{$_} \|\|= [];	953	$ext_arg{$_} \|\|= [];
674	}	954	}
675	}	955	}
676		956
677	while (my ($ext, $argv) = each %ext_arg) {	957	for my $ext (sort keys %ext_arg) {
678	my @files = grep -f $_, map "$_/$ext", @dirs;	958	my @files = grep -f $_, map "$_/$ext", @dirs;
679		959
680	if (@files) {	960	if (@files) {
681	$TERM->register_package (extension_package $files[0], $argv);	961	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
682	} else {	962	} else {
683	warn "perl extension '$ext' not found in perl library search path\n";	963	warn "perl extension '$ext' not found in perl library search path\n";
684	}	964	}
685	}	965	}
686		966
…		…
692		972
693	if (my $cb = $TERM->{_hook}[$htype]) {	973	if (my $cb = $TERM->{_hook}[$htype]) {
694	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	974	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
695	if $verbosity >= 10;	975	if $verbosity >= 10;
696		976
697	keys %$cb;	977	for my $pkg (keys %$cb) {
698
699	while (my ($pkg, $cb) = each %$cb) {
700	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	978	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
701	and last;	979	$retval \|\|= $retval_;
702		980
703	if ($@) {	981	if ($@) {
704	$TERM->ungrab; # better to lose the grab than the session	982	$TERM->ungrab; # better to lose the grab than the session
705	warn $@;	983	warn $@;
706	}	984	}
…		…
719	}	997	}
720		998
721	$retval	999	$retval
722	}	1000	}
723		1001
724	sub exec_async(@) {	1002	sub SET_COLOR($$$) {
725	my $pid = fork;	1003	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1004	}
726		1005
727	return	1006	sub rend2mask {
728	if !defined $pid or $pid;	1007	no strict 'refs';
729		1008	my ($str, $mask) = (@_, 0);
730	%ENV = %{ $TERM->env };	1009	my %color = ( fg => undef, bg => undef );
731		1010	my @failed;
732	exec @_;	1011	for my $spec ( split /\s+/, $str ) {
733	_exit 255;	1012	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1013	$color{lc($1)} = $2;
		1014	} else {
		1015	my $neg = $spec =~ s/^[-^]//;
		1016	unless ( exists &{"RS_$spec"} ) {
		1017	push @failed, $spec;
		1018	next;
		1019	}
		1020	my $cur = &{"RS_$spec"};
		1021	if ( $neg ) {
		1022	$mask &= ~$cur;
		1023	} else {
		1024	$mask \|= $cur;
		1025	}
		1026	}
		1027	}
		1028	($mask, @color{qw(fg bg)}, \@failed)
734	}	1029	}
735		1030
736	# urxvt::term::extension	1031	# urxvt::term::extension
737		1032
738	package urxvt::term::extension;	1033	package urxvt::term::extension;
…		…
809	is that you cannot use blocking APIs, but the non-blocking variant should	1104	is that you cannot use blocking APIs, but the non-blocking variant should
810	work.	1105	work.
811		1106
812	=cut	1107	=cut
813		1108
814	our $VERSION = 1;	1109	our $VERSION = '3.4';
815		1110
816	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
817	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
818		1113
819	sub timer {	1114	sub timer {
…		…
850		1145
851	sub DESTROY {	1146	sub DESTROY {
852	$_[0][1]->stop;	1147	$_[0][1]->stop;
853	}	1148	}
854		1149
855	sub condvar {	1150	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";	1151	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
866	}
867	}	1152	}
868		1153
869	package urxvt::term;	1154	package urxvt::term;
870		1155
871	=head2 The C<urxvt::term> Class	1156	=head2 The C<urxvt::term> Class
…		…
876		1161
877	# find on_xxx subs in the package and register them	1162	# find on_xxx subs in the package and register them
878	# as hooks	1163	# as hooks
879	sub register_package {	1164	sub register_package {
880	my ($self, $pkg, $argv) = @_;	1165	my ($self, $pkg, $argv) = @_;
		1166
		1167	no strict 'refs';
		1168
		1169	urxvt::verbose 6, "register package $pkg to $self";
		1170
		1171	@{"$pkg\::ISA"} = urxvt::term::extension::;
881		1172
882	my $proxy = bless {	1173	my $proxy = bless {
883	_pkg => $pkg,	1174	_pkg => $pkg,
884	argv => $argv,	1175	argv => $argv,
885	}, $pkg;	1176	}, $pkg;
…		…
901	hash which defines the environment of the new terminal.	1192	hash which defines the environment of the new terminal.
902		1193
903	Croaks (and probably outputs an error message) if the new instance	1194	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	1195	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	1196	initialise perl, and the terminal object otherwise. The C<init> and
906	C<start> hooks will be called during this call.	1197	C<start> hooks will be called before this call returns, and are free to
		1198	refer to global data (which is race free).
907		1199
908	=cut	1200	=cut
909		1201
910	sub new {	1202	sub new {
911	my ($class, $env, @args) = @_;	1203	my ($class, $env, @args) = @_;
912		1204
		1205	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1206	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1207
913	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1208	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
914	}	1209	}
915		1210
916	=item $term->destroy	1211	=item $term->destroy
917		1212
918	Destroy the terminal object (close the window, free resources	1213	Destroy the terminal object (close the window, free resources
919	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1214	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
920	watchers (timers, io watchers) are still active.	1215	watchers (timers, io watchers) are still active.
921		1216
		1217	=item $term->exec_async ($cmd[, @args])
		1218
		1219	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1220	("starts") programs in the background. This function takes care of setting
		1221	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1222	be preferred over explicit calls to C<exec> or C<system>.
		1223
		1224	Returns the pid of the subprocess or C<undef> on error.
		1225
		1226	=cut
		1227
		1228	sub exec_async {
		1229	my $self = shift;
		1230
		1231	my $pid = fork;
		1232
		1233	return $pid
		1234	if !defined $pid or $pid;
		1235
		1236	%ENV = %{ $self->env };
		1237
		1238	exec @_;
		1239	urxvt::_exit 255;
		1240	}
		1241
922	=item $isset = $term->option ($optval[, $set])	1242	=item $isset = $term->option ($optval[, $set])
923		1243
924	Returns true if the option specified by C<$optval> is enabled, and	1244	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	1245	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.	1246	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
927		1247
928	Here is a a likely non-exhaustive list of option names, please see the	1248	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:	1249	source file F</src/optinc.h> to see the actual list:
930		1250
931	borderLess console cursorBlink cursorUnderline hold iconic insecure	1251	borderLess console cursorBlink cursorUnderline hold iconic insecure
932	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1252	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
933	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1253	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
934	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1254	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
935	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1255	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
936	tripleclickwords utmpInhibit visualBell	1256	transparent tripleclickwords utmpInhibit visualBell
937		1257
938	=item $value = $term->resource ($name[, $newval])	1258	=item $value = $term->resource ($name[, $newval])
939		1259
940	Returns the current resource value associated with a given name and	1260	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>	1261	optionally sets a new value. Setting values is most useful in the C<init>
…		…
950	likely change).	1270	likely change).
951		1271
952	Please note that resource strings will currently only be freed when the	1272	Please note that resource strings will currently only be freed when the
953	terminal is destroyed, so changing options frequently will eat memory.	1273	terminal is destroyed, so changing options frequently will eat memory.
954		1274
955	Here is a a likely non-exhaustive list of resource names, not all of which	1275	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>	1276	are supported in every build, please see the source file F</src/rsinc.h>
957	to see the actual list:	1277	to see the actual list:
958		1278
959	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1279	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
960	borderLess color cursorBlink cursorUnderline cutchars delete_key	1280	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
961	display_name embed ext_bwidth fade font geometry hold iconName	1281	display_name embed ext_bwidth fade font geometry hold iconName
962	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1282	imFont imLocale inputMethod insecure int_bwidth intensityStyles
963	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1283	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
964	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1284	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
965	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1285	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
966	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1286	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
967	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1287	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
968	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1288	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
969	shade term_name title transparent transparent_all tripleclickwords	1289	secondaryScreen secondaryScroll shade term_name title
970	utmpInhibit visualBell	1290	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1291	visualBell
971		1292
972	=cut	1293	=cut
973		1294
974	sub resource($$;$) {	1295	sub resource($$;$) {
975	my ($self, $name) = (shift, shift);	1296	my ($self, $name) = (shift, shift);
976	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1297	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
977	&urxvt::term::_resource	1298	goto &urxvt::term::_resource
978	}	1299	}
979		1300
980	=item $value = $term->x_resource ($pattern)	1301	=item $value = $term->x_resource ($pattern)
981		1302
982	Returns the X-Resource for the given pattern, excluding the program or	1303	Returns the X-Resource for the given pattern, excluding the program or
…		…
1065		1386
1066	The methods currently supported on C<urxvt::overlay> objects are:	1387	The methods currently supported on C<urxvt::overlay> objects are:
1067		1388
1068	=over 4	1389	=over 4
1069		1390
1070	=item $overlay->set ($x, $y, $text, $rend)	1391	=item $overlay->set ($x, $y, $text[, $rend])
1071		1392
1072	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1393	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	1394	text in rxvt-unicode's special encoding and an array of rendition values
1074	at a specific position inside the overlay.	1395	at a specific position inside the overlay.
		1396
		1397	If C<$rend> is missing, then the rendition will not be changed.
1075		1398
1076	=item $overlay->hide	1399	=item $overlay->hide
1077		1400
1078	If visible, hide the overlay, but do not destroy it.	1401	If visible, hide the overlay, but do not destroy it.
1079		1402
…		…
1149		1472
1150	Normally its not a good idea to use this function, as programs might be	1473	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	1474	confused by changes in cursor position or scrolling. Its useful inside a
1152	C<on_add_lines> hook, though.	1475	C<on_add_lines> hook, though.
1153		1476
		1477	=item $term->scr_change_screen ($screen)
		1478
		1479	Switch to given screen - 0 primary, 1 secondary.
		1480
1154	=item $term->cmd_parse ($octets)	1481	=item $term->cmd_parse ($octets)
1155		1482
1156	Similar to C<scr_add_lines>, but the argument must be in the	1483	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	1484	locale-specific encoding of the terminal and can contain command sequences
1158	(escape codes) that will be interpreted.	1485	(escape codes) that will be interpreted.
…		…
1168	Replaces the event mask of the pty watcher by the given event mask. Can	1495	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	1496	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	1497	description of C<< urxvt::timer->events >>. Make sure to always restore
1171	the previous value.	1498	the previous value.
1172		1499
		1500	=item $fd = $term->pty_fd
		1501
		1502	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1503	is used.
		1504
1173	=item $windowid = $term->parent	1505	=item $windowid = $term->parent
1174		1506
1175	Return the window id of the toplevel window.	1507	Return the window id of the toplevel window.
1176		1508
1177	=item $windowid = $term->vt	1509	=item $windowid = $term->vt
…		…
1183	Adds the specified events to the vt event mask. Useful e.g. when you want	1515	Adds the specified events to the vt event mask. Useful e.g. when you want
1184	to receive pointer events all the times:	1516	to receive pointer events all the times:
1185		1517
1186	$term->vt_emask_add (urxvt::PointerMotionMask);	1518	$term->vt_emask_add (urxvt::PointerMotionMask);
1187		1519
		1520	=item $term->focus_in
		1521
		1522	=item $term->focus_out
		1523
		1524	=item $term->key_press ($state, $keycode[, $time])
		1525
		1526	=item $term->key_release ($state, $keycode[, $time])
		1527
		1528	Deliver various fake events to to terminal.
		1529
1188	=item $window_width = $term->width	1530	=item $window_width = $term->width
1189		1531
1190	=item $window_height = $term->height	1532	=item $window_height = $term->height
1191		1533
1192	=item $font_width = $term->fwidth	1534	=item $font_width = $term->fwidth
…		…
1222	=item $env = $term->env	1564	=item $env = $term->env
1223		1565
1224	Returns a copy of the environment in effect for the terminal as a hashref	1566	Returns a copy of the environment in effect for the terminal as a hashref
1225	similar to C<\%ENV>.	1567	similar to C<\%ENV>.
1226		1568
		1569	=item @envv = $term->envv
		1570
		1571	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1572
		1573	=item @argv = $term->argv
		1574
		1575	Return the argument vector as this terminal, similar to @ARGV, but
		1576	includes the program name as first element.
		1577
1227	=cut	1578	=cut
1228		1579
1229	sub env {	1580	sub env {
1230	if (my $env = $_[0]->_env) {
1231	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1581	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1232	} else {
1233	+{ %ENV }
1234	}
1235	}	1582	}
1236		1583
1237	=item $modifiermask = $term->ModLevel3Mask	1584	=item $modifiermask = $term->ModLevel3Mask
1238		1585
1239	=item $modifiermask = $term->ModMetaMask	1586	=item $modifiermask = $term->ModMetaMask
1240		1587
1241	=item $modifiermask = $term->ModNumLockMask	1588	=item $modifiermask = $term->ModNumLockMask
1242		1589
1243	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1590	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.	1591	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1592
		1593	=item $screen = $term->current_screen
		1594
		1595	Returns the currently displayed screen (0 primary, 1 secondary).
		1596
		1597	=item $cursor_is_hidden = $term->hidden_cursor
		1598
		1599	Returns whether the cursor is currently hidden or not.
1245		1600
1246	=item $view_start = $term->view_start ([$newvalue])	1601	=item $view_start = $term->view_start ([$newvalue])
1247		1602
1248	Returns the row number of the topmost displayed line. Maximum value is	1603	Returns the row number of the topmost displayed line. Maximum value is
1249	C<0>, which displays the normal terminal contents. Lower values scroll	1604	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1257		1612
1258	Used after changing terminal contents to display them.	1613	Used after changing terminal contents to display them.
1259		1614
1260	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1615	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1261		1616
1262	Returns the text of the entire row with number C<$row_number>. Row C<0>	1617	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	1618	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	1619	terminal line. Nothing will be returned if a nonexistent line
1266	is requested.	1620	is requested.
1267		1621
1268	If C<$new_text> is specified, it will replace characters in the current	1622	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	1623	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	1624	to replace only parts of a line. The font index in the rendition will
1271	automatically be updated.	1625	automatically be updated.
1272		1626
1273	C<$text> is in a special encoding: tabs and wide characters that use more	1627	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	1628	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1275	(C<chr 65535>). Characters with combining characters and other characters	1629	characters. Characters with combining characters and other characters that
1276	that do not fit into the normal tetx encoding will be replaced with	1630	do not fit into the normal text encoding will be replaced with characters
1277	characters in the private use area.	1631	in the private use area.
1278		1632
1279	You have to obey this encoding when changing text. The advantage is	1633	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	1634	that C<substr> and similar functions work on screen cells and not on
1281	characters.	1635	characters.
1282		1636
…		…
1426	where one character corresponds to one screen cell. See	1780	where one character corresponds to one screen cell. See
1427	C<< $term->ROW_t >> for details.	1781	C<< $term->ROW_t >> for details.
1428		1782
1429	=item $string = $term->special_decode $text	1783	=item $string = $term->special_decode $text
1430		1784
1431	Converts rxvt-unicodes text reprsentation into a perl string. See	1785	Converts rxvt-unicodes text representation into a perl string. See
1432	C<< $term->ROW_t >> for details.	1786	C<< $term->ROW_t >> for details.
1433		1787
1434	=item $success = $term->grab_button ($button, $modifiermask)	1788	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1435		1789
		1790	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1791
1436	Registers a synchronous button grab. See the XGrabButton manpage.	1792	Register/unregister a synchronous button grab. See the XGrabButton
		1793	manpage.
1437		1794
1438	=item $success = $term->grab ($eventtime[, $sync])	1795	=item $success = $term->grab ($eventtime[, $sync])
1439		1796
1440	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1797	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1441	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1798	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1442		1799
1443	=item $term->allow_events_async	1800	=item $term->allow_events_async
1444		1801
1445	Calls XAllowEvents with AsyncBoth for the most recent grab.	1802	Calls XAllowEvents with AsyncBoth for the most recent grab.
1446		1803
…		…
1456	=item $term->ungrab	1813	=item $term->ungrab
1457		1814
1458	Calls XUngrab for the most recent grab. Is called automatically on	1815	Calls XUngrab 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	1816	evaluation errors, as it is better to lose the grab in the error case as
1460	the session.	1817	the session.
		1818
		1819	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1820
		1821	=item $atom_name = $term->XGetAtomName ($atom)
		1822
		1823	=item @atoms = $term->XListProperties ($window)
		1824
		1825	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1826
		1827	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1828
		1829	=item $term->XDeleteProperty ($window, $property)
		1830
		1831	=item $window = $term->DefaultRootWindow
		1832
		1833	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1834
		1835	=item $term->XMapWindow ($window)
		1836
		1837	=item $term->XUnmapWindow ($window)
		1838
		1839	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1840
		1841	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1842
		1843	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1844
		1845	Various X or X-related functions. The C<$term> object only serves as
		1846	the source of the display, otherwise those functions map more-or-less
		1847	directory onto the X functions of the same name.
1461		1848
1462	=back	1849	=back
1463		1850
1464	=cut	1851	=cut
1465		1852
…		…
1529	my ($self, $text, $cb) = @_;	1916	my ($self, $text, $cb) = @_;
1530		1917
1531	$self->add_item ({ type => "button", text => $text, activate => $cb});	1918	$self->add_item ({ type => "button", text => $text, activate => $cb});
1532	}	1919	}
1533		1920
1534	=item $popup->add_toggle ($text, $cb, $initial_value)	1921	=item $popup->add_toggle ($text, $initial_value, $cb)
1535		1922
1536	Adds a toggle/checkbox item to the popup. Teh callback gets called	1923	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	1924	whenever it gets toggled, with a boolean indicating its new value as its
1538	argument.	1925	first argument.
1539		1926
1540	=cut	1927	=cut
1541		1928
1542	sub add_toggle {	1929	sub add_toggle {
1543	my ($self, $text, $cb, $value) = @_;	1930	my ($self, $text, $value, $cb) = @_;
1544		1931
1545	my $item; $item = {	1932	my $item; $item = {
1546	type => "button",	1933	type => "button",
1547	text => " $text",	1934	text => " $text",
1548	value => $value,	1935	value => $value,
…		…
1567	my $env = $self->{term}->env;	1954	my $env = $self->{term}->env;
1568	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1955	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1569	delete $env->{LC_ALL};	1956	delete $env->{LC_ALL};
1570	$env->{LC_CTYPE} = $self->{term}->locale;	1957	$env->{LC_CTYPE} = $self->{term}->locale;
1571		1958
1572	urxvt::term->new ($env, $self->{term}->resource ("name"),	1959	my $term = urxvt::term->new (
1573	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1960	$env, "popup",
		1961	"--perl-lib" => "", "--perl-ext-common" => "",
		1962	"-pty-fd" => -1, "-sl" => 0,
		1963	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1574	"--transient-for" => $self->{term}->parent,	1964	"--transient-for" => $self->{term}->parent,
1575	"-display" => $self->{term}->display_id,	1965	"-display" => $self->{term}->display_id,
1576	"-pe" => "urxvt-popup")	1966	"-pe" => "urxvt-popup",
1577	or die "unable to create popup window\n";	1967	) or die "unable to create popup window\n";
		1968
		1969	unless (delete $term->{urxvt_popup_init_done}) {
		1970	$term->ungrab;
		1971	$term->destroy;
		1972	die "unable to initialise popup window\n";
		1973	}
1578	}	1974	}
1579		1975
1580	sub DESTROY {	1976	sub DESTROY {
1581	my ($self) = @_;	1977	my ($self) = @_;
1582		1978
1583	delete $self->{term}{_destroy}{$self};	1979	delete $self->{term}{_destroy}{$self};
1584	$self->{term}->ungrab;	1980	$self->{term}->ungrab;
1585	}	1981	}
1586		1982
1587	=back	1983	=back
		1984
		1985	=cut
		1986
		1987	package urxvt::watcher;
1588		1988
1589	=head2 The C<urxvt::timer> Class	1989	=head2 The C<urxvt::timer> Class
1590		1990
1591	This class implements timer watchers/events. Time is represented as a	1991	This class implements timer watchers/events. Time is represented as a
1592	fractional number of seconds since the epoch. Example:	1992	fractional number of seconds since the epoch. Example:
…		…
1596	->new	1996	->new
1597	->interval (1)	1997	->interval (1)
1598	->cb (sub {	1998	->cb (sub {
1599	$term->{overlay}->set (0, 0,	1999	$term->{overlay}->set (0, 0,
1600	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2000	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1601	});	2001	});
1602		2002
1603	=over 4	2003	=over 4
1604		2004
1605	=item $timer = new urxvt::timer	2005	=item $timer = new urxvt::timer
1606		2006
…		…
1630	Start the timer.	2030	Start the timer.
1631		2031
1632	=item $timer = $timer->start ($tstamp)	2032	=item $timer = $timer->start ($tstamp)
1633		2033
1634	Set the event trigger time to C<$tstamp> and start the timer.	2034	Set the event trigger time to C<$tstamp> and start the timer.
		2035
		2036	=item $timer = $timer->after ($delay)
		2037
		2038	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1635		2039
1636	=item $timer = $timer->stop	2040	=item $timer = $timer->stop
1637		2041
1638	Stop the timer.	2042	Stop the timer.
1639		2043
…		…
1645		2049
1646	$term->{socket} = ...	2050	$term->{socket} = ...
1647	$term->{iow} = urxvt::iow	2051	$term->{iow} = urxvt::iow
1648	->new	2052	->new
1649	->fd (fileno $term->{socket})	2053	->fd (fileno $term->{socket})
1650	->events (urxvt::EVENT_READ)	2054	->events (urxvt::EV_READ)
1651	->start	2055	->start
1652	->cb (sub {	2056	->cb (sub {
1653	my ($iow, $revents) = @_;	2057	my ($iow, $revents) = @_;
1654	# $revents must be 1 here, no need to check	2058	# $revents must be 1 here, no need to check
1655	sysread $term->{socket}, my $buf, 8192	2059	sysread $term->{socket}, my $buf, 8192
…		…
1668	Set the callback to be called when io events are triggered. C<$reventmask>	2072	Set the callback to be called when io events are triggered. C<$reventmask>
1669	is a bitset as described in the C<events> method.	2073	is a bitset as described in the C<events> method.
1670		2074
1671	=item $iow = $iow->fd ($fd)	2075	=item $iow = $iow->fd ($fd)
1672		2076
1673	Set the filedescriptor (not handle) to watch.	2077	Set the file descriptor (not handle) to watch.
1674		2078
1675	=item $iow = $iow->events ($eventmask)	2079	=item $iow = $iow->events ($eventmask)
1676		2080
1677	Set the event mask to watch. The only allowed values are	2081	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	2082	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1679	together, or C<urxvt::EVENT_NONE>.	2083	together, or C<urxvt::EV_NONE>.
1680		2084
1681	=item $iow = $iow->start	2085	=item $iow = $iow->start
1682		2086
1683	Start watching for requested events on the given handle.	2087	Start watching for requested events on the given handle.
1684		2088
1685	=item $iow = $iow->stop	2089	=item $iow = $iow->stop
1686		2090
1687	Stop watching for events on the given filehandle.	2091	Stop watching for events on the given file handle.
		2092
		2093	=back
		2094
		2095	=head2 The C<urxvt::iw> Class
		2096
		2097	This class implements idle watchers, that get called automatically when
		2098	the process is idle. They should return as fast as possible, after doing
		2099	some useful work.
		2100
		2101	=over 4
		2102
		2103	=item $iw = new urxvt::iw
		2104
		2105	Create a new idle watcher object in stopped state.
		2106
		2107	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2108
		2109	Set the callback to be called when the watcher triggers.
		2110
		2111	=item $timer = $timer->start
		2112
		2113	Start the watcher.
		2114
		2115	=item $timer = $timer->stop
		2116
		2117	Stop the watcher.
		2118
		2119	=back
		2120
		2121	=head2 The C<urxvt::pw> Class
		2122
		2123	This class implements process watchers. They create an event whenever a
		2124	process exits, after which they stop automatically.
		2125
		2126	my $pid = fork;
		2127	...
		2128	$term->{pw} = urxvt::pw
		2129	->new
		2130	->start ($pid)
		2131	->cb (sub {
		2132	my ($pw, $exit_status) = @_;
		2133	...
		2134	});
		2135
		2136	=over 4
		2137
		2138	=item $pw = new urxvt::pw
		2139
		2140	Create a new process watcher in stopped state.
		2141
		2142	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2143
		2144	Set the callback to be called when the timer triggers.
		2145
		2146	=item $pw = $timer->start ($pid)
		2147
		2148	Tells the watcher to start watching for process C<$pid>.
		2149
		2150	=item $pw = $pw->stop
		2151
		2152	Stop the watcher.
1688		2153
1689	=back	2154	=back
1690		2155
1691	=head1 ENVIRONMENT	2156	=head1 ENVIRONMENT
1692		2157
…		…
1701		2166
1702	=item >= 3 - script loading and management	2167	=item >= 3 - script loading and management
1703		2168
1704	=item >=10 - all called hooks	2169	=item >=10 - all called hooks
1705		2170
1706	=item >=11 - hook reutrn values	2171	=item >=11 - hook return values
1707		2172
1708	=back	2173	=back
1709		2174
1710	=head1 AUTHOR	2175	=head1 AUTHOR
1711		2176
…		…
1713	http://software.schmorp.de/pkg/rxvt-unicode	2178	http://software.schmorp.de/pkg/rxvt-unicode
1714		2179
1715	=cut	2180	=cut
1716		2181
1717	1	2182	1
		2183
		2184	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.99 by root, Tue Jan 17 17:09:26 2006 UTC vs. Revision 1.172 by root, Fri Oct 10 00:21:15 2008 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.99 by root, Tue Jan 17 17:09:26 2006 UTC vs.
Revision 1.172 by root, Fri Oct 10 00:21:15 2008 UTC