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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.104 by root, Wed Jan 18 17:49:47 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.
93		124
94	Other extensions can extend this popup menu by pushing a code reference onto	125	Other extensions can extend this popup menu by pushing a code reference
95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
96		128
97	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
98	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
99	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
100	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
101	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
102		134
103	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
104	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	137	C<a>s:
106		138
107	push urxvt::ext::selection_popup::hook, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
109	: ()	141	: ()
110	};	142	};
111		143
112	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
113		145
…		…
120	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
121	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
122	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
123	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
124	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
125	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
126		189
127	=item selection-autotransform	190	=item selection-autotransform
128		191
129	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
130	whenever a selection is made.	193	whenever a selection is made.
…		…
143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144		207
145	And this example matches the same,but replaces it with vi-commands you can	208	And this example matches the same,but replaces it with vi-commands you can
146	paste directly into your (vi :) editor:	209	paste directly into your (vi :) editor:
147		210
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149		212
150	Of course, this can be modified to suit your needs and your editor :)	213	Of course, this can be modified to suit your needs and your editor :)
151		214
152	To expand the example above to typical perl error messages ("XXX at	215	To expand the example above to typical perl error messages ("XXX at
153	FILENAME line YYY."), you need a slightly more elaborate solution:	216	FILENAME line YYY."), you need a slightly more elaborate solution:
154		217
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157		220
158	The first line tells the selection code to treat the unchanging part of	221	The first line tells the selection code to treat the unchanging part of
159	every error message as a selection pattern, and the second line transforms	222	every error message as a selection pattern, and the second line transforms
160	the message into vi commands to load the file.	223	the message into vi commands to load the file.
161		224
162	=item mark-urls	225	=item tabbed
163		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
164	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
165	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
166	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
167	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
168		258
169	=item automove-background	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.
170		263
171	This is basically a one-line extension that dynamically changes the background pixmap offset	264	It is possible to activate the most recently seen match from the keyboard.
172	to the window position, in effect creating the same effect as pseudo transparency with	265	Simply bind a keysym to "perl:matcher" as seen in the example below.
173	a custom pixmap. No scaling is supported in this mode. Exmaple:
174		266
175	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	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.
176		313
177	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
178		315
179	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
180	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
181	similar-looking ascii character.	318	similar-looking ascii character.
182		319
183	=item digital-clock	320	=item digital-clock
184		321
185	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
186		323
187	=item example-refresh-hooks	324	=item remote-clipboard
188		325
189	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
190	window. Illustrates overwriting the refresh callbacks to create your own	327	selection popup that allows one to run external commands to store the
191	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'
192		343
193	=item selection-pastebin	344	=item selection-pastebin
194		345
195	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
196	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
…		…
216	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
217	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
218	for the filename):	369	for the filename):
219		370
220	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.
221		383
222	=back	384	=back
223		385
224	=head1 API DOCUMENTATION	386	=head1 API DOCUMENTATION
225		387
…		…
259		421
260	=back	422	=back
261		423
262	=head2 Extension Objects	424	=head2 Extension Objects
263		425
264	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
265	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,
266	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
267	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
268	begin with an underscore character C<_>: these are reserved for internal	431	that begin with an underscore character C<_>: these are reserved for
269	use.	432	internal use.
270		433
271	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
272	C<urxvt::term> class on this object.	435	C<urxvt::term> class on this object.
273		436
274	It has the following methods and data members:	437	It has the following methods and data members:
…		…
295	=head2 Hooks	458	=head2 Hooks
296		459
297	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
298	called whenever the relevant event happens.	461	called whenever the relevant event happens.
299		462
300	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
301	the in the C<Extension Objects> section.	464	the in the C<Extension Objects> section.
302		465
303	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
304	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
305	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.
306		469
307	I<< When in doubt, return a false value (preferably C<()>). >>	470	I<< When in doubt, return a false value (preferably C<()>). >>
308		471
309	=over 4	472	=over 4
310		473
311	=item on_init $term	474	=item on_init $term
312		475
313	Called after a new terminal object has been initialized, but before	476	Called after a new terminal object has been initialized, but before
314	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
315	call or deliver senseless data, as terminal size and other characteristics	478	call or deliver senseless data, as terminal size and other characteristics
316	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
317	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).
318		492
319	=item on_reset $term	493	=item on_reset $term
320		494
321	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
322	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
323	variables.	497	variables.
324		498
325	=item on_start $term	499	=item on_child_start $term, $pid
326		500
327	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.
328	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>.
329		507
330	=item on_sel_make $term, $eventtime	508	=item on_sel_make $term, $eventtime
331		509
332	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
333	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
…		…
340		518
341	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
342	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
343	by calling C<< $term->selection >>.	521	by calling C<< $term->selection >>.
344		522
345	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.
346		524
347	=item on_sel_extend $term	525	=item on_sel_extend $term
348		526
349	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
350	click) and is either supposed to return false (normal operation), or	528	click) and is either supposed to return false (normal operation), or
351	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
352	processing. This can happen multiple times, as long as the callback	530	processing. This can happen multiple times, as long as the callback
353	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
354	supposed to enlarge the selection more and more, if possible.	532	supposed to enlarge the selection more and more, if possible.
355		533
356	See the F<selection> example extension.	534	See the F<selection> example extension.
357		535
358	=item on_view_change $term, $offset	536	=item on_view_change $term, $offset
359		537
360	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
361	scrolls. Offset C<0> means display the normal terminal, positive values	539	scrolls. Offset C<0> means display the normal terminal, positive values
362	show this many lines of scrollback.	540	show this many lines of scrollback.
363		541
364	=item on_scroll_back $term, $lines, $saved	542	=item on_scroll_back $term, $lines, $saved
365		543
…		…
369		547
370	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,
371	$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
372	number of lines that will be in the scrollback buffer.	550	number of lines that will be in the scrollback buffer.
373		551
374	=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
375		563
376	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	564	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
377	operating system command) is processed. Cursor position and other state	565	operating system command) is processed. Cursor position and other state
378	information is up-to-date when this happens. For interoperability, the	566	information is up-to-date when this happens. For interoperability, the
379	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,
380	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
381	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	}
382		580
383	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,
384	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
385	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.
386		587
387	=item on_add_lines $term, $string	588	=item on_add_lines $term, $string
388		589
389	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
390	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
…		…
411	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
412	you cannot just toggle rendition bits, but only set them.	613	you cannot just toggle rendition bits, but only set them.
413		614
414	=item on_refresh_begin $term	615	=item on_refresh_begin $term
415		616
416	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
417	or similar effects by modify terminal contents in refresh_begin, and	618	similar effects by modifying the terminal contents in refresh_begin, and
418	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
419	code is run after this hook, and takes precedence.	620	code is run after this hook, and takes precedence.
420		621
421	=item on_refresh_end $term	622	=item on_refresh_end $term
422		623
423	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>.
424		625
425	=item on_keyboard_command $term, $string	626	=item on_user_command $term, $string
426		627
427	Called whenever the user presses a key combination that has a	628	Called whenever a user-configured event is being activated (e.g. via
428	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>
429	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.
430		640
431	=item on_x_event $term, $event	641	=item on_x_event $term, $event
432		642
433	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
434	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
435	members are not passed.	645	members are not passed.
436		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
437	=item on_focus_in $term	651	=item on_focus_in $term
438		652
439	Called whenever the window gets the keyboard focus, before rxvt-unicode	653	Called whenever the window gets the keyboard focus, before rxvt-unicode
440	does focus in processing.	654	does focus in processing.
441		655
442	=item on_focus_out $term	656	=item on_focus_out $term
443		657
444	Called wheneever the window loses keyboard focus, before rxvt-unicode does	658	Called whenever the window loses keyboard focus, before rxvt-unicode does
445	focus out processing.	659	focus out processing.
446		660
447	=item on_configure_notify $term, $event	661	=item on_configure_notify $term, $event
		662
		663	=item on_property_notify $term, $event
448		664
449	=item on_key_press $term, $event, $keysym, $octets	665	=item on_key_press $term, $event, $keysym, $octets
450		666
451	=item on_key_release $term, $event, $keysym	667	=item on_key_release $term, $event, $keysym
452		668
…		…
462		678
463	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
464	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.
465		681
466	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
467	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
468	and column under the mouse cursor.	684	(real, not screen-based) row and column under the mouse cursor.
469		685
470	C<on_key_press> additionally receives the string rxvt-unicode would	686	C<on_key_press> additionally receives the string rxvt-unicode would
471	output, if any, in locale-specific encoding.	687	output, if any, in locale-specific encoding.
472		688
473	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).
474		699
475	=back	700	=back
476		701
477	=cut	702	=cut
478		703
…		…
484	use Scalar::Util ();	709	use Scalar::Util ();
485	use List::Util ();	710	use List::Util ();
486		711
487	our $VERSION = 1;	712	our $VERSION = 1;
488	our $TERM;	713	our $TERM;
		714	our @TERM_INIT;
		715	our @TERM_EXT;
489	our @HOOKNAME;	716	our @HOOKNAME;
490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	717	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491	our %OPTION;	718	our %OPTION;
492		719
493	our $LIBDIR;	720	our $LIBDIR;
494	our $RESNAME;	721	our $RESNAME;
495	our $RESCLASS;	722	our $RESCLASS;
496	our $RXVTNAME;	723	our $RXVTNAME;
497		724
		725	our $NOCHAR = chr 0xffff;
		726
498	=head2 Variables in the C<urxvt> Package	727	=head2 Variables in the C<urxvt> Package
499		728
500	=over 4	729	=over 4
501		730
502	=item $urxvt::LIBDIR	731	=item $urxvt::LIBDIR
…		…
514		743
515	=item $urxvt::TERM	744	=item $urxvt::TERM
516		745
517	The current terminal. This variable stores the current C<urxvt::term>	746	The current terminal. This variable stores the current C<urxvt::term>
518	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>.
519		764
520	=back	765	=back
521		766
522	=head2 Functions in the C<urxvt> Package	767	=head2 Functions in the C<urxvt> Package
523		768
…		…
537		782
538	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
539	correct place, e.g. on stderr of the connecting urxvtc client.	784	correct place, e.g. on stderr of the connecting urxvtc client.
540		785
541	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).
542		794
543	=item $time = urxvt::NOW	795	=item $time = urxvt::NOW
544		796
545	Returns the "current time" (as per the event loop).	797	Returns the "current time" (as per the event loop).
546		798
…		…
604	Return the foreground/background colour index, respectively.	856	Return the foreground/background colour index, respectively.
605		857
606	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	858	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
607		859
608	=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
609		863
610	Replace the foreground/background colour in the rendition mask with the	864	Replace the foreground/background colour in the rendition mask with the
611	specified one.	865	specified one.
612		866
613	=item $value = urxvt::GET_CUSTOM $rend	867	=item $value = urxvt::GET_CUSTOM $rend
…		…
630	my $msg = join "", @_;	884	my $msg = join "", @_;
631	$msg .= "\n"	885	$msg .= "\n"
632	unless $msg =~ /\n$/;	886	unless $msg =~ /\n$/;
633	urxvt::warn ($msg);	887	urxvt::warn ($msg);
634	};	888	};
635
636	# %ENV is the original startup environment
637	delete $ENV{IFS};
638	delete $ENV{CDPATH};
639	delete $ENV{BASH_ENV};
640	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
641	}	889	}
		890
		891	no warnings 'utf8';
642		892
643	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	893	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
644		894
645	sub verbose {	895	sub verbose {
646	my ($level, $msg) = @_;	896	my ($level, $msg) = @_;
…		…
650	my %extension_pkg;	900	my %extension_pkg;
651		901
652	# load a single script into its own package, once only	902	# load a single script into its own package, once only
653	sub extension_package($) {	903	sub extension_package($) {
654	my ($path) = @_;	904	my ($path) = @_;
655
656	no strict 'refs';
657		905
658	$extension_pkg{$path} \|\|= do {	906	$extension_pkg{$path} \|\|= do {
659	$path =~ /([^\/\\]+)$/;	907	$path =~ /([^\/\\]+)$/;
660	my $pkg = $1;	908	my $pkg = $1;
661	$pkg =~ s/[^[:word:]]/_/g;	909	$pkg =~ s/[^[:word:]]/_/g;
…		…
664	verbose 3, "loading extension '$path' into package '$pkg'";	912	verbose 3, "loading extension '$path' into package '$pkg'";
665		913
666	open my $fh, "<:raw", $path	914	open my $fh, "<:raw", $path
667	or die "$path: $!";	915	or die "$path: $!";
668		916
669	@{"$pkg\::ISA"} = urxvt::term::extension::;
670
671	my $source =	917	my $source =
672	"package $pkg; use strict; use utf8;\n"	918	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
673	. "#line 1 \"$path\"\n{\n"	919	. "#line 1 \"$path\"\n{\n"
674	. (do { local $/; <$fh> })	920	. (do { local $/; <$fh> })
675	. "\n};\n1";	921	. "\n};\n1";
676		922
677	eval $source	923	eval $source
…		…
688	local $TERM = shift;	934	local $TERM = shift;
689	my $htype = shift;	935	my $htype = shift;
690		936
691	if ($htype == 0) { # INIT	937	if ($htype == 0) { # INIT
692	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	938	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
693		939
694	my %ext_arg;	940	my %ext_arg;
695		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
696	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	951	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
697	if ($_ eq "default") {	952	if ($_ eq "default") {
698	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	953	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
699	} elsif (/^-(.*)$/) {	954	} elsif (/^-(.*)$/) {
700	delete $ext_arg{$1};	955	delete $ext_arg{$1};
701	} elsif (/^([^<]+)<(.*)>$/) {	956	} elsif (/^([^<]+)<(.*)>$/) {
702	push @{ $ext_arg{$1} }, $2;	957	push @{ $ext_arg{$1} }, $2;
703	} else {	958	} else {
704	$ext_arg{$_} \|\|= [];	959	$ext_arg{$_} \|\|= [];
705	}	960	}
706	}	961	}
707		962
708	while (my ($ext, $argv) = each %ext_arg) {	963	for my $ext (sort keys %ext_arg) {
709	my @files = grep -f $_, map "$_/$ext", @dirs;	964	my @files = grep -f $_, map "$_/$ext", @dirs;
710		965
711	if (@files) {	966	if (@files) {
712	$TERM->register_package (extension_package $files[0], $argv);	967	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
713	} else {	968	} else {
714	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";
715	}	970	}
716	}	971	}
717		972
…		…
723		978
724	if (my $cb = $TERM->{_hook}[$htype]) {	979	if (my $cb = $TERM->{_hook}[$htype]) {
725	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	980	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
726	if $verbosity >= 10;	981	if $verbosity >= 10;
727		982
728	keys %$cb;	983	for my $pkg (keys %$cb) {
729
730	while (my ($pkg, $cb) = each %$cb) {
731	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	984	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
732	and last;	985	$retval \|\|= $retval_;
733		986
734	if ($@) {	987	if ($@) {
735	$TERM->ungrab; # better to lose the grab than the session	988	$TERM->ungrab; # better to lose the grab than the session
736	warn $@;	989	warn $@;
737	}	990	}
…		…
750	}	1003	}
751		1004
752	$retval	1005	$retval
753	}	1006	}
754		1007
755	sub exec_async(@) {	1008	sub SET_COLOR($$$) {
756	my $pid = fork;	1009	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1010	}
757		1011
758	return	1012	sub rend2mask {
759	if !defined $pid or $pid;	1013	no strict 'refs';
760		1014	my ($str, $mask) = (@_, 0);
761	%ENV = %{ $TERM->env };	1015	my %color = ( fg => undef, bg => undef );
762		1016	my @failed;
763	exec @_;	1017	for my $spec ( split /\s+/, $str ) {
764	_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)
765	}	1035	}
766		1036
767	# urxvt::term::extension	1037	# urxvt::term::extension
768		1038
769	package urxvt::term::extension;	1039	package urxvt::term::extension;
…		…
840	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
841	work.	1111	work.
842		1112
843	=cut	1113	=cut
844		1114
845	our $VERSION = 1;	1115	our $VERSION = '3.4';
846		1116
847	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1117	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
848	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1118	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
849		1119
850	sub timer {	1120	sub timer {
…		…
881		1151
882	sub DESTROY {	1152	sub DESTROY {
883	$_[0][1]->stop;	1153	$_[0][1]->stop;
884	}	1154	}
885		1155
886	sub condvar {	1156	sub one_event {
887	bless \my $flag, urxvt::anyevent::condvar::
888	}
889
890	sub urxvt::anyevent::condvar::broadcast {
891	${$_[0]}++;
892	}
893
894	sub urxvt::anyevent::condvar::wait {
895	unless (${$_[0]}) {
896	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";
897	}
898	}	1158	}
899		1159
900	package urxvt::term;	1160	package urxvt::term;
901		1161
902	=head2 The C<urxvt::term> Class	1162	=head2 The C<urxvt::term> Class
…		…
907		1167
908	# find on_xxx subs in the package and register them	1168	# find on_xxx subs in the package and register them
909	# as hooks	1169	# as hooks
910	sub register_package {	1170	sub register_package {
911	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::;
912		1178
913	my $proxy = bless {	1179	my $proxy = bless {
914	_pkg => $pkg,	1180	_pkg => $pkg,
915	argv => $argv,	1181	argv => $argv,
916	}, $pkg;	1182	}, $pkg;
…		…
932	hash which defines the environment of the new terminal.	1198	hash which defines the environment of the new terminal.
933		1199
934	Croaks (and probably outputs an error message) if the new instance	1200	Croaks (and probably outputs an error message) if the new instance
935	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
936	initialise perl, and the terminal object otherwise. The C<init> and	1202	initialise perl, and the terminal object otherwise. The C<init> and
937	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).
938		1205
939	=cut	1206	=cut
940		1207
941	sub new {	1208	sub new {
942	my ($class, $env, @args) = @_;	1209	my ($class, $env, @args) = @_;
943		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
944	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1214	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
945	}	1215	}
946		1216
947	=item $term->destroy	1217	=item $term->destroy
948		1218
949	Destroy the terminal object (close the window, free resources	1219	Destroy the terminal object (close the window, free resources
950	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
951	watchers (timers, io watchers) are still active.	1221	watchers (timers, io watchers) are still active.
952		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
953	=item $isset = $term->option ($optval[, $set])	1248	=item $isset = $term->option ($optval[, $set])
954		1249
955	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
956	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
957	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.
958		1253
959	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
960	source file F</src/optinc.h> to see the actual list:	1255	source file F</src/optinc.h> to see the actual list:
961		1256
962	borderLess console cursorBlink cursorUnderline hold iconic insecure	1257	borderLess console cursorBlink cursorUnderline hold iconic insecure
963	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1258	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
964	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1259	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
965	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1260	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
966	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1261	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
967	tripleclickwords utmpInhibit visualBell	1262	transparent tripleclickwords utmpInhibit visualBell
968		1263
969	=item $value = $term->resource ($name[, $newval])	1264	=item $value = $term->resource ($name[, $newval])
970		1265
971	Returns the current resource value associated with a given name and	1266	Returns the current resource value associated with a given name and
972	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>
…		…
981	likely change).	1276	likely change).
982		1277
983	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
984	terminal is destroyed, so changing options frequently will eat memory.	1279	terminal is destroyed, so changing options frequently will eat memory.
985		1280
986	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
987	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>
988	to see the actual list:	1283	to see the actual list:
989		1284
990	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1285	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
991	borderLess color cursorBlink cursorUnderline cutchars delete_key	1286	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
992	display_name embed ext_bwidth fade font geometry hold iconName	1287	display_name embed ext_bwidth fade font geometry hold iconName
993	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1288	imFont imLocale inputMethod insecure int_bwidth intensityStyles
994	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1289	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
995	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1290	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
996	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1291	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
997	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1292	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
998	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1293	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
999	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1294	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1000	shade term_name title transparent transparent_all tripleclickwords	1295	secondaryScreen secondaryScroll shade term_name title
1001	utmpInhibit visualBell	1296	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1297	visualBell
1002		1298
1003	=cut	1299	=cut
1004		1300
1005	sub resource($$;$) {	1301	sub resource($$;$) {
1006	my ($self, $name) = (shift, shift);	1302	my ($self, $name) = (shift, shift);
1007	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1303	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1008	&urxvt::term::_resource	1304	goto &urxvt::term::_resource
1009	}	1305	}
1010		1306
1011	=item $value = $term->x_resource ($pattern)	1307	=item $value = $term->x_resource ($pattern)
1012		1308
1013	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
…		…
1096		1392
1097	The methods currently supported on C<urxvt::overlay> objects are:	1393	The methods currently supported on C<urxvt::overlay> objects are:
1098		1394
1099	=over 4	1395	=over 4
1100		1396
1101	=item $overlay->set ($x, $y, $text, $rend)	1397	=item $overlay->set ($x, $y, $text[, $rend])
1102		1398
1103	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
1104	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
1105	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.
1106		1404
1107	=item $overlay->hide	1405	=item $overlay->hide
1108		1406
1109	If visible, hide the overlay, but do not destroy it.	1407	If visible, hide the overlay, but do not destroy it.
1110		1408
…		…
1180		1478
1181	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
1182	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
1183	C<on_add_lines> hook, though.	1481	C<on_add_lines> hook, though.
1184		1482
		1483	=item $term->scr_change_screen ($screen)
		1484
		1485	Switch to given screen - 0 primary, 1 secondary.
		1486
1185	=item $term->cmd_parse ($octets)	1487	=item $term->cmd_parse ($octets)
1186		1488
1187	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
1188	locale-specific encoding of the terminal and can contain command sequences	1490	locale-specific encoding of the terminal and can contain command sequences
1189	(escape codes) that will be interpreted.	1491	(escape codes) that will be interpreted.
…		…
1199	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
1200	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
1201	description of C<< urxvt::timer->events >>. Make sure to always restore	1503	description of C<< urxvt::timer->events >>. Make sure to always restore
1202	the previous value.	1504	the previous value.
1203		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
1204	=item $windowid = $term->parent	1511	=item $windowid = $term->parent
1205		1512
1206	Return the window id of the toplevel window.	1513	Return the window id of the toplevel window.
1207		1514
1208	=item $windowid = $term->vt	1515	=item $windowid = $term->vt
…		…
1214	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
1215	to receive pointer events all the times:	1522	to receive pointer events all the times:
1216		1523
1217	$term->vt_emask_add (urxvt::PointerMotionMask);	1524	$term->vt_emask_add (urxvt::PointerMotionMask);
1218		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
1219	=item $window_width = $term->width	1536	=item $window_width = $term->width
1220		1537
1221	=item $window_height = $term->height	1538	=item $window_height = $term->height
1222		1539
1223	=item $font_width = $term->fwidth	1540	=item $font_width = $term->fwidth
…		…
1253	=item $env = $term->env	1570	=item $env = $term->env
1254		1571
1255	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
1256	similar to C<\%ENV>.	1573	similar to C<\%ENV>.
1257		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
1258	=cut	1584	=cut
1259		1585
1260	sub env {	1586	sub env {
1261	if (my $env = $_[0]->_env) {
1262	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1587	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1263	} else {
1264	+{ %ENV }
1265	}
1266	}	1588	}
1267		1589
1268	=item $modifiermask = $term->ModLevel3Mask	1590	=item $modifiermask = $term->ModLevel3Mask
1269		1591
1270	=item $modifiermask = $term->ModMetaMask	1592	=item $modifiermask = $term->ModMetaMask
1271		1593
1272	=item $modifiermask = $term->ModNumLockMask	1594	=item $modifiermask = $term->ModNumLockMask
1273		1595
1274	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
1275	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.
1276		1606
1277	=item $view_start = $term->view_start ([$newvalue])	1607	=item $view_start = $term->view_start ([$newvalue])
1278		1608
1279	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
1280	C<0>, which displays the normal terminal contents. Lower values scroll	1610	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1288		1618
1289	Used after changing terminal contents to display them.	1619	Used after changing terminal contents to display them.
1290		1620
1291	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1621	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1292		1622
1293	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 >>
1294	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
1295	terminal line. The scrollback buffer starts at line C<-1> and extends to
1296	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1625	terminal line. Nothing will be returned if a nonexistent line
1297	is requested.	1626	is requested.
1298		1627
1299	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
1300	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
1301	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
1302	automatically be updated.	1631	automatically be updated.
1303		1632
1304	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
1305	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)
1306	(C<chr 65535>). Characters with combining characters and other characters	1635	characters. Characters with combining characters and other characters that
1307	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
1308	characters in the private use area.	1637	in the private use area.
1309		1638
1310	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
1311	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
1312	characters.	1641	characters.
1313		1642
…		…
1457	where one character corresponds to one screen cell. See	1786	where one character corresponds to one screen cell. See
1458	C<< $term->ROW_t >> for details.	1787	C<< $term->ROW_t >> for details.
1459		1788
1460	=item $string = $term->special_decode $text	1789	=item $string = $term->special_decode $text
1461		1790
1462	Converts rxvt-unicodes text reprsentation into a perl string. See	1791	Converts rxvt-unicodes text representation into a perl string. See
1463	C<< $term->ROW_t >> for details.	1792	C<< $term->ROW_t >> for details.
1464		1793
1465	=item $success = $term->grab_button ($button, $modifiermask)	1794	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1466		1795
		1796	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1797
1467	Registers a synchronous button grab. See the XGrabButton manpage.	1798	Register/unregister a synchronous button grab. See the XGrabButton
		1799	manpage.
1468		1800
1469	=item $success = $term->grab ($eventtime[, $sync])	1801	=item $success = $term->grab ($eventtime[, $sync])
1470		1802
1471	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1803	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1472	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1804	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1473		1805
1474	=item $term->allow_events_async	1806	=item $term->allow_events_async
1475		1807
1476	Calls XAllowEvents with AsyncBoth for the most recent grab.	1808	Calls XAllowEvents with AsyncBoth for the most recent grab.
1477		1809
…		…
1487	=item $term->ungrab	1819	=item $term->ungrab
1488		1820
1489	Calls XUngrab for the most recent grab. Is called automatically on	1821	Calls XUngrab for the most recent grab. Is called automatically on
1490	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
1491	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.
1492		1854
1493	=back	1855	=back
1494		1856
1495	=cut	1857	=cut
1496		1858
…		…
1560	my ($self, $text, $cb) = @_;	1922	my ($self, $text, $cb) = @_;
1561		1923
1562	$self->add_item ({ type => "button", text => $text, activate => $cb});	1924	$self->add_item ({ type => "button", text => $text, activate => $cb});
1563	}	1925	}
1564		1926
1565	=item $popup->add_toggle ($text, $cb, $initial_value)	1927	=item $popup->add_toggle ($text, $initial_value, $cb)
1566		1928
1567	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
1568	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
1569	argument.	1931	first argument.
1570		1932
1571	=cut	1933	=cut
1572		1934
1573	sub add_toggle {	1935	sub add_toggle {
1574	my ($self, $text, $cb, $value) = @_;	1936	my ($self, $text, $value, $cb) = @_;
1575		1937
1576	my $item; $item = {	1938	my $item; $item = {
1577	type => "button",	1939	type => "button",
1578	text => " $text",	1940	text => " $text",
1579	value => $value,	1941	value => $value,
…		…
1598	my $env = $self->{term}->env;	1960	my $env = $self->{term}->env;
1599	# 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.
1600	delete $env->{LC_ALL};	1962	delete $env->{LC_ALL};
1601	$env->{LC_CTYPE} = $self->{term}->locale;	1963	$env->{LC_CTYPE} = $self->{term}->locale;
1602		1964
1603	urxvt::term->new ($env, "popup",	1965	my $term = urxvt::term->new (
1604	"--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",
1605	"--transient-for" => $self->{term}->parent,	1970	"--transient-for" => $self->{term}->parent,
1606	"-display" => $self->{term}->display_id,	1971	"-display" => $self->{term}->display_id,
1607	"-pe" => "urxvt-popup")	1972	"-pe" => "urxvt-popup",
1608	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	}
1609	}	1980	}
1610		1981
1611	sub DESTROY {	1982	sub DESTROY {
1612	my ($self) = @_;	1983	my ($self) = @_;
1613		1984
1614	delete $self->{term}{_destroy}{$self};	1985	delete $self->{term}{_destroy}{$self};
1615	$self->{term}->ungrab;	1986	$self->{term}->ungrab;
1616	}	1987	}
1617		1988
1618	=back	1989	=back
		1990
		1991	=cut
		1992
		1993	package urxvt::watcher;
1619		1994
1620	=head2 The C<urxvt::timer> Class	1995	=head2 The C<urxvt::timer> Class
1621		1996
1622	This class implements timer watchers/events. Time is represented as a	1997	This class implements timer watchers/events. Time is represented as a
1623	fractional number of seconds since the epoch. Example:	1998	fractional number of seconds since the epoch. Example:
…		…
1627	->new	2002	->new
1628	->interval (1)	2003	->interval (1)
1629	->cb (sub {	2004	->cb (sub {
1630	$term->{overlay}->set (0, 0,	2005	$term->{overlay}->set (0, 0,
1631	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2006	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1632	});	2007	});
1633		2008
1634	=over 4	2009	=over 4
1635		2010
1636	=item $timer = new urxvt::timer	2011	=item $timer = new urxvt::timer
1637		2012
…		…
1680		2055
1681	$term->{socket} = ...	2056	$term->{socket} = ...
1682	$term->{iow} = urxvt::iow	2057	$term->{iow} = urxvt::iow
1683	->new	2058	->new
1684	->fd (fileno $term->{socket})	2059	->fd (fileno $term->{socket})
1685	->events (urxvt::EVENT_READ)	2060	->events (urxvt::EV_READ)
1686	->start	2061	->start
1687	->cb (sub {	2062	->cb (sub {
1688	my ($iow, $revents) = @_;	2063	my ($iow, $revents) = @_;
1689	# $revents must be 1 here, no need to check	2064	# $revents must be 1 here, no need to check
1690	sysread $term->{socket}, my $buf, 8192	2065	sysread $term->{socket}, my $buf, 8192
…		…
1703	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>
1704	is a bitset as described in the C<events> method.	2079	is a bitset as described in the C<events> method.
1705		2080
1706	=item $iow = $iow->fd ($fd)	2081	=item $iow = $iow->fd ($fd)
1707		2082
1708	Set the filedescriptor (not handle) to watch.	2083	Set the file descriptor (not handle) to watch.
1709		2084
1710	=item $iow = $iow->events ($eventmask)	2085	=item $iow = $iow->events ($eventmask)
1711		2086
1712	Set the event mask to watch. The only allowed values are	2087	Set the event mask to watch. The only allowed values are
1713	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
1714	together, or C<urxvt::EVENT_NONE>.	2089	together, or C<urxvt::EV_NONE>.
1715		2090
1716	=item $iow = $iow->start	2091	=item $iow = $iow->start
1717		2092
1718	Start watching for requested events on the given handle.	2093	Start watching for requested events on the given handle.
1719		2094
1720	=item $iow = $iow->stop	2095	=item $iow = $iow->stop
1721		2096
1722	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.
1723		2159
1724	=back	2160	=back
1725		2161
1726	=head1 ENVIRONMENT	2162	=head1 ENVIRONMENT
1727		2163
…		…
1736		2172
1737	=item >= 3 - script loading and management	2173	=item >= 3 - script loading and management
1738		2174
1739	=item >=10 - all called hooks	2175	=item >=10 - all called hooks
1740		2176
1741	=item >=11 - hook reutrn values	2177	=item >=11 - hook return values
1742		2178
1743	=back	2179	=back
1744		2180
1745	=head1 AUTHOR	2181	=head1 AUTHOR
1746		2182
…		…
1748	http://software.schmorp.de/pkg/rxvt-unicode	2184	http://software.schmorp.de/pkg/rxvt-unicode
1749		2185
1750	=cut	2186	=cut
1751		2187
1752	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.104 by root, Wed Jan 18 17:49:47 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.104 by root, Wed Jan 18 17:49:47 2006 UTC vs.
Revision 1.173 by root, Wed Nov 5 12:45:36 2008 UTC