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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC vs.
Revision 1.160 by ayin, Fri Nov 16 10:06:40 2007 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 (the 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.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
168		307
169	=item block-graphics-to-ascii	308	=item block-graphics-to-ascii
170		309
171	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
172	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
173	similar-looking ascii character.	312	similar-looking ascii character.
174		313
175	=item digital-clock	314	=item digital-clock
176		315
177	Displays a digital clock using the built-in overlay.	316	Displays a digital clock using the built-in overlay.
178		317
179	=item example-refresh-hooks	318	=item remote-clipboard
180		319
181	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
182	window. Illustrates overwriting the refresh callbacks to create your own	321	selection popup that allows one to run external commands to store the
183	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'
184		337
185	=item selection-pastebin	338	=item selection-pastebin
186		339
187	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
188	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
…		…
208	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
209	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
210	for the filename):	363	for the filename):
211		364
212	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.
213		377
214	=back	378	=back
215		379
216	=head1 API DOCUMENTATION	380	=head1 API DOCUMENTATION
217		381
…		…
251		415
252	=back	416	=back
253		417
254	=head2 Extension Objects	418	=head2 Extension Objects
255		419
256	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
257	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,
258	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
259	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
260	begin with an underscore character C<_>: these are reserved for internal	425	that begin with an underscore character C<_>: these are reserved for
261	use.	426	internal use.
262		427
263	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
264	C<urxvt::term> class on this object.	429	C<urxvt::term> class on this object.
265		430
266	It has the following methods and data members:	431	It has the following methods and data members:
…		…
287	=head2 Hooks	452	=head2 Hooks
288		453
289	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
290	called whenever the relevant event happens.	455	called whenever the relevant event happens.
291		456
292	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
293	the in the C<Extension Objects> section.	458	the in the C<Extension Objects> section.
294		459
295	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
296	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
297	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.
298		463
299	I<< When in doubt, return a false value (preferably C<()>). >>	464	I<< When in doubt, return a false value (preferably C<()>). >>
300		465
301	=over 4	466	=over 4
302		467
303	=item on_init $term	468	=item on_init $term
304		469
305	Called after a new terminal object has been initialized, but before	470	Called after a new terminal object has been initialized, but before
306	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
307	call or deliver senseless data, as terminal size and other characteristics	472	call or deliver senseless data, as terminal size and other characteristics
308	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
309	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).
310		486
311	=item on_reset $term	487	=item on_reset $term
312		488
313	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
314	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
315	variables.	491	variables.
316		492
317	=item on_start $term	493	=item on_child_start $term, $pid
318		494
319	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.
320	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>.
321		501
322	=item on_sel_make $term, $eventtime	502	=item on_sel_make $term, $eventtime
323		503
324	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
325	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
…		…
332		512
333	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
334	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
335	by calling C<< $term->selection >>.	515	by calling C<< $term->selection >>.
336		516
337	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.
338		518
339	=item on_sel_extend $term	519	=item on_sel_extend $term
340		520
341	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
342	click) and is either supposed to return false (normal operation), or	522	click) and is either supposed to return false (normal operation), or
343	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
344	processing. This can happen multiple times, as long as the callback	524	processing. This can happen multiple times, as long as the callback
345	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
346	supposed to enlarge the selection more and more, if possible.	526	supposed to enlarge the selection more and more, if possible.
347		527
348	See the F<selection> example extension.	528	See the F<selection> example extension.
349		529
350	=item on_view_change $term, $offset	530	=item on_view_change $term, $offset
351		531
352	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
353	scrolls. Offset C<0> means display the normal terminal, positive values	533	scrolls. Offset C<0> means display the normal terminal, positive values
354	show this many lines of scrollback.	534	show this many lines of scrollback.
355		535
356	=item on_scroll_back $term, $lines, $saved	536	=item on_scroll_back $term, $lines, $saved
357		537
…		…
361		541
362	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,
363	$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
364	number of lines that will be in the scrollback buffer.	544	number of lines that will be in the scrollback buffer.
365		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
366	=item on_osc_seq $term, $string	556	=item on_osc_seq_perl $term, $string
367		557
368	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
369	operating system command) is processed. Cursor position and other state	559	operating system command) is processed. Cursor position and other state
370	information is up-to-date when this happens. For interoperability, the	560	information is up-to-date when this happens. For interoperability, the
371	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
372	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
373	future.	563	future.
374		564
375	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,
376	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
377	other users on the same system etc.).	567	other users on the same system etc.).
378		568
379	=item on_add_lines $term, $string	569	=item on_add_lines $term, $string
380		570
381	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
…		…
412		602
413	=item on_refresh_end $term	603	=item on_refresh_end $term
414		604
415	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>.
416		606
417	=item on_keyboard_command $term, $string	607	=item on_user_command $term, $string
418		608
419	Called whenever the user presses a key combination that has a	609	Called whenever a user-configured event is being activated (e.g. via
420	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>
421	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.
422		621
423	=item on_x_event $term, $event	622	=item on_x_event $term, $event
424		623
425	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
426	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
427	members are not passed.	626	members are not passed.
428		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
429	=item on_focus_in $term	632	=item on_focus_in $term
430		633
431	Called whenever the window gets the keyboard focus, before rxvt-unicode	634	Called whenever the window gets the keyboard focus, before rxvt-unicode
432	does focus in processing.	635	does focus in processing.
433		636
434	=item on_focus_out $term	637	=item on_focus_out $term
435		638
436	Called wheneever the window loses keyboard focus, before rxvt-unicode does	639	Called whenever the window loses keyboard focus, before rxvt-unicode does
437	focus out processing.	640	focus out processing.
438		641
439	=item on_configure_notify $term, $event	642	=item on_configure_notify $term, $event
		643
		644	=item on_property_notify $term, $event
440		645
441	=item on_key_press $term, $event, $keysym, $octets	646	=item on_key_press $term, $event, $keysym, $octets
442		647
443	=item on_key_release $term, $event, $keysym	648	=item on_key_release $term, $event, $keysym
444		649
…		…
454		659
455	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
456	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.
457		662
458	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
459	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
460	and column under the mouse cursor.	665	(real, not screen-based) row and column under the mouse cursor.
461		666
462	C<on_key_press> additionally receives the string rxvt-unicode would	667	C<on_key_press> additionally receives the string rxvt-unicode would
463	output, if any, in locale-specific encoding.	668	output, if any, in locale-specific encoding.
464		669
465	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).
466		680
467	=back	681	=back
468		682
469	=cut	683	=cut
470		684
…		…
476	use Scalar::Util ();	690	use Scalar::Util ();
477	use List::Util ();	691	use List::Util ();
478		692
479	our $VERSION = 1;	693	our $VERSION = 1;
480	our $TERM;	694	our $TERM;
		695	our @TERM_INIT;
		696	our @TERM_EXT;
481	our @HOOKNAME;	697	our @HOOKNAME;
482	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	698	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
483	our %OPTION;	699	our %OPTION;
484		700
485	our $LIBDIR;	701	our $LIBDIR;
486	our $RESNAME;	702	our $RESNAME;
487	our $RESCLASS;	703	our $RESCLASS;
488	our $RXVTNAME;	704	our $RXVTNAME;
489		705
		706	our $NOCHAR = chr 0xffff;
		707
490	=head2 Variables in the C<urxvt> Package	708	=head2 Variables in the C<urxvt> Package
491		709
492	=over 4	710	=over 4
493		711
494	=item $urxvt::LIBDIR	712	=item $urxvt::LIBDIR
…		…
506		724
507	=item $urxvt::TERM	725	=item $urxvt::TERM
508		726
509	The current terminal. This variable stores the current C<urxvt::term>	727	The current terminal. This variable stores the current C<urxvt::term>
510	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>.
511		745
512	=back	746	=back
513		747
514	=head2 Functions in the C<urxvt> Package	748	=head2 Functions in the C<urxvt> Package
515		749
…		…
529		763
530	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
531	correct place, e.g. on stderr of the connecting urxvtc client.	765	correct place, e.g. on stderr of the connecting urxvtc client.
532		766
533	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).
534		775
535	=item $time = urxvt::NOW	776	=item $time = urxvt::NOW
536		777
537	Returns the "current time" (as per the event loop).	778	Returns the "current time" (as per the event loop).
538		779
…		…
596	Return the foreground/background colour index, respectively.	837	Return the foreground/background colour index, respectively.
597		838
598	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	839	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
599		840
600	=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
601		844
602	Replace the foreground/background colour in the rendition mask with the	845	Replace the foreground/background colour in the rendition mask with the
603	specified one.	846	specified one.
604		847
605	=item $value = urxvt::GET_CUSTOM $rend	848	=item $value = urxvt::GET_CUSTOM $rend
…		…
622	my $msg = join "", @_;	865	my $msg = join "", @_;
623	$msg .= "\n"	866	$msg .= "\n"
624	unless $msg =~ /\n$/;	867	unless $msg =~ /\n$/;
625	urxvt::warn ($msg);	868	urxvt::warn ($msg);
626	};	869	};
627
628	# %ENV is the original startup environment
629	delete $ENV{IFS};
630	delete $ENV{CDPATH};
631	delete $ENV{BASH_ENV};
632	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
633	}	870	}
		871
		872	no warnings 'utf8';
634		873
635	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	874	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
636		875
637	sub verbose {	876	sub verbose {
638	my ($level, $msg) = @_;	877	my ($level, $msg) = @_;
…		…
642	my %extension_pkg;	881	my %extension_pkg;
643		882
644	# load a single script into its own package, once only	883	# load a single script into its own package, once only
645	sub extension_package($) {	884	sub extension_package($) {
646	my ($path) = @_;	885	my ($path) = @_;
647
648	no strict 'refs';
649		886
650	$extension_pkg{$path} \|\|= do {	887	$extension_pkg{$path} \|\|= do {
651	$path =~ /([^\/\\]+)$/;	888	$path =~ /([^\/\\]+)$/;
652	my $pkg = $1;	889	my $pkg = $1;
653	$pkg =~ s/[^[:word:]]/_/g;	890	$pkg =~ s/[^[:word:]]/_/g;
…		…
656	verbose 3, "loading extension '$path' into package '$pkg'";	893	verbose 3, "loading extension '$path' into package '$pkg'";
657		894
658	open my $fh, "<:raw", $path	895	open my $fh, "<:raw", $path
659	or die "$path: $!";	896	or die "$path: $!";
660		897
661	@{"$pkg\::ISA"} = urxvt::term::extension::;
662
663	my $source =	898	my $source =
664	"package $pkg; use strict; use utf8;\n"	899	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
665	. "#line 1 \"$path\"\n{\n"	900	. "#line 1 \"$path\"\n{\n"
666	. (do { local $/; <$fh> })	901	. (do { local $/; <$fh> })
667	. "\n};\n1";	902	. "\n};\n1";
668		903
669	eval $source	904	eval $source
…		…
680	local $TERM = shift;	915	local $TERM = shift;
681	my $htype = shift;	916	my $htype = shift;
682		917
683	if ($htype == 0) { # INIT	918	if ($htype == 0) { # INIT
684	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	919	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
685		920
686	my %ext_arg;	921	my %ext_arg;
687		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
688	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	932	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
689	if ($_ eq "default") {	933	if ($_ eq "default") {
690	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	934	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
691	} elsif (/^-(.*)$/) {	935	} elsif (/^-(.*)$/) {
692	delete $ext_arg{$1};	936	delete $ext_arg{$1};
693	} elsif (/^([^<]+)<(.*)>$/) {	937	} elsif (/^([^<]+)<(.*)>$/) {
694	push @{ $ext_arg{$1} }, $2;	938	push @{ $ext_arg{$1} }, $2;
695	} else {	939	} else {
696	$ext_arg{$_} \|\|= [];	940	$ext_arg{$_} \|\|= [];
697	}	941	}
698	}	942	}
699		943
700	while (my ($ext, $argv) = each %ext_arg) {	944	for my $ext (sort keys %ext_arg) {
701	my @files = grep -f $_, map "$_/$ext", @dirs;	945	my @files = grep -f $_, map "$_/$ext", @dirs;
702		946
703	if (@files) {	947	if (@files) {
704	$TERM->register_package (extension_package $files[0], $argv);	948	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
705	} else {	949	} else {
706	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";
707	}	951	}
708	}	952	}
709		953
…		…
715		959
716	if (my $cb = $TERM->{_hook}[$htype]) {	960	if (my $cb = $TERM->{_hook}[$htype]) {
717	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	961	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
718	if $verbosity >= 10;	962	if $verbosity >= 10;
719		963
720	keys %$cb;	964	for my $pkg (keys %$cb) {
721
722	while (my ($pkg, $cb) = each %$cb) {
723	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	965	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
724	and last;	966	$retval \|\|= $retval_;
725		967
726	if ($@) {	968	if ($@) {
727	$TERM->ungrab; # better to lose the grab than the session	969	$TERM->ungrab; # better to lose the grab than the session
728	warn $@;	970	warn $@;
729	}	971	}
…		…
742	}	984	}
743		985
744	$retval	986	$retval
745	}	987	}
746		988
747	sub exec_async(@) {	989	sub SET_COLOR($$$) {
748	my $pid = fork;	990	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		991	}
749		992
750	return	993	sub rend2mask {
751	if !defined $pid or $pid;	994	no strict 'refs';
752		995	my ($str, $mask) = (@_, 0);
753	%ENV = %{ $TERM->env };	996	my %color = ( fg => undef, bg => undef );
754		997	my @failed;
755	exec @_;	998	for my $spec ( split /\s+/, $str ) {
756	_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)
757	}	1016	}
758		1017
759	# urxvt::term::extension	1018	# urxvt::term::extension
760		1019
761	package urxvt::term::extension;	1020	package urxvt::term::extension;
…		…
874	sub DESTROY {	1133	sub DESTROY {
875	$_[0][1]->stop;	1134	$_[0][1]->stop;
876	}	1135	}
877		1136
878	sub condvar {	1137	sub condvar {
879	bless \my $flag, urxvt::anyevent::condvar::	1138	bless \my $flag, urxvt::anyevent::
880	}	1139	}
881		1140
882	sub urxvt::anyevent::condvar::broadcast {	1141	sub broadcast {
883	${$_[0]}++;	1142	${$_[0]}++;
884	}	1143	}
885		1144
886	sub urxvt::anyevent::condvar::wait {	1145	sub wait {
887	unless (${$_[0]}) {	1146	unless (${$_[0]}) {
888	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1147	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
889	}	1148	}
		1149	}
		1150
		1151	sub one_event {
		1152	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
890	}	1153	}
891		1154
892	package urxvt::term;	1155	package urxvt::term;
893		1156
894	=head2 The C<urxvt::term> Class	1157	=head2 The C<urxvt::term> Class
…		…
899		1162
900	# find on_xxx subs in the package and register them	1163	# find on_xxx subs in the package and register them
901	# as hooks	1164	# as hooks
902	sub register_package {	1165	sub register_package {
903	my ($self, $pkg, $argv) = @_;	1166	my ($self, $pkg, $argv) = @_;
		1167
		1168	no strict 'refs';
		1169
		1170	urxvt::verbose 6, "register package $pkg to $self";
		1171
		1172	@{"$pkg\::ISA"} = urxvt::term::extension::;
904		1173
905	my $proxy = bless {	1174	my $proxy = bless {
906	_pkg => $pkg,	1175	_pkg => $pkg,
907	argv => $argv,	1176	argv => $argv,
908	}, $pkg;	1177	}, $pkg;
…		…
924	hash which defines the environment of the new terminal.	1193	hash which defines the environment of the new terminal.
925		1194
926	Croaks (and probably outputs an error message) if the new instance	1195	Croaks (and probably outputs an error message) if the new instance
927	couldn't be created. Returns C<undef> if the new instance didn't	1196	couldn't be created. Returns C<undef> if the new instance didn't
928	initialise perl, and the terminal object otherwise. The C<init> and	1197	initialise perl, and the terminal object otherwise. The C<init> and
929	C<start> hooks will be called during this call.	1198	C<start> hooks will be called before this call returns, and are free to
		1199	refer to global data (which is race free).
930		1200
931	=cut	1201	=cut
932		1202
933	sub new {	1203	sub new {
934	my ($class, $env, @args) = @_;	1204	my ($class, $env, @args) = @_;
935		1205
		1206	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1207	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1208
936	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1209	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
937	}	1210	}
938		1211
939	=item $term->destroy	1212	=item $term->destroy
940		1213
941	Destroy the terminal object (close the window, free resources	1214	Destroy the terminal object (close the window, free resources
942	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1215	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
943	watchers (timers, io watchers) are still active.	1216	watchers (timers, io watchers) are still active.
944		1217
		1218	=item $term->exec_async ($cmd[, @args])
		1219
		1220	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1221	("starts") programs in the background. This function takes care of setting
		1222	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1223	be preferred over explicit calls to C<exec> or C<system>.
		1224
		1225	Returns the pid of the subprocess or C<undef> on error.
		1226
		1227	=cut
		1228
		1229	sub exec_async {
		1230	my $self = shift;
		1231
		1232	my $pid = fork;
		1233
		1234	return $pid
		1235	if !defined $pid or $pid;
		1236
		1237	%ENV = %{ $self->env };
		1238
		1239	exec @_;
		1240	urxvt::_exit 255;
		1241	}
		1242
945	=item $isset = $term->option ($optval[, $set])	1243	=item $isset = $term->option ($optval[, $set])
946		1244
947	Returns true if the option specified by C<$optval> is enabled, and	1245	Returns true if the option specified by C<$optval> is enabled, and
948	optionally change it. All option values are stored by name in the hash	1246	optionally change it. All option values are stored by name in the hash
949	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1247	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
950		1248
951	Here is a a likely non-exhaustive list of option names, please see the	1249	Here is a likely non-exhaustive list of option names, please see the
952	source file F</src/optinc.h> to see the actual list:	1250	source file F</src/optinc.h> to see the actual list:
953		1251
954	borderLess console cursorBlink cursorUnderline hold iconic insecure	1252	borderLess console cursorBlink cursorUnderline hold iconic insecure
955	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1253	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
956	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1254	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
957	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1255	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
958	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1256	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
959	tripleclickwords utmpInhibit visualBell	1257	transparent tripleclickwords utmpInhibit visualBell
960		1258
961	=item $value = $term->resource ($name[, $newval])	1259	=item $value = $term->resource ($name[, $newval])
962		1260
963	Returns the current resource value associated with a given name and	1261	Returns the current resource value associated with a given name and
964	optionally sets a new value. Setting values is most useful in the C<init>	1262	optionally sets a new value. Setting values is most useful in the C<init>
…		…
973	likely change).	1271	likely change).
974		1272
975	Please note that resource strings will currently only be freed when the	1273	Please note that resource strings will currently only be freed when the
976	terminal is destroyed, so changing options frequently will eat memory.	1274	terminal is destroyed, so changing options frequently will eat memory.
977		1275
978	Here is a a likely non-exhaustive list of resource names, not all of which	1276	Here is a likely non-exhaustive list of resource names, not all of which
979	are supported in every build, please see the source file F</src/rsinc.h>	1277	are supported in every build, please see the source file F</src/rsinc.h>
980	to see the actual list:	1278	to see the actual list:
981		1279
982	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1280	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
983	borderLess color cursorBlink cursorUnderline cutchars delete_key	1281	borderLess color cursorBlink cursorUnderline cutchars delete_key
984	display_name embed ext_bwidth fade font geometry hold iconName	1282	display_name embed ext_bwidth fade font geometry hold iconName
985	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1283	imFont imLocale inputMethod insecure int_bwidth intensityStyles
986	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1284	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
987	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1285	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
988	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1286	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
989	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1287	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
990	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1288	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
991	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1289	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
992	shade term_name title transparent transparent_all tripleclickwords	1290	secondaryScreen secondaryScroll selectstyle shade term_name title
993	utmpInhibit visualBell	1291	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1292	visualBell
994		1293
995	=cut	1294	=cut
996		1295
997	sub resource($$;$) {	1296	sub resource($$;$) {
998	my ($self, $name) = (shift, shift);	1297	my ($self, $name) = (shift, shift);
…		…
1172		1471
1173	Normally its not a good idea to use this function, as programs might be	1472	Normally its not a good idea to use this function, as programs might be
1174	confused by changes in cursor position or scrolling. Its useful inside a	1473	confused by changes in cursor position or scrolling. Its useful inside a
1175	C<on_add_lines> hook, though.	1474	C<on_add_lines> hook, though.
1176		1475
		1476	=item $term->scr_change_screen ($screen)
		1477
		1478	Switch to given screen - 0 primary, 1 secondary.
		1479
1177	=item $term->cmd_parse ($octets)	1480	=item $term->cmd_parse ($octets)
1178		1481
1179	Similar to C<scr_add_lines>, but the argument must be in the	1482	Similar to C<scr_add_lines>, but the argument must be in the
1180	locale-specific encoding of the terminal and can contain command sequences	1483	locale-specific encoding of the terminal and can contain command sequences
1181	(escape codes) that will be interpreted.	1484	(escape codes) that will be interpreted.
…		…
1191	Replaces the event mask of the pty watcher by the given event mask. Can	1494	Replaces the event mask of the pty watcher by the given event mask. Can
1192	be used to suppress input and output handling to the pty/tty. See the	1495	be used to suppress input and output handling to the pty/tty. See the
1193	description of C<< urxvt::timer->events >>. Make sure to always restore	1496	description of C<< urxvt::timer->events >>. Make sure to always restore
1194	the previous value.	1497	the previous value.
1195		1498
		1499	=item $fd = $term->pty_fd
		1500
		1501	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1502	is used.
		1503
1196	=item $windowid = $term->parent	1504	=item $windowid = $term->parent
1197		1505
1198	Return the window id of the toplevel window.	1506	Return the window id of the toplevel window.
1199		1507
1200	=item $windowid = $term->vt	1508	=item $windowid = $term->vt
…		…
1206	Adds the specified events to the vt event mask. Useful e.g. when you want	1514	Adds the specified events to the vt event mask. Useful e.g. when you want
1207	to receive pointer events all the times:	1515	to receive pointer events all the times:
1208		1516
1209	$term->vt_emask_add (urxvt::PointerMotionMask);	1517	$term->vt_emask_add (urxvt::PointerMotionMask);
1210		1518
		1519	=item $term->focus_in
		1520
		1521	=item $term->focus_out
		1522
		1523	=item $term->key_press ($state, $keycode[, $time])
		1524
		1525	=item $term->key_release ($state, $keycode[, $time])
		1526
		1527	Deliver various fake events to to terminal.
		1528
1211	=item $window_width = $term->width	1529	=item $window_width = $term->width
1212		1530
1213	=item $window_height = $term->height	1531	=item $window_height = $term->height
1214		1532
1215	=item $font_width = $term->fwidth	1533	=item $font_width = $term->fwidth
…		…
1245	=item $env = $term->env	1563	=item $env = $term->env
1246		1564
1247	Returns a copy of the environment in effect for the terminal as a hashref	1565	Returns a copy of the environment in effect for the terminal as a hashref
1248	similar to C<\%ENV>.	1566	similar to C<\%ENV>.
1249		1567
		1568	=item @envv = $term->envv
		1569
		1570	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1571
		1572	=item @argv = $term->argv
		1573
		1574	Return the argument vector as this terminal, similar to @ARGV, but
		1575	includes the program name as first element.
		1576
1250	=cut	1577	=cut
1251		1578
1252	sub env {	1579	sub env {
1253	if (my $env = $_[0]->_env) {
1254	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1580	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1255	} else {
1256	+{ %ENV }
1257	}
1258	}	1581	}
1259		1582
1260	=item $modifiermask = $term->ModLevel3Mask	1583	=item $modifiermask = $term->ModLevel3Mask
1261		1584
1262	=item $modifiermask = $term->ModMetaMask	1585	=item $modifiermask = $term->ModMetaMask
1263		1586
1264	=item $modifiermask = $term->ModNumLockMask	1587	=item $modifiermask = $term->ModNumLockMask
1265		1588
1266	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1589	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1267	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1590	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1591
		1592	=item $screen = $term->current_screen
		1593
		1594	Returns the currently displayed screen (0 primary, 1 secondary).
		1595
		1596	=item $cursor_is_hidden = $term->hidden_cursor
		1597
		1598	Returns whether the cursor is currently hidden or not.
1268		1599
1269	=item $view_start = $term->view_start ([$newvalue])	1600	=item $view_start = $term->view_start ([$newvalue])
1270		1601
1271	Returns the row number of the topmost displayed line. Maximum value is	1602	Returns the row number of the topmost displayed line. Maximum value is
1272	C<0>, which displays the normal terminal contents. Lower values scroll	1603	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1292	line, starting at column C<$start_col> (default C<0>), which is useful	1623	line, starting at column C<$start_col> (default C<0>), which is useful
1293	to replace only parts of a line. The font index in the rendition will	1624	to replace only parts of a line. The font index in the rendition will
1294	automatically be updated.	1625	automatically be updated.
1295		1626
1296	C<$text> is in a special encoding: tabs and wide characters that use more	1627	C<$text> is in a special encoding: tabs and wide characters that use more
1297	than one cell when displayed are padded with urxvt::NOCHAR characters	1628	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1298	(C<chr 65535>). Characters with combining characters and other characters	1629	characters. Characters with combining characters and other characters that
1299	that do not fit into the normal tetx encoding will be replaced with	1630	do not fit into the normal tetx encoding will be replaced with characters
1300	characters in the private use area.	1631	in the private use area.
1301		1632
1302	You have to obey this encoding when changing text. The advantage is	1633	You have to obey this encoding when changing text. The advantage is
1303	that C<substr> and similar functions work on screen cells and not on	1634	that C<substr> and similar functions work on screen cells and not on
1304	characters.	1635	characters.
1305		1636
…		…
1449	where one character corresponds to one screen cell. See	1780	where one character corresponds to one screen cell. See
1450	C<< $term->ROW_t >> for details.	1781	C<< $term->ROW_t >> for details.
1451		1782
1452	=item $string = $term->special_decode $text	1783	=item $string = $term->special_decode $text
1453		1784
1454	Converts rxvt-unicodes text reprsentation into a perl string. See	1785	Converts rxvt-unicodes text representation into a perl string. See
1455	C<< $term->ROW_t >> for details.	1786	C<< $term->ROW_t >> for details.
1456		1787
1457	=item $success = $term->grab_button ($button, $modifiermask)	1788	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1458		1789
		1790	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1791
1459	Registers a synchronous button grab. See the XGrabButton manpage.	1792	Register/unregister a synchronous button grab. See the XGrabButton
		1793	manpage.
1460		1794
1461	=item $success = $term->grab ($eventtime[, $sync])	1795	=item $success = $term->grab ($eventtime[, $sync])
1462		1796
1463	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1797	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1464	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1798	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1465		1799
1466	=item $term->allow_events_async	1800	=item $term->allow_events_async
1467		1801
1468	Calls XAllowEvents with AsyncBoth for the most recent grab.	1802	Calls XAllowEvents with AsyncBoth for the most recent grab.
1469		1803
…		…
1479	=item $term->ungrab	1813	=item $term->ungrab
1480		1814
1481	Calls XUngrab for the most recent grab. Is called automatically on	1815	Calls XUngrab for the most recent grab. Is called automatically on
1482	evaluation errors, as it is better to lose the grab in the error case as	1816	evaluation errors, as it is better to lose the grab in the error case as
1483	the session.	1817	the session.
		1818
		1819	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1820
		1821	=item $atom_name = $term->XGetAtomName ($atom)
		1822
		1823	=item @atoms = $term->XListProperties ($window)
		1824
		1825	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1826
		1827	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1828
		1829	=item $term->XDeleteProperty ($window, $property)
		1830
		1831	=item $window = $term->DefaultRootWindow
		1832
		1833	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1834
		1835	=item $term->XMapWindow ($window)
		1836
		1837	=item $term->XUnmapWindow ($window)
		1838
		1839	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1840
		1841	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1842
		1843	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1844
		1845	Various X or X-related functions. The C<$term> object only serves as
		1846	the source of the display, otherwise those functions map more-or-less
		1847	directory onto the X functions of the same name.
1484		1848
1485	=back	1849	=back
1486		1850
1487	=cut	1851	=cut
1488		1852
…		…
1552	my ($self, $text, $cb) = @_;	1916	my ($self, $text, $cb) = @_;
1553		1917
1554	$self->add_item ({ type => "button", text => $text, activate => $cb});	1918	$self->add_item ({ type => "button", text => $text, activate => $cb});
1555	}	1919	}
1556		1920
1557	=item $popup->add_toggle ($text, $cb, $initial_value)	1921	=item $popup->add_toggle ($text, $initial_value, $cb)
1558		1922
1559	Adds a toggle/checkbox item to the popup. Teh callback gets called	1923	Adds a toggle/checkbox item to the popup. The callback gets called
1560	whenever it gets toggled, with a boolean indicating its value as its first	1924	whenever it gets toggled, with a boolean indicating its new value as its
1561	argument.	1925	first argument.
1562		1926
1563	=cut	1927	=cut
1564		1928
1565	sub add_toggle {	1929	sub add_toggle {
1566	my ($self, $text, $cb, $value) = @_;	1930	my ($self, $text, $value, $cb) = @_;
1567		1931
1568	my $item; $item = {	1932	my $item; $item = {
1569	type => "button",	1933	type => "button",
1570	text => " $text",	1934	text => " $text",
1571	value => $value,	1935	value => $value,
…		…
1590	my $env = $self->{term}->env;	1954	my $env = $self->{term}->env;
1591	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1955	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1592	delete $env->{LC_ALL};	1956	delete $env->{LC_ALL};
1593	$env->{LC_CTYPE} = $self->{term}->locale;	1957	$env->{LC_CTYPE} = $self->{term}->locale;
1594		1958
1595	urxvt::term->new ($env, $self->{term}->resource ("name"),	1959	urxvt::term->new ($env, "popup",
1596	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1960	"--perl-lib" => "", "--perl-ext-common" => "",
		1961	"-pty-fd" => -1, "-sl" => 0,
		1962	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1597	"--transient-for" => $self->{term}->parent,	1963	"--transient-for" => $self->{term}->parent,
1598	"-display" => $self->{term}->display_id,	1964	"-display" => $self->{term}->display_id,
1599	"-pe" => "urxvt-popup")	1965	"-pe" => "urxvt-popup")
1600	or die "unable to create popup window\n";	1966	or die "unable to create popup window\n";
1601	}	1967	}
…		…
1606	delete $self->{term}{_destroy}{$self};	1972	delete $self->{term}{_destroy}{$self};
1607	$self->{term}->ungrab;	1973	$self->{term}->ungrab;
1608	}	1974	}
1609		1975
1610	=back	1976	=back
		1977
		1978	=cut
		1979
		1980	package urxvt::watcher;
1611		1981
1612	=head2 The C<urxvt::timer> Class	1982	=head2 The C<urxvt::timer> Class
1613		1983
1614	This class implements timer watchers/events. Time is represented as a	1984	This class implements timer watchers/events. Time is represented as a
1615	fractional number of seconds since the epoch. Example:	1985	fractional number of seconds since the epoch. Example:
…		…
1619	->new	1989	->new
1620	->interval (1)	1990	->interval (1)
1621	->cb (sub {	1991	->cb (sub {
1622	$term->{overlay}->set (0, 0,	1992	$term->{overlay}->set (0, 0,
1623	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1993	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1624	});	1994	});
1625		1995
1626	=over 4	1996	=over 4
1627		1997
1628	=item $timer = new urxvt::timer	1998	=item $timer = new urxvt::timer
1629		1999
…		…
1653	Start the timer.	2023	Start the timer.
1654		2024
1655	=item $timer = $timer->start ($tstamp)	2025	=item $timer = $timer->start ($tstamp)
1656		2026
1657	Set the event trigger time to C<$tstamp> and start the timer.	2027	Set the event trigger time to C<$tstamp> and start the timer.
		2028
		2029	=item $timer = $timer->after ($delay)
		2030
		2031	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1658		2032
1659	=item $timer = $timer->stop	2033	=item $timer = $timer->stop
1660		2034
1661	Stop the timer.	2035	Stop the timer.
1662		2036
…		…
1668		2042
1669	$term->{socket} = ...	2043	$term->{socket} = ...
1670	$term->{iow} = urxvt::iow	2044	$term->{iow} = urxvt::iow
1671	->new	2045	->new
1672	->fd (fileno $term->{socket})	2046	->fd (fileno $term->{socket})
1673	->events (urxvt::EVENT_READ)	2047	->events (urxvt::EV_READ)
1674	->start	2048	->start
1675	->cb (sub {	2049	->cb (sub {
1676	my ($iow, $revents) = @_;	2050	my ($iow, $revents) = @_;
1677	# $revents must be 1 here, no need to check	2051	# $revents must be 1 here, no need to check
1678	sysread $term->{socket}, my $buf, 8192	2052	sysread $term->{socket}, my $buf, 8192
…		…
1691	Set the callback to be called when io events are triggered. C<$reventmask>	2065	Set the callback to be called when io events are triggered. C<$reventmask>
1692	is a bitset as described in the C<events> method.	2066	is a bitset as described in the C<events> method.
1693		2067
1694	=item $iow = $iow->fd ($fd)	2068	=item $iow = $iow->fd ($fd)
1695		2069
1696	Set the filedescriptor (not handle) to watch.	2070	Set the file descriptor (not handle) to watch.
1697		2071
1698	=item $iow = $iow->events ($eventmask)	2072	=item $iow = $iow->events ($eventmask)
1699		2073
1700	Set the event mask to watch. The only allowed values are	2074	Set the event mask to watch. The only allowed values are
1701	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2075	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1702	together, or C<urxvt::EVENT_NONE>.	2076	together, or C<urxvt::EV_NONE>.
1703		2077
1704	=item $iow = $iow->start	2078	=item $iow = $iow->start
1705		2079
1706	Start watching for requested events on the given handle.	2080	Start watching for requested events on the given handle.
1707		2081
1708	=item $iow = $iow->stop	2082	=item $iow = $iow->stop
1709		2083
1710	Stop watching for events on the given filehandle.	2084	Stop watching for events on the given file handle.
		2085
		2086	=back
		2087
		2088	=head2 The C<urxvt::iw> Class
		2089
		2090	This class implements idle watchers, that get called automatically when
		2091	the process is idle. They should return as fast as possible, after doing
		2092	some useful work.
		2093
		2094	=over 4
		2095
		2096	=item $iw = new urxvt::iw
		2097
		2098	Create a new idle watcher object in stopped state.
		2099
		2100	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2101
		2102	Set the callback to be called when the watcher triggers.
		2103
		2104	=item $timer = $timer->start
		2105
		2106	Start the watcher.
		2107
		2108	=item $timer = $timer->stop
		2109
		2110	Stop the watcher.
		2111
		2112	=back
		2113
		2114	=head2 The C<urxvt::pw> Class
		2115
		2116	This class implements process watchers. They create an event whenever a
		2117	process exits, after which they stop automatically.
		2118
		2119	my $pid = fork;
		2120	...
		2121	$term->{pw} = urxvt::pw
		2122	->new
		2123	->start ($pid)
		2124	->cb (sub {
		2125	my ($pw, $exit_status) = @_;
		2126	...
		2127	});
		2128
		2129	=over 4
		2130
		2131	=item $pw = new urxvt::pw
		2132
		2133	Create a new process watcher in stopped state.
		2134
		2135	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2136
		2137	Set the callback to be called when the timer triggers.
		2138
		2139	=item $pw = $timer->start ($pid)
		2140
		2141	Tells the watcher to start watching for process C<$pid>.
		2142
		2143	=item $pw = $pw->stop
		2144
		2145	Stop the watcher.
1711		2146
1712	=back	2147	=back
1713		2148
1714	=head1 ENVIRONMENT	2149	=head1 ENVIRONMENT
1715		2150
…		…
1724		2159
1725	=item >= 3 - script loading and management	2160	=item >= 3 - script loading and management
1726		2161
1727	=item >=10 - all called hooks	2162	=item >=10 - all called hooks
1728		2163
1729	=item >=11 - hook reutrn values	2164	=item >=11 - hook return values
1730		2165
1731	=back	2166	=back
1732		2167
1733	=head1 AUTHOR	2168	=head1 AUTHOR
1734		2169
…		…
1736	http://software.schmorp.de/pkg/rxvt-unicode	2171	http://software.schmorp.de/pkg/rxvt-unicode
1737		2172
1738	=cut	2173	=cut
1739		2174
1740	1	2175	1
		2176
		2177	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC vs. Revision 1.160 by ayin, Fri Nov 16 10:06:40 2007 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC vs.
Revision 1.160 by ayin, Fri Nov 16 10:06:40 2007 UTC