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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.107 by root, Wed Jan 18 21:30:50 2006 UTC vs.
Revision 1.165 by root, Sat May 10 22:36:46 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).
176		307
177	=item block-graphics-to-ascii	308	=item block-graphics-to-ascii
178		309
179	A not very useful example of filtering all text output to the terminal,	310	A not very useful example of filtering all text output to the terminal
180	by replacing all line-drawing characters (U+2500 .. U+259F) by a	311	by replacing all line-drawing characters (U+2500 .. U+259F) by a
181	similar-looking ascii character.	312	similar-looking ascii character.
182		313
183	=item digital-clock	314	=item digital-clock
184		315
185	Displays a digital clock using the built-in overlay.	316	Displays a digital clock using the built-in overlay.
186		317
187	=item example-refresh-hooks	318	=item remote-clipboard
188		319
189	Displays a very simple digital clock in the upper right corner of the	320	Somewhat of a misnomer, this extension adds two menu entries to the
190	window. Illustrates overwriting the refresh callbacks to create your own	321	selection popup that allows one to run external commands to store the
191	overlays or changes.	322	selection somewhere and fetch it again.
		323
		324	We use it to implement a "distributed selection mechanism", which just
		325	means that one command uploads the file to a remote server, and another
		326	reads it.
		327
		328	The commands can be set using the C<URxvt.remote-selection.store> and
		329	C<URxvt.remote-selection.fetch> resources. The first should read the
		330	selection to store from STDIN (always in UTF-8), the second should provide
		331	the selection data on STDOUT (also in UTF-8).
		332
		333	The defaults (which are likely useless to you) use rsh and cat:
		334
		335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
192		337
193	=item selection-pastebin	338	=item selection-pastebin
194		339
195	This is a little rarely useful extension that Uploads the selection as	340	This is a little rarely useful extension that Uploads the selection as
196	textfile to a remote site (or does other things). (The implementation is	341	textfile to a remote site (or does other things). (The implementation is
…		…
216	After a successful upload the selection will be replaced by the text given	361	After a successful upload the selection will be replaced by the text given
217	in the C<selection-pastebin-url> resource (again, the % is the placeholder	362	in the C<selection-pastebin-url> resource (again, the % is the placeholder
218	for the filename):	363	for the filename):
219		364
220	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		366
		367	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		368	the double C</> characters as comment start. Use C<\057\057> instead,
		369	which works regardless of wether xrdb is used to parse the resource file
		370	or not.
		371
		372	=item example-refresh-hooks
		373
		374	Displays a very simple digital clock in the upper right corner of the
		375	window. Illustrates overwriting the refresh callbacks to create your own
		376	overlays or changes.
221		377
222	=back	378	=back
223		379
224	=head1 API DOCUMENTATION	380	=head1 API DOCUMENTATION
225		381
…		…
259		415
260	=back	416	=back
261		417
262	=head2 Extension Objects	418	=head2 Extension Objects
263		419
264	Very perl extension is a perl class. A separate perl object is created	420	Every perl extension is a perl class. A separate perl object is created
265	for each terminal and each extension and passed as the first parameter to	421	for each terminal, and each terminal has its own set of extenion objects,
266	hooks. So extensions can use their C<$self> object without having to think	422	which are passed as the first parameter to hooks. So extensions can use
267	about other extensions, with the exception of methods and members that	423	their C<$self> object without having to think about clashes with other
		424	extensions or other terminals, with the exception of methods and members
268	begin with an underscore character C<_>: these are reserved for internal	425	that begin with an underscore character C<_>: these are reserved for
269	use.	426	internal use.
270		427
271	Although it isn't a C<urxvt::term> object, you can call all methods of the	428	Although it isn't a C<urxvt::term> object, you can call all methods of the
272	C<urxvt::term> class on this object.	429	C<urxvt::term> class on this object.
273		430
274	It has the following methods and data members:	431	It has the following methods and data members:
…		…
295	=head2 Hooks	452	=head2 Hooks
296		453
297	The following subroutines can be declared in extension files, and will be	454	The following subroutines can be declared in extension files, and will be
298	called whenever the relevant event happens.	455	called whenever the relevant event happens.
299		456
300	The first argument passed to them is an extension oject as described in	457	The first argument passed to them is an extension object as described in
301	the in the C<Extension Objects> section.	458	the in the C<Extension Objects> section.
302		459
303	B<All> of these hooks must return a boolean value. If it is true, then the	460	B<All> of these hooks must return a boolean value. If any of the called
304	event counts as being I<consumed>, and the invocation of other hooks is	461	hooks returns true, then the event counts as being I<consumed>, and the
305	skipped, and the relevant action might not be carried out by the C++ code.	462	relevant action might not be carried out by the C++ code.
306		463
307	I<< When in doubt, return a false value (preferably C<()>). >>	464	I<< When in doubt, return a false value (preferably C<()>). >>
308		465
309	=over 4	466	=over 4
310		467
311	=item on_init $term	468	=item on_init $term
312		469
313	Called after a new terminal object has been initialized, but before	470	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	471	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	472	call or deliver senseless data, as terminal size and other characteristics
316	have not yet been determined. You can safely query and change resources,	473	have not yet been determined. You can safely query and change resources
317	though.	474	and options, though. For many purposes the C<on_start> hook is a better
		475	place.
		476
		477	=item on_start $term
		478
		479	Called at the very end of initialisation of a new terminal, just before
		480	trying to map (display) the toplevel and returning to the main loop.
		481
		482	=item on_destroy $term
		483
		484	Called whenever something tries to destroy terminal, when the terminal is
		485	still fully functional (not for long, though).
318		486
319	=item on_reset $term	487	=item on_reset $term
320		488
321	Called after the screen is "reset" for any reason, such as resizing or	489	Called after the screen is "reset" for any reason, such as resizing or
322	control sequences. Here is where you can react on changes to size-related	490	control sequences. Here is where you can react on changes to size-related
323	variables.	491	variables.
324		492
325	=item on_start $term	493	=item on_child_start $term, $pid
326		494
327	Called at the very end of initialisation of a new terminal, just before	495	Called just after the child process has been C<fork>ed.
328	returning to the mainloop.	496
		497	=item on_child_exit $term, $status
		498
		499	Called just after the child process has exited. C<$status> is the status
		500	from C<waitpid>.
329		501
330	=item on_sel_make $term, $eventtime	502	=item on_sel_make $term, $eventtime
331		503
332	Called whenever a selection has been made by the user, but before the	504	Called whenever a selection has been made by the user, but before the
333	selection text is copied, so changes to the beginning, end or type of the	505	selection text is copied, so changes to the beginning, end or type of the
…		…
340		512
341	Called whenever a selection has been copied, but before the selection is	513	Called whenever a selection has been copied, but before the selection is
342	requested from the server. The selection text can be queried and changed	514	requested from the server. The selection text can be queried and changed
343	by calling C<< $term->selection >>.	515	by calling C<< $term->selection >>.
344		516
345	Returning a true value aborts selection grabbing. It will still be hilighted.	517	Returning a true value aborts selection grabbing. It will still be highlighted.
346		518
347	=item on_sel_extend $term	519	=item on_sel_extend $term
348		520
349	Called whenever the user tries to extend the selection (e.g. with a double	521	Called whenever the user tries to extend the selection (e.g. with a double
350	click) and is either supposed to return false (normal operation), or	522	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	523	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	524	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	525	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.	526	supposed to enlarge the selection more and more, if possible.
355		527
356	See the F<selection> example extension.	528	See the F<selection> example extension.
357		529
358	=item on_view_change $term, $offset	530	=item on_view_change $term, $offset
359		531
360	Called whenever the view offset changes, i..e the user or program	532	Called whenever the view offset changes, i.e. the user or program
361	scrolls. Offset C<0> means display the normal terminal, positive values	533	scrolls. Offset C<0> means display the normal terminal, positive values
362	show this many lines of scrollback.	534	show this many lines of scrollback.
363		535
364	=item on_scroll_back $term, $lines, $saved	536	=item on_scroll_back $term, $lines, $saved
365		537
…		…
369		541
370	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	542	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
371	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	543	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
372	number of lines that will be in the scrollback buffer.	544	number of lines that will be in the scrollback buffer.
373		545
		546	=item on_osc_seq $term, $op, $args
		547
		548	Called on every OSC sequence and can be used to suppress it or modify its
		549	behaviour. The default should be to return an empty list. A true value
		550	suppresses execution of the request completely. Make sure you don't get
		551	confused by recursive invocations when you output an osc sequence within
		552	this callback.
		553
		554	C<on_osc_seq_perl> should be used for new behaviour.
		555
374	=item on_osc_seq $term, $string	556	=item on_osc_seq_perl $term, $string
375		557
376	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
377	operating system command) is processed. Cursor position and other state	559	operating system command) is processed. Cursor position and other state
378	information is up-to-date when this happens. For interoperability, the	560	information is up-to-date when this happens. For interoperability, the
379	string should start with the extension name and a colon, to distinguish	561	string should start with the extension name and a colon, to distinguish
380	it from commands for other extensions, and this might be enforced in the	562	it from commands for other extensions, and this might be enforced in the
381	future.	563	future.
382		564
383	Be careful not ever to trust (in a security sense) the data you receive,	565	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	566	as its source can not easily be controlled (e-mail content, messages from
385	other users on the same system etc.).	567	other users on the same system etc.).
386		568
387	=item on_add_lines $term, $string	569	=item on_add_lines $term, $string
388		570
389	Called whenever text is about to be output, with the text as argument. You	571	Called whenever text is about to be output, with the text as argument. You
…		…
420		602
421	=item on_refresh_end $term	603	=item on_refresh_end $term
422		604
423	Called just after the screen gets redrawn. See C<on_refresh_begin>.	605	Called just after the screen gets redrawn. See C<on_refresh_begin>.
424		606
425	=item on_keyboard_command $term, $string	607	=item on_user_command $term, $string
426		608
427	Called whenever the user presses a key combination that has a	609	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>	610	a C<perl:string> action bound to a key, see description of the B<keysym>
429	resource in the @@RXVT_NAME@@(1) manpage).	611	resource in the @@RXVT_NAME@@(1) manpage).
		612
		613	The event is simply the action string. This interface is assumed to change
		614	slightly in the future.
		615
		616	=item on_resize_all_windows $tern, $new_width, $new_height
		617
		618	Called just after the new window size has been calculated, but before
		619	windows are actually being resized or hints are being set. If this hook
		620	returns TRUE, setting of the window hints is being skipped.
430		621
431	=item on_x_event $term, $event	622	=item on_x_event $term, $event
432		623
433	Called on every X event received on the vt window (and possibly other	624	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	625	windows). Should only be used as a last resort. Most event structure
435	members are not passed.	626	members are not passed.
436		627
		628	=item on_root_event $term, $event
		629
		630	Like C<on_x_event>, but is called for events on the root window.
		631
437	=item on_focus_in $term	632	=item on_focus_in $term
438		633
439	Called whenever the window gets the keyboard focus, before rxvt-unicode	634	Called whenever the window gets the keyboard focus, before rxvt-unicode
440	does focus in processing.	635	does focus in processing.
441		636
442	=item on_focus_out $term	637	=item on_focus_out $term
443		638
444	Called wheneever the window loses keyboard focus, before rxvt-unicode does	639	Called whenever the window loses keyboard focus, before rxvt-unicode does
445	focus out processing.	640	focus out processing.
446		641
447	=item on_configure_notify $term, $event	642	=item on_configure_notify $term, $event
		643
		644	=item on_property_notify $term, $event
448		645
449	=item on_key_press $term, $event, $keysym, $octets	646	=item on_key_press $term, $event, $keysym, $octets
450		647
451	=item on_key_release $term, $event, $keysym	648	=item on_key_release $term, $event, $keysym
452		649
…		…
462		659
463	Called whenever the corresponding X event is received for the terminal If	660	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.	661	the hook returns true, then the even will be ignored by rxvt-unicode.
465		662
466	The event is a hash with most values as named by Xlib (see the XEvent	663	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	664	manpage), with the additional members C<row> and C<col>, which are the
468	and column under the mouse cursor.	665	(real, not screen-based) row and column under the mouse cursor.
469		666
470	C<on_key_press> additionally receives the string rxvt-unicode would	667	C<on_key_press> additionally receives the string rxvt-unicode would
471	output, if any, in locale-specific encoding.	668	output, if any, in locale-specific encoding.
472		669
473	subwindow.	670	subwindow.
		671
		672	=item on_client_message $term, $event
		673
		674	=item on_wm_protocols $term, $event
		675
		676	=item on_wm_delete_window $term, $event
		677
		678	Called when various types of ClientMessage events are received (all with
		679	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
474		680
475	=back	681	=back
476		682
477	=cut	683	=cut
478		684
…		…
484	use Scalar::Util ();	690	use Scalar::Util ();
485	use List::Util ();	691	use List::Util ();
486		692
487	our $VERSION = 1;	693	our $VERSION = 1;
488	our $TERM;	694	our $TERM;
		695	our @TERM_INIT;
		696	our @TERM_EXT;
489	our @HOOKNAME;	697	our @HOOKNAME;
490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	698	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491	our %OPTION;	699	our %OPTION;
492		700
493	our $LIBDIR;	701	our $LIBDIR;
494	our $RESNAME;	702	our $RESNAME;
495	our $RESCLASS;	703	our $RESCLASS;
496	our $RXVTNAME;	704	our $RXVTNAME;
497		705
		706	our $NOCHAR = chr 0xffff;
		707
498	=head2 Variables in the C<urxvt> Package	708	=head2 Variables in the C<urxvt> Package
499		709
500	=over 4	710	=over 4
501		711
502	=item $urxvt::LIBDIR	712	=item $urxvt::LIBDIR
…		…
514		724
515	=item $urxvt::TERM	725	=item $urxvt::TERM
516		726
517	The current terminal. This variable stores the current C<urxvt::term>	727	The current terminal. This variable stores the current C<urxvt::term>
518	object, whenever a callback/hook is executing.	728	object, whenever a callback/hook is executing.
		729
		730	=item @urxvt::TERM_INIT
		731
		732	All code references in this array will be called as methods of the next newly
		733	created C<urxvt::term> object (during the C<on_init> phase). The array
		734	gets cleared before the code references that were in it are being executed,
		735	so references can push themselves onto it again if they so desire.
		736
		737	This complements to the perl-eval command line option, but gets executed
		738	first.
		739
		740	=item @urxvt::TERM_EXT
		741
		742	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		743	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		744	but before other extensions. Gets cleared just like C<@TERM_INIT>.
519		745
520	=back	746	=back
521		747
522	=head2 Functions in the C<urxvt> Package	748	=head2 Functions in the C<urxvt> Package
523		749
…		…
537		763
538	Using this function has the advantage that its output ends up in the	764	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.	765	correct place, e.g. on stderr of the connecting urxvtc client.
540		766
541	Messages have a size limit of 1023 bytes currently.	767	Messages have a size limit of 1023 bytes currently.
		768
		769	=item @terms = urxvt::termlist
		770
		771	Returns all urxvt::term objects that exist in this process, regardless of
		772	whether they are started, being destroyed etc., so be careful. Only term
		773	objects that have perl extensions attached will be returned (because there
		774	is no urxvt::term objet associated with others).
542		775
543	=item $time = urxvt::NOW	776	=item $time = urxvt::NOW
544		777
545	Returns the "current time" (as per the event loop).	778	Returns the "current time" (as per the event loop).
546		779
…		…
604	Return the foreground/background colour index, respectively.	837	Return the foreground/background colour index, respectively.
605		838
606	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	839	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
607		840
608	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	841	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		842
		843	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
609		844
610	Replace the foreground/background colour in the rendition mask with the	845	Replace the foreground/background colour in the rendition mask with the
611	specified one.	846	specified one.
612		847
613	=item $value = urxvt::GET_CUSTOM $rend	848	=item $value = urxvt::GET_CUSTOM $rend
…		…
632	unless $msg =~ /\n$/;	867	unless $msg =~ /\n$/;
633	urxvt::warn ($msg);	868	urxvt::warn ($msg);
634	};	869	};
635	}	870	}
636		871
		872	no warnings 'utf8';
		873
637	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	874	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
638		875
639	sub verbose {	876	sub verbose {
640	my ($level, $msg) = @_;	877	my ($level, $msg) = @_;
641	warn "$msg\n" if $level <= $verbosity;	878	warn "$msg\n" if $level <= $verbosity;
…		…
644	my %extension_pkg;	881	my %extension_pkg;
645		882
646	# load a single script into its own package, once only	883	# load a single script into its own package, once only
647	sub extension_package($) {	884	sub extension_package($) {
648	my ($path) = @_;	885	my ($path) = @_;
649
650	no strict 'refs';
651		886
652	$extension_pkg{$path} \|\|= do {	887	$extension_pkg{$path} \|\|= do {
653	$path =~ /([^\/\\]+)$/;	888	$path =~ /([^\/\\]+)$/;
654	my $pkg = $1;	889	my $pkg = $1;
655	$pkg =~ s/[^[:word:]]/_/g;	890	$pkg =~ s/[^[:word:]]/_/g;
…		…
658	verbose 3, "loading extension '$path' into package '$pkg'";	893	verbose 3, "loading extension '$path' into package '$pkg'";
659		894
660	open my $fh, "<:raw", $path	895	open my $fh, "<:raw", $path
661	or die "$path: $!";	896	or die "$path: $!";
662		897
663	@{"$pkg\::ISA"} = urxvt::term::extension::;
664
665	my $source =	898	my $source =
666	"package $pkg; use strict; use utf8;\n"	899	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
667	. "#line 1 \"$path\"\n{\n"	900	. "#line 1 \"$path\"\n{\n"
668	. (do { local $/; <$fh> })	901	. (do { local $/; <$fh> })
669	. "\n};\n1";	902	. "\n};\n1";
670		903
671	eval $source	904	eval $source
…		…
682	local $TERM = shift;	915	local $TERM = shift;
683	my $htype = shift;	916	my $htype = shift;
684		917
685	if ($htype == 0) { # INIT	918	if ($htype == 0) { # INIT
686	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	919	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
687		920
688	my %ext_arg;	921	my %ext_arg;
689		922
		923	{
		924	my @init = @TERM_INIT;
		925	@TERM_INIT = ();
		926	$_->($TERM) for @init;
		927	my @pkg = @TERM_EXT;
		928	@TERM_EXT = ();
		929	$TERM->register_package ($_) for @pkg;
		930	}
		931
690	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	932	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
691	if ($_ eq "default") {	933	if ($_ eq "default") {
692	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	934	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
693	} elsif (/^-(.*)$/) {	935	} elsif (/^-(.*)$/) {
694	delete $ext_arg{$1};	936	delete $ext_arg{$1};
695	} elsif (/^([^<]+)<(.*)>$/) {	937	} elsif (/^([^<]+)<(.*)>$/) {
696	push @{ $ext_arg{$1} }, $2;	938	push @{ $ext_arg{$1} }, $2;
697	} else {	939	} else {
698	$ext_arg{$_} \|\|= [];	940	$ext_arg{$_} \|\|= [];
699	}	941	}
700	}	942	}
701		943
702	while (my ($ext, $argv) = each %ext_arg) {	944	for my $ext (sort keys %ext_arg) {
703	my @files = grep -f $_, map "$_/$ext", @dirs;	945	my @files = grep -f $_, map "$_/$ext", @dirs;
704		946
705	if (@files) {	947	if (@files) {
706	$TERM->register_package (extension_package $files[0], $argv);	948	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
707	} else {	949	} else {
708	warn "perl extension '$ext' not found in perl library search path\n";	950	warn "perl extension '$ext' not found in perl library search path\n";
709	}	951	}
710	}	952	}
711		953
…		…
717		959
718	if (my $cb = $TERM->{_hook}[$htype]) {	960	if (my $cb = $TERM->{_hook}[$htype]) {
719	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	961	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
720	if $verbosity >= 10;	962	if $verbosity >= 10;
721		963
722	keys %$cb;	964	for my $pkg (keys %$cb) {
723
724	while (my ($pkg, $cb) = each %$cb) {
725	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	965	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
726	and last;	966	$retval \|\|= $retval_;
727		967
728	if ($@) {	968	if ($@) {
729	$TERM->ungrab; # better to lose the grab than the session	969	$TERM->ungrab; # better to lose the grab than the session
730	warn $@;	970	warn $@;
731	}	971	}
…		…
744	}	984	}
745		985
746	$retval	986	$retval
747	}	987	}
748		988
749	sub exec_async(@) {	989	sub SET_COLOR($$$) {
750	my $pid = fork;	990	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		991	}
751		992
752	return	993	sub rend2mask {
753	if !defined $pid or $pid;	994	no strict 'refs';
754		995	my ($str, $mask) = (@_, 0);
755	%ENV = %{ $TERM->env };	996	my %color = ( fg => undef, bg => undef );
756		997	my @failed;
757	exec @_;	998	for my $spec ( split /\s+/, $str ) {
758	_exit 255;	999	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1000	$color{lc($1)} = $2;
		1001	} else {
		1002	my $neg = $spec =~ s/^[-^]//;
		1003	unless ( exists &{"RS_$spec"} ) {
		1004	push @failed, $spec;
		1005	next;
		1006	}
		1007	my $cur = &{"RS_$spec"};
		1008	if ( $neg ) {
		1009	$mask &= ~$cur;
		1010	} else {
		1011	$mask \|= $cur;
		1012	}
		1013	}
		1014	}
		1015	($mask, @color{qw(fg bg)}, \@failed)
759	}	1016	}
760		1017
761	# urxvt::term::extension	1018	# urxvt::term::extension
762		1019
763	package urxvt::term::extension;	1020	package urxvt::term::extension;
…		…
834	is that you cannot use blocking APIs, but the non-blocking variant should	1091	is that you cannot use blocking APIs, but the non-blocking variant should
835	work.	1092	work.
836		1093
837	=cut	1094	=cut
838		1095
839	our $VERSION = 1;	1096	our $VERSION = '3.4';
840		1097
841	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1098	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
842	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1099	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
843		1100
844	sub timer {	1101	sub timer {
…		…
875		1132
876	sub DESTROY {	1133	sub DESTROY {
877	$_[0][1]->stop;	1134	$_[0][1]->stop;
878	}	1135	}
879		1136
880	sub condvar {	1137	sub one_event {
881	bless \my $flag, urxvt::anyevent::condvar::
882	}
883
884	sub urxvt::anyevent::condvar::broadcast {
885	${$_[0]}++;
886	}
887
888	sub urxvt::anyevent::condvar::wait {
889	unless (${$_[0]}) {
890	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1138	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
891	}
892	}	1139	}
893		1140
894	package urxvt::term;	1141	package urxvt::term;
895		1142
896	=head2 The C<urxvt::term> Class	1143	=head2 The C<urxvt::term> Class
…		…
901		1148
902	# find on_xxx subs in the package and register them	1149	# find on_xxx subs in the package and register them
903	# as hooks	1150	# as hooks
904	sub register_package {	1151	sub register_package {
905	my ($self, $pkg, $argv) = @_;	1152	my ($self, $pkg, $argv) = @_;
		1153
		1154	no strict 'refs';
		1155
		1156	urxvt::verbose 6, "register package $pkg to $self";
		1157
		1158	@{"$pkg\::ISA"} = urxvt::term::extension::;
906		1159
907	my $proxy = bless {	1160	my $proxy = bless {
908	_pkg => $pkg,	1161	_pkg => $pkg,
909	argv => $argv,	1162	argv => $argv,
910	}, $pkg;	1163	}, $pkg;
…		…
926	hash which defines the environment of the new terminal.	1179	hash which defines the environment of the new terminal.
927		1180
928	Croaks (and probably outputs an error message) if the new instance	1181	Croaks (and probably outputs an error message) if the new instance
929	couldn't be created. Returns C<undef> if the new instance didn't	1182	couldn't be created. Returns C<undef> if the new instance didn't
930	initialise perl, and the terminal object otherwise. The C<init> and	1183	initialise perl, and the terminal object otherwise. The C<init> and
931	C<start> hooks will be called during this call.	1184	C<start> hooks will be called before this call returns, and are free to
		1185	refer to global data (which is race free).
932		1186
933	=cut	1187	=cut
934		1188
935	sub new {	1189	sub new {
936	my ($class, $env, @args) = @_;	1190	my ($class, $env, @args) = @_;
937		1191
		1192	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1193	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1194
938	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1195	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
939	}	1196	}
940		1197
941	=item $term->destroy	1198	=item $term->destroy
942		1199
943	Destroy the terminal object (close the window, free resources	1200	Destroy the terminal object (close the window, free resources
944	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1201	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
945	watchers (timers, io watchers) are still active.	1202	watchers (timers, io watchers) are still active.
946		1203
		1204	=item $term->exec_async ($cmd[, @args])
		1205
		1206	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1207	("starts") programs in the background. This function takes care of setting
		1208	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1209	be preferred over explicit calls to C<exec> or C<system>.
		1210
		1211	Returns the pid of the subprocess or C<undef> on error.
		1212
		1213	=cut
		1214
		1215	sub exec_async {
		1216	my $self = shift;
		1217
		1218	my $pid = fork;
		1219
		1220	return $pid
		1221	if !defined $pid or $pid;
		1222
		1223	%ENV = %{ $self->env };
		1224
		1225	exec @_;
		1226	urxvt::_exit 255;
		1227	}
		1228
947	=item $isset = $term->option ($optval[, $set])	1229	=item $isset = $term->option ($optval[, $set])
948		1230
949	Returns true if the option specified by C<$optval> is enabled, and	1231	Returns true if the option specified by C<$optval> is enabled, and
950	optionally change it. All option values are stored by name in the hash	1232	optionally change it. All option values are stored by name in the hash
951	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1233	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
952		1234
953	Here is a a likely non-exhaustive list of option names, please see the	1235	Here is a likely non-exhaustive list of option names, please see the
954	source file F</src/optinc.h> to see the actual list:	1236	source file F</src/optinc.h> to see the actual list:
955		1237
956	borderLess console cursorBlink cursorUnderline hold iconic insecure	1238	borderLess console cursorBlink cursorUnderline hold iconic insecure
957	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1239	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
958	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1240	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
975	likely change).	1257	likely change).
976		1258
977	Please note that resource strings will currently only be freed when the	1259	Please note that resource strings will currently only be freed when the
978	terminal is destroyed, so changing options frequently will eat memory.	1260	terminal is destroyed, so changing options frequently will eat memory.
979		1261
980	Here is a a likely non-exhaustive list of resource names, not all of which	1262	Here is a likely non-exhaustive list of resource names, not all of which
981	are supported in every build, please see the source file F</src/rsinc.h>	1263	are supported in every build, please see the source file F</src/rsinc.h>
982	to see the actual list:	1264	to see the actual list:
983		1265
984	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1266	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
985	borderLess color cursorBlink cursorUnderline cutchars delete_key	1267	borderLess color cursorBlink cursorUnderline cutchars delete_key
…		…
989	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1271	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
990	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1272	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
991	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1273	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
992	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1274	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
993	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1275	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
994	secondaryScreen secondaryScroll selectstyle shade term_name title	1276	secondaryScreen secondaryScroll shade term_name title
995	transient_for transparent transparent_all tripleclickwords utmpInhibit	1277	transient_for transparent transparent_all tripleclickwords utmpInhibit
996	visualBell	1278	visualBell
997		1279
998	=cut	1280	=cut
999		1281
…		…
1175		1457
1176	Normally its not a good idea to use this function, as programs might be	1458	Normally its not a good idea to use this function, as programs might be
1177	confused by changes in cursor position or scrolling. Its useful inside a	1459	confused by changes in cursor position or scrolling. Its useful inside a
1178	C<on_add_lines> hook, though.	1460	C<on_add_lines> hook, though.
1179		1461
		1462	=item $term->scr_change_screen ($screen)
		1463
		1464	Switch to given screen - 0 primary, 1 secondary.
		1465
1180	=item $term->cmd_parse ($octets)	1466	=item $term->cmd_parse ($octets)
1181		1467
1182	Similar to C<scr_add_lines>, but the argument must be in the	1468	Similar to C<scr_add_lines>, but the argument must be in the
1183	locale-specific encoding of the terminal and can contain command sequences	1469	locale-specific encoding of the terminal and can contain command sequences
1184	(escape codes) that will be interpreted.	1470	(escape codes) that will be interpreted.
…		…
1194	Replaces the event mask of the pty watcher by the given event mask. Can	1480	Replaces the event mask of the pty watcher by the given event mask. Can
1195	be used to suppress input and output handling to the pty/tty. See the	1481	be used to suppress input and output handling to the pty/tty. See the
1196	description of C<< urxvt::timer->events >>. Make sure to always restore	1482	description of C<< urxvt::timer->events >>. Make sure to always restore
1197	the previous value.	1483	the previous value.
1198		1484
		1485	=item $fd = $term->pty_fd
		1486
		1487	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1488	is used.
		1489
1199	=item $windowid = $term->parent	1490	=item $windowid = $term->parent
1200		1491
1201	Return the window id of the toplevel window.	1492	Return the window id of the toplevel window.
1202		1493
1203	=item $windowid = $term->vt	1494	=item $windowid = $term->vt
…		…
1209	Adds the specified events to the vt event mask. Useful e.g. when you want	1500	Adds the specified events to the vt event mask. Useful e.g. when you want
1210	to receive pointer events all the times:	1501	to receive pointer events all the times:
1211		1502
1212	$term->vt_emask_add (urxvt::PointerMotionMask);	1503	$term->vt_emask_add (urxvt::PointerMotionMask);
1213		1504
		1505	=item $term->focus_in
		1506
		1507	=item $term->focus_out
		1508
		1509	=item $term->key_press ($state, $keycode[, $time])
		1510
		1511	=item $term->key_release ($state, $keycode[, $time])
		1512
		1513	Deliver various fake events to to terminal.
		1514
1214	=item $window_width = $term->width	1515	=item $window_width = $term->width
1215		1516
1216	=item $window_height = $term->height	1517	=item $window_height = $term->height
1217		1518
1218	=item $font_width = $term->fwidth	1519	=item $font_width = $term->fwidth
…		…
1248	=item $env = $term->env	1549	=item $env = $term->env
1249		1550
1250	Returns a copy of the environment in effect for the terminal as a hashref	1551	Returns a copy of the environment in effect for the terminal as a hashref
1251	similar to C<\%ENV>.	1552	similar to C<\%ENV>.
1252		1553
		1554	=item @envv = $term->envv
		1555
		1556	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1557
		1558	=item @argv = $term->argv
		1559
		1560	Return the argument vector as this terminal, similar to @ARGV, but
		1561	includes the program name as first element.
		1562
1253	=cut	1563	=cut
1254		1564
1255	sub env {	1565	sub env {
1256	if (my $env = $_[0]->_env) {
1257	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1566	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1258	} else {
1259	+{ %ENV }
1260	}
1261	}	1567	}
1262		1568
1263	=item $modifiermask = $term->ModLevel3Mask	1569	=item $modifiermask = $term->ModLevel3Mask
1264		1570
1265	=item $modifiermask = $term->ModMetaMask	1571	=item $modifiermask = $term->ModMetaMask
1266		1572
1267	=item $modifiermask = $term->ModNumLockMask	1573	=item $modifiermask = $term->ModNumLockMask
1268		1574
1269	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1575	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1270	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1576	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1577
		1578	=item $screen = $term->current_screen
		1579
		1580	Returns the currently displayed screen (0 primary, 1 secondary).
		1581
		1582	=item $cursor_is_hidden = $term->hidden_cursor
		1583
		1584	Returns whether the cursor is currently hidden or not.
1271		1585
1272	=item $view_start = $term->view_start ([$newvalue])	1586	=item $view_start = $term->view_start ([$newvalue])
1273		1587
1274	Returns the row number of the topmost displayed line. Maximum value is	1588	Returns the row number of the topmost displayed line. Maximum value is
1275	C<0>, which displays the normal terminal contents. Lower values scroll	1589	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1295	line, starting at column C<$start_col> (default C<0>), which is useful	1609	line, starting at column C<$start_col> (default C<0>), which is useful
1296	to replace only parts of a line. The font index in the rendition will	1610	to replace only parts of a line. The font index in the rendition will
1297	automatically be updated.	1611	automatically be updated.
1298		1612
1299	C<$text> is in a special encoding: tabs and wide characters that use more	1613	C<$text> is in a special encoding: tabs and wide characters that use more
1300	than one cell when displayed are padded with urxvt::NOCHAR characters	1614	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1301	(C<chr 65535>). Characters with combining characters and other characters	1615	characters. Characters with combining characters and other characters that
1302	that do not fit into the normal tetx encoding will be replaced with	1616	do not fit into the normal text encoding will be replaced with characters
1303	characters in the private use area.	1617	in the private use area.
1304		1618
1305	You have to obey this encoding when changing text. The advantage is	1619	You have to obey this encoding when changing text. The advantage is
1306	that C<substr> and similar functions work on screen cells and not on	1620	that C<substr> and similar functions work on screen cells and not on
1307	characters.	1621	characters.
1308		1622
…		…
1452	where one character corresponds to one screen cell. See	1766	where one character corresponds to one screen cell. See
1453	C<< $term->ROW_t >> for details.	1767	C<< $term->ROW_t >> for details.
1454		1768
1455	=item $string = $term->special_decode $text	1769	=item $string = $term->special_decode $text
1456		1770
1457	Converts rxvt-unicodes text reprsentation into a perl string. See	1771	Converts rxvt-unicodes text representation into a perl string. See
1458	C<< $term->ROW_t >> for details.	1772	C<< $term->ROW_t >> for details.
1459		1773
1460	=item $success = $term->grab_button ($button, $modifiermask)	1774	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1461		1775
		1776	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1777
1462	Registers a synchronous button grab. See the XGrabButton manpage.	1778	Register/unregister a synchronous button grab. See the XGrabButton
		1779	manpage.
1463		1780
1464	=item $success = $term->grab ($eventtime[, $sync])	1781	=item $success = $term->grab ($eventtime[, $sync])
1465		1782
1466	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1783	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1467	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1784	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1468		1785
1469	=item $term->allow_events_async	1786	=item $term->allow_events_async
1470		1787
1471	Calls XAllowEvents with AsyncBoth for the most recent grab.	1788	Calls XAllowEvents with AsyncBoth for the most recent grab.
1472		1789
…		…
1482	=item $term->ungrab	1799	=item $term->ungrab
1483		1800
1484	Calls XUngrab for the most recent grab. Is called automatically on	1801	Calls XUngrab for the most recent grab. Is called automatically on
1485	evaluation errors, as it is better to lose the grab in the error case as	1802	evaluation errors, as it is better to lose the grab in the error case as
1486	the session.	1803	the session.
		1804
		1805	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1806
		1807	=item $atom_name = $term->XGetAtomName ($atom)
		1808
		1809	=item @atoms = $term->XListProperties ($window)
		1810
		1811	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1812
		1813	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1814
		1815	=item $term->XDeleteProperty ($window, $property)
		1816
		1817	=item $window = $term->DefaultRootWindow
		1818
		1819	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1820
		1821	=item $term->XMapWindow ($window)
		1822
		1823	=item $term->XUnmapWindow ($window)
		1824
		1825	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1826
		1827	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1828
		1829	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1830
		1831	Various X or X-related functions. The C<$term> object only serves as
		1832	the source of the display, otherwise those functions map more-or-less
		1833	directory onto the X functions of the same name.
1487		1834
1488	=back	1835	=back
1489		1836
1490	=cut	1837	=cut
1491		1838
…		…
1555	my ($self, $text, $cb) = @_;	1902	my ($self, $text, $cb) = @_;
1556		1903
1557	$self->add_item ({ type => "button", text => $text, activate => $cb});	1904	$self->add_item ({ type => "button", text => $text, activate => $cb});
1558	}	1905	}
1559		1906
1560	=item $popup->add_toggle ($text, $cb, $initial_value)	1907	=item $popup->add_toggle ($text, $initial_value, $cb)
1561		1908
1562	Adds a toggle/checkbox item to the popup. Teh callback gets called	1909	Adds a toggle/checkbox item to the popup. The callback gets called
1563	whenever it gets toggled, with a boolean indicating its value as its first	1910	whenever it gets toggled, with a boolean indicating its new value as its
1564	argument.	1911	first argument.
1565		1912
1566	=cut	1913	=cut
1567		1914
1568	sub add_toggle {	1915	sub add_toggle {
1569	my ($self, $text, $cb, $value) = @_;	1916	my ($self, $text, $value, $cb) = @_;
1570		1917
1571	my $item; $item = {	1918	my $item; $item = {
1572	type => "button",	1919	type => "button",
1573	text => " $text",	1920	text => " $text",
1574	value => $value,	1921	value => $value,
…		…
1593	my $env = $self->{term}->env;	1940	my $env = $self->{term}->env;
1594	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1941	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1595	delete $env->{LC_ALL};	1942	delete $env->{LC_ALL};
1596	$env->{LC_CTYPE} = $self->{term}->locale;	1943	$env->{LC_CTYPE} = $self->{term}->locale;
1597		1944
1598	urxvt::term->new ($env, "popup",	1945	my $term = urxvt::term->new (
		1946	$env, "popup",
1599	"--perl-lib" => "", "--perl-ext-common" => "",	1947	"--perl-lib" => "", "--perl-ext-common" => "",
1600	"-pty-fd" => -1, "-sl" => 0,	1948	"-pty-fd" => -1, "-sl" => 0,
1601	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1949	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1602	"--transient-for" => $self->{term}->parent,	1950	"--transient-for" => $self->{term}->parent,
1603	"-display" => $self->{term}->display_id,	1951	"-display" => $self->{term}->display_id,
1604	"-pe" => "urxvt-popup")	1952	"-pe" => "urxvt-popup",
1605	or die "unable to create popup window\n";	1953	) or die "unable to create popup window\n";
		1954
		1955	unless (delete $term->{urxvt_popup_init_done}) {
		1956	$term->ungrab;
		1957	$term->destroy;
		1958	die "unable to initialise popup window\n";
		1959	}
1606	}	1960	}
1607		1961
1608	sub DESTROY {	1962	sub DESTROY {
1609	my ($self) = @_;	1963	my ($self) = @_;
1610		1964
1611	delete $self->{term}{_destroy}{$self};	1965	delete $self->{term}{_destroy}{$self};
1612	$self->{term}->ungrab;	1966	$self->{term}->ungrab;
1613	}	1967	}
1614		1968
1615	=back	1969	=back
		1970
		1971	=cut
		1972
		1973	package urxvt::watcher;
1616		1974
1617	=head2 The C<urxvt::timer> Class	1975	=head2 The C<urxvt::timer> Class
1618		1976
1619	This class implements timer watchers/events. Time is represented as a	1977	This class implements timer watchers/events. Time is represented as a
1620	fractional number of seconds since the epoch. Example:	1978	fractional number of seconds since the epoch. Example:
…		…
1624	->new	1982	->new
1625	->interval (1)	1983	->interval (1)
1626	->cb (sub {	1984	->cb (sub {
1627	$term->{overlay}->set (0, 0,	1985	$term->{overlay}->set (0, 0,
1628	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1986	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1629	});	1987	});
1630		1988
1631	=over 4	1989	=over 4
1632		1990
1633	=item $timer = new urxvt::timer	1991	=item $timer = new urxvt::timer
1634		1992
…		…
1677		2035
1678	$term->{socket} = ...	2036	$term->{socket} = ...
1679	$term->{iow} = urxvt::iow	2037	$term->{iow} = urxvt::iow
1680	->new	2038	->new
1681	->fd (fileno $term->{socket})	2039	->fd (fileno $term->{socket})
1682	->events (urxvt::EVENT_READ)	2040	->events (urxvt::EV_READ)
1683	->start	2041	->start
1684	->cb (sub {	2042	->cb (sub {
1685	my ($iow, $revents) = @_;	2043	my ($iow, $revents) = @_;
1686	# $revents must be 1 here, no need to check	2044	# $revents must be 1 here, no need to check
1687	sysread $term->{socket}, my $buf, 8192	2045	sysread $term->{socket}, my $buf, 8192
…		…
1700	Set the callback to be called when io events are triggered. C<$reventmask>	2058	Set the callback to be called when io events are triggered. C<$reventmask>
1701	is a bitset as described in the C<events> method.	2059	is a bitset as described in the C<events> method.
1702		2060
1703	=item $iow = $iow->fd ($fd)	2061	=item $iow = $iow->fd ($fd)
1704		2062
1705	Set the filedescriptor (not handle) to watch.	2063	Set the file descriptor (not handle) to watch.
1706		2064
1707	=item $iow = $iow->events ($eventmask)	2065	=item $iow = $iow->events ($eventmask)
1708		2066
1709	Set the event mask to watch. The only allowed values are	2067	Set the event mask to watch. The only allowed values are
1710	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2068	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1711	together, or C<urxvt::EVENT_NONE>.	2069	together, or C<urxvt::EV_NONE>.
1712		2070
1713	=item $iow = $iow->start	2071	=item $iow = $iow->start
1714		2072
1715	Start watching for requested events on the given handle.	2073	Start watching for requested events on the given handle.
1716		2074
1717	=item $iow = $iow->stop	2075	=item $iow = $iow->stop
1718		2076
1719	Stop watching for events on the given filehandle.	2077	Stop watching for events on the given file handle.
		2078
		2079	=back
		2080
		2081	=head2 The C<urxvt::iw> Class
		2082
		2083	This class implements idle watchers, that get called automatically when
		2084	the process is idle. They should return as fast as possible, after doing
		2085	some useful work.
		2086
		2087	=over 4
		2088
		2089	=item $iw = new urxvt::iw
		2090
		2091	Create a new idle watcher object in stopped state.
		2092
		2093	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2094
		2095	Set the callback to be called when the watcher triggers.
		2096
		2097	=item $timer = $timer->start
		2098
		2099	Start the watcher.
		2100
		2101	=item $timer = $timer->stop
		2102
		2103	Stop the watcher.
		2104
		2105	=back
		2106
		2107	=head2 The C<urxvt::pw> Class
		2108
		2109	This class implements process watchers. They create an event whenever a
		2110	process exits, after which they stop automatically.
		2111
		2112	my $pid = fork;
		2113	...
		2114	$term->{pw} = urxvt::pw
		2115	->new
		2116	->start ($pid)
		2117	->cb (sub {
		2118	my ($pw, $exit_status) = @_;
		2119	...
		2120	});
		2121
		2122	=over 4
		2123
		2124	=item $pw = new urxvt::pw
		2125
		2126	Create a new process watcher in stopped state.
		2127
		2128	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2129
		2130	Set the callback to be called when the timer triggers.
		2131
		2132	=item $pw = $timer->start ($pid)
		2133
		2134	Tells the watcher to start watching for process C<$pid>.
		2135
		2136	=item $pw = $pw->stop
		2137
		2138	Stop the watcher.
1720		2139
1721	=back	2140	=back
1722		2141
1723	=head1 ENVIRONMENT	2142	=head1 ENVIRONMENT
1724		2143
…		…
1733		2152
1734	=item >= 3 - script loading and management	2153	=item >= 3 - script loading and management
1735		2154
1736	=item >=10 - all called hooks	2155	=item >=10 - all called hooks
1737		2156
1738	=item >=11 - hook reutrn values	2157	=item >=11 - hook return values
1739		2158
1740	=back	2159	=back
1741		2160
1742	=head1 AUTHOR	2161	=head1 AUTHOR
1743		2162
…		…
1745	http://software.schmorp.de/pkg/rxvt-unicode	2164	http://software.schmorp.de/pkg/rxvt-unicode
1746		2165
1747	=cut	2166	=cut
1748		2167
1749	1	2168	1
		2169
		2170	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.107 by root, Wed Jan 18 21:30:50 2006 UTC vs. Revision 1.165 by root, Sat May 10 22:36:46 2008 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.107 by root, Wed Jan 18 21:30:50 2006 UTC vs.
Revision 1.165 by root, Sat May 10 22:36:46 2008 UTC