[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.100 by root, Wed Jan 18 08:33:34 2006 UTC vs. Revision 1.173 by root, Wed Nov 5 12:45:36 2008 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.100 by root, Wed Jan 18 08:33:34 2006 UTC vs.
Revision 1.173 by root, Wed Nov 5 12:45:36 2008 UTC