[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.154 by root, Sat Jun 2 06:43:02 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,automove-background,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	It's 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	It's 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 be" => 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)
…		…
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.
126		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.
		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.
131		194
…		…
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	Example configuration:
		265
		266	URxvt.perl-ext: default,matcher
		267	URxvt.urlLauncher: sensible-browser
		268	URxvt.keysym.C-Delete: perl:matcher
		269	URxvt.matcher.button: 1
		270	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		271	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		272	URxvt.matcher.launcher.2: gvim +$2 $1
		273
		274	=item xim-onthespot
		275
		276	This (experimental) perl extension implements OnTheSpot editing. It does
		277	not work perfectly, and some input methods don't seem to work well with
		278	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		279	kinput2.
		280
		281	You enable it by specifying this extension and a preedit style of
		282	C<OnTheSpot>, i.e.:
		283
		284	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		285
		286	=item kuake<hotkey>
		287
		288	A very primitive quake-console-like extension. It was inspired by a
		289	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		290	user presses a global accelerator key (by default C<F10>), the terminal
		291	will show or hide itself. Another press of the accelerator key will hide
		292	or show it again.
		293
		294	Initially, the window will not be shown when using this extension.
		295
		296	This is useful if you need a single terminal thats not using any desktop
		297	space most of the time but is quickly available at the press of a key.
		298
		299	The accelerator key is grabbed regardless of any modifiers, so this
		300	extension will actually grab a physical key just for this function.
		301
		302	If you want a quake-like animation, tell your window manager to do so
		303	(fvwm can do it).
168		304
169	=item automove-background	305	=item automove-background
170		306
171	This is basically a one-line extension that dynamically changes the background pixmap offset	307	This is basically a very small extension that dynamically changes the
172	to the window position, in effect creating the same effect as pseudo transparency with	308	background pixmap offset to the window position, in effect creating the
173	a custom pixmap. No scaling is supported in this mode. Exmaple:	309	same effect as pseudo transparency with a custom pixmap. No scaling is
		310	supported in this mode. Example:
174		311
175	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	312	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
176		313
		314	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
		315	shows how this extension can be used to implement an automatically blurred
		316	transparent background.
		317
177	=item block-graphics-to-ascii	318	=item block-graphics-to-ascii
178		319
179	A not very useful example of filtering all text output to the terminal,	320	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	321	by replacing all line-drawing characters (U+2500 .. U+259F) by a
181	similar-looking ascii character.	322	similar-looking ascii character.
182		323
183	=item digital-clock	324	=item digital-clock
184		325
185	Displays a digital clock using the built-in overlay.	326	Displays a digital clock using the built-in overlay.
186		327
187	=item example-refresh-hooks	328	=item remote-clipboard
188		329
189	Displays a very simple digital clock in the upper right corner of the	330	Somewhat of a misnomer, this extension adds two menu entries to the
190	window. Illustrates overwriting the refresh callbacks to create your own	331	selection popup that allows one ti run external commands to store the
191	overlays or changes.	332	selection somewhere and fetch it again.
		333
		334	We use it to implement a "distributed selection mechanism", which just
		335	means that one command uploads the file to a remote server, and another
		336	reads it.
		337
		338	The commands can be set using the C<URxvt.remote-selection.store> and
		339	C<URxvt.remote-selection.fetch> resources. The first should read the
		340	selection to store from STDIN (always in UTF-8), the second should provide
		341	the selection data on STDOUT (also in UTF-8).
		342
		343	The defaults (which are likely useless to you) use rsh and cat:
		344
		345	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		346	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
192		347
193	=item selection-pastebin	348	=item selection-pastebin
194		349
195	This is a little rarely useful extension that Uploads the selection as	350	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	351	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	371	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	372	in the C<selection-pastebin-url> resource (again, the % is the placeholder
218	for the filename):	373	for the filename):
219		374
220	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	375	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		376
		377	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		378	the double C</> characters as comment start. Use C<\057\057> instead,
		379	which works regardless of wether xrdb is used to parse the resource file
		380	or not.
		381
		382	=item example-refresh-hooks
		383
		384	Displays a very simple digital clock in the upper right corner of the
		385	window. Illustrates overwriting the refresh callbacks to create your own
		386	overlays or changes.
221		387
222	=back	388	=back
223		389
224	=head1 API DOCUMENTATION	390	=head1 API DOCUMENTATION
225		391
…		…
259		425
260	=back	426	=back
261		427
262	=head2 Extension Objects	428	=head2 Extension Objects
263		429
264	Very perl extension is a perl class. A separate perl object is created	430	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	431	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	432	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	433	their C<$self> object without having to think about clashes with other
		434	extensions or other terminals, with the exception of methods and members
268	begin with an underscore character C<_>: these are reserved for internal	435	that begin with an underscore character C<_>: these are reserved for
269	use.	436	internal use.
270		437
271	Although it isn't a C<urxvt::term> object, you can call all methods of the	438	Although it isn't a C<urxvt::term> object, you can call all methods of the
272	C<urxvt::term> class on this object.	439	C<urxvt::term> class on this object.
273		440
274	It has the following methods and data members:	441	It has the following methods and data members:
…		…
295	=head2 Hooks	462	=head2 Hooks
296		463
297	The following subroutines can be declared in extension files, and will be	464	The following subroutines can be declared in extension files, and will be
298	called whenever the relevant event happens.	465	called whenever the relevant event happens.
299		466
300	The first argument passed to them is an extension oject as described in	467	The first argument passed to them is an extension object as described in
301	the in the C<Extension Objects> section.	468	the in the C<Extension Objects> section.
302		469
303	B<All> of these hooks must return a boolean value. If it is true, then the	470	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	471	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.	472	relevant action might not be carried out by the C++ code.
306		473
307	I<< When in doubt, return a false value (preferably C<()>). >>	474	I<< When in doubt, return a false value (preferably C<()>). >>
308		475
309	=over 4	476	=over 4
310		477
311	=item on_init $term	478	=item on_init $term
312		479
313	Called after a new terminal object has been initialized, but before	480	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	481	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	482	call or deliver senseless data, as terminal size and other characteristics
316	have not yet been determined. You can safely query and change resources,	483	have not yet been determined. You can safely query and change resources
317	though.	484	and options, though. For many purposes the C<on_start> hook is a better
		485	place.
		486
		487	=item on_start $term
		488
		489	Called at the very end of initialisation of a new terminal, just before
		490	trying to map (display) the toplevel and returning to the main loop.
		491
		492	=item on_destroy $term
		493
		494	Called whenever something tries to destroy terminal, when the terminal is
		495	still fully functional (not for long, though).
318		496
319	=item on_reset $term	497	=item on_reset $term
320		498
321	Called after the screen is "reset" for any reason, such as resizing or	499	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	500	control sequences. Here is where you can react on changes to size-related
323	variables.	501	variables.
324		502
325	=item on_start $term	503	=item on_child_start $term, $pid
326		504
327	Called at the very end of initialisation of a new terminal, just before	505	Called just after the child process has been C<fork>ed.
328	returning to the mainloop.	506
		507	=item on_child_exit $term, $status
		508
		509	Called just after the child process has exited. C<$status> is the status
		510	from C<waitpid>.
329		511
330	=item on_sel_make $term, $eventtime	512	=item on_sel_make $term, $eventtime
331		513
332	Called whenever a selection has been made by the user, but before the	514	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	515	selection text is copied, so changes to the beginning, end or type of the
…		…
340		522
341	Called whenever a selection has been copied, but before the selection is	523	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	524	requested from the server. The selection text can be queried and changed
343	by calling C<< $term->selection >>.	525	by calling C<< $term->selection >>.
344		526
345	Returning a true value aborts selection grabbing. It will still be hilighted.	527	Returning a true value aborts selection grabbing. It will still be highlighted.
346		528
347	=item on_sel_extend $term	529	=item on_sel_extend $term
348		530
349	Called whenever the user tries to extend the selection (e.g. with a double	531	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	532	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	533	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	534	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	535	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.	536	supposed to enlarge the selection more and more, if possible.
355		537
356	See the F<selection> example extension.	538	See the F<selection> example extension.
357		539
358	=item on_view_change $term, $offset	540	=item on_view_change $term, $offset
359		541
360	Called whenever the view offset changes, i..e the user or program	542	Called whenever the view offset changes, i.e. the user or program
361	scrolls. Offset C<0> means display the normal terminal, positive values	543	scrolls. Offset C<0> means display the normal terminal, positive values
362	show this many lines of scrollback.	544	show this many lines of scrollback.
363		545
364	=item on_scroll_back $term, $lines, $saved	546	=item on_scroll_back $term, $lines, $saved
365		547
…		…
369		551
370	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	552	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	553	$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.	554	number of lines that will be in the scrollback buffer.
373		555
		556	=item on_osc_seq $term, $op, $args
		557
		558	Called on every OSC sequence and can be used to suppress it or modify its
		559	behaviour. The default should be to return an empty list. A true value
		560	suppresses execution of the request completely. Make sure you don't get
		561	confused by recursive invocations when you output an osc sequence within
		562	this callback.
		563
		564	C<on_osc_seq_perl> should be used for new behaviour.
		565
374	=item on_osc_seq $term, $string	566	=item on_osc_seq_perl $term, $string
375		567
376	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	568	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
377	operating system command) is processed. Cursor position and other state	569	operating system command) is processed. Cursor position and other state
378	information is up-to-date when this happens. For interoperability, the	570	information is up-to-date when this happens. For interoperability, the
379	string should start with the extension name and a colon, to distinguish	571	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	572	it from commands for other extensions, and this might be enforced in the
381	future.	573	future.
382		574
383	Be careful not ever to trust (in a security sense) the data you receive,	575	Be careful not ever to trust (in a security sense) the data you receive,
384	as its source can not easily be controleld (e-mail content, messages from	576	as its source can not easily be controlled (e-mail content, messages from
385	other users on the same system etc.).	577	other users on the same system etc.).
386		578
387	=item on_add_lines $term, $string	579	=item on_add_lines $term, $string
388		580
389	Called whenever text is about to be output, with the text as argument. You	581	Called whenever text is about to be output, with the text as argument. You
…		…
420		612
421	=item on_refresh_end $term	613	=item on_refresh_end $term
422		614
423	Called just after the screen gets redrawn. See C<on_refresh_begin>.	615	Called just after the screen gets redrawn. See C<on_refresh_begin>.
424		616
425	=item on_keyboard_command $term, $string	617	=item on_user_command $term, $string
426		618
427	Called whenever the user presses a key combination that has a	619	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>	620	a C<perl:string> action bound to a key, see description of the B<keysym>
429	resource in the @@RXVT_NAME@@(1) manpage).	621	resource in the @@RXVT_NAME@@(1) manpage).
		622
		623	The event is simply the action string. This interface is assumed to change
		624	slightly in the future.
		625
		626	=item on_resize_all_windows $tern, $new_width, $new_height
		627
		628	Called just after the new window size has been calculated, but before
		629	windows are actually being resized or hints are being set. If this hook
		630	returns TRUE, setting of the window hints is being skipped.
430		631
431	=item on_x_event $term, $event	632	=item on_x_event $term, $event
432		633
433	Called on every X event received on the vt window (and possibly other	634	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	635	windows). Should only be used as a last resort. Most event structure
435	members are not passed.	636	members are not passed.
436		637
		638	=item on_root_event $term, $event
		639
		640	Like C<on_x_event>, but is called for events on the root window.
		641
437	=item on_focus_in $term	642	=item on_focus_in $term
438		643
439	Called whenever the window gets the keyboard focus, before rxvt-unicode	644	Called whenever the window gets the keyboard focus, before rxvt-unicode
440	does focus in processing.	645	does focus in processing.
441		646
442	=item on_focus_out $term	647	=item on_focus_out $term
443		648
444	Called wheneever the window loses keyboard focus, before rxvt-unicode does	649	Called whenever the window loses keyboard focus, before rxvt-unicode does
445	focus out processing.	650	focus out processing.
446		651
447	=item on_configure_notify $term, $event	652	=item on_configure_notify $term, $event
		653
		654	=item on_property_notify $term, $event
448		655
449	=item on_key_press $term, $event, $keysym, $octets	656	=item on_key_press $term, $event, $keysym, $octets
450		657
451	=item on_key_release $term, $event, $keysym	658	=item on_key_release $term, $event, $keysym
452		659
…		…
462		669
463	Called whenever the corresponding X event is received for the terminal If	670	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.	671	the hook returns true, then the even will be ignored by rxvt-unicode.
465		672
466	The event is a hash with most values as named by Xlib (see the XEvent	673	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	674	manpage), with the additional members C<row> and C<col>, which are the
468	and column under the mouse cursor.	675	(real, not screen-based) row and column under the mouse cursor.
469		676
470	C<on_key_press> additionally receives the string rxvt-unicode would	677	C<on_key_press> additionally receives the string rxvt-unicode would
471	output, if any, in locale-specific encoding.	678	output, if any, in locale-specific encoding.
472		679
473	subwindow.	680	subwindow.
		681
		682	=item on_client_message $term, $event
		683
		684	=item on_wm_protocols $term, $event
		685
		686	=item on_wm_delete_window $term, $event
		687
		688	Called when various types of ClientMessage events are received (all with
		689	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
474		690
475	=back	691	=back
476		692
477	=cut	693	=cut
478		694
…		…
484	use Scalar::Util ();	700	use Scalar::Util ();
485	use List::Util ();	701	use List::Util ();
486		702
487	our $VERSION = 1;	703	our $VERSION = 1;
488	our $TERM;	704	our $TERM;
		705	our @TERM_INIT;
		706	our @TERM_EXT;
489	our @HOOKNAME;	707	our @HOOKNAME;
490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	708	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491	our %OPTION;	709	our %OPTION;
492		710
493	our $LIBDIR;	711	our $LIBDIR;
494	our $RESNAME;	712	our $RESNAME;
495	our $RESCLASS;	713	our $RESCLASS;
496	our $RXVTNAME;	714	our $RXVTNAME;
497		715
		716	our $NOCHAR = chr 0xffff;
		717
498	=head2 Variables in the C<urxvt> Package	718	=head2 Variables in the C<urxvt> Package
499		719
500	=over 4	720	=over 4
501		721
502	=item $urxvt::LIBDIR	722	=item $urxvt::LIBDIR
…		…
514		734
515	=item $urxvt::TERM	735	=item $urxvt::TERM
516		736
517	The current terminal. This variable stores the current C<urxvt::term>	737	The current terminal. This variable stores the current C<urxvt::term>
518	object, whenever a callback/hook is executing.	738	object, whenever a callback/hook is executing.
		739
		740	=item @urxvt::TERM_INIT
		741
		742	All code references in this array will be called as methods of the next newly
		743	created C<urxvt::term> object (during the C<on_init> phase). The array
		744	gets cleared before the code references that were in it are being executed,
		745	so references can push themselves onto it again if they so desire.
		746
		747	This complements to the perl-eval command line option, but gets executed
		748	first.
		749
		750	=item @urxvt::TERM_EXT
		751
		752	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		753	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		754	but before other extensions. Gets cleared just like C<@TERM_INIT>.
519		755
520	=back	756	=back
521		757
522	=head2 Functions in the C<urxvt> Package	758	=head2 Functions in the C<urxvt> Package
523		759
…		…
537		773
538	Using this function has the advantage that its output ends up in the	774	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.	775	correct place, e.g. on stderr of the connecting urxvtc client.
540		776
541	Messages have a size limit of 1023 bytes currently.	777	Messages have a size limit of 1023 bytes currently.
		778
		779	=item @terms = urxvt::termlist
		780
		781	Returns all urxvt::term objects that exist in this process, regardless of
		782	whether they are started, being destroyed etc., so be careful. Only term
		783	objects that have perl extensions attached will be returned (because there
		784	is no urxvt::term objet associated with others).
542		785
543	=item $time = urxvt::NOW	786	=item $time = urxvt::NOW
544		787
545	Returns the "current time" (as per the event loop).	788	Returns the "current time" (as per the event loop).
546		789
…		…
604	Return the foreground/background colour index, respectively.	847	Return the foreground/background colour index, respectively.
605		848
606	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	849	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
607		850
608	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	851	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		852
		853	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
609		854
610	Replace the foreground/background colour in the rendition mask with the	855	Replace the foreground/background colour in the rendition mask with the
611	specified one.	856	specified one.
612		857
613	=item $value = urxvt::GET_CUSTOM $rend	858	=item $value = urxvt::GET_CUSTOM $rend
…		…
632	unless $msg =~ /\n$/;	877	unless $msg =~ /\n$/;
633	urxvt::warn ($msg);	878	urxvt::warn ($msg);
634	};	879	};
635	}	880	}
636		881
		882	no warnings 'utf8';
		883
637	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	884	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
638		885
639	sub verbose {	886	sub verbose {
640	my ($level, $msg) = @_;	887	my ($level, $msg) = @_;
641	warn "$msg\n" if $level <= $verbosity;	888	warn "$msg\n" if $level <= $verbosity;
…		…
644	my %extension_pkg;	891	my %extension_pkg;
645		892
646	# load a single script into its own package, once only	893	# load a single script into its own package, once only
647	sub extension_package($) {	894	sub extension_package($) {
648	my ($path) = @_;	895	my ($path) = @_;
649
650	no strict 'refs';
651		896
652	$extension_pkg{$path} \|\|= do {	897	$extension_pkg{$path} \|\|= do {
653	$path =~ /([^\/\\]+)$/;	898	$path =~ /([^\/\\]+)$/;
654	my $pkg = $1;	899	my $pkg = $1;
655	$pkg =~ s/[^[:word:]]/_/g;	900	$pkg =~ s/[^[:word:]]/_/g;
…		…
658	verbose 3, "loading extension '$path' into package '$pkg'";	903	verbose 3, "loading extension '$path' into package '$pkg'";
659		904
660	open my $fh, "<:raw", $path	905	open my $fh, "<:raw", $path
661	or die "$path: $!";	906	or die "$path: $!";
662		907
663	@{"$pkg\::ISA"} = urxvt::term::extension::;
664
665	my $source =	908	my $source =
666	"package $pkg; use strict; use utf8;\n"	909	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
667	. "#line 1 \"$path\"\n{\n"	910	. "#line 1 \"$path\"\n{\n"
668	. (do { local $/; <$fh> })	911	. (do { local $/; <$fh> })
669	. "\n};\n1";	912	. "\n};\n1";
670		913
671	eval $source	914	eval $source
…		…
685	if ($htype == 0) { # INIT	928	if ($htype == 0) { # INIT
686	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	929	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
687		930
688	my %ext_arg;	931	my %ext_arg;
689		932
		933	{
		934	my @init = @TERM_INIT;
		935	@TERM_INIT = ();
		936	$_->($TERM) for @init;
		937	my @pkg = @TERM_EXT;
		938	@TERM_EXT = ();
		939	$TERM->register_package ($_) for @pkg;
		940	}
		941
690	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	942	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
691	if ($_ eq "default") {	943	if ($_ eq "default") {
692	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	944	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
693	} elsif (/^-(.*)$/) {	945	} elsif (/^-(.*)$/) {
694	delete $ext_arg{$1};	946	delete $ext_arg{$1};
695	} elsif (/^([^<]+)<(.*)>$/) {	947	} elsif (/^([^<]+)<(.*)>$/) {
696	push @{ $ext_arg{$1} }, $2;	948	push @{ $ext_arg{$1} }, $2;
697	} else {	949	} else {
698	$ext_arg{$_} \|\|= [];	950	$ext_arg{$_} \|\|= [];
699	}	951	}
700	}	952	}
701		953
702	while (my ($ext, $argv) = each %ext_arg) {	954	for my $ext (sort keys %ext_arg) {
703	my @files = grep -f $_, map "$_/$ext", @dirs;	955	my @files = grep -f $_, map "$_/$ext", @dirs;
704		956
705	if (@files) {	957	if (@files) {
706	$TERM->register_package (extension_package $files[0], $argv);	958	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
707	} else {	959	} else {
708	warn "perl extension '$ext' not found in perl library search path\n";	960	warn "perl extension '$ext' not found in perl library search path\n";
709	}	961	}
710	}	962	}
711		963
…		…
717		969
718	if (my $cb = $TERM->{_hook}[$htype]) {	970	if (my $cb = $TERM->{_hook}[$htype]) {
719	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	971	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
720	if $verbosity >= 10;	972	if $verbosity >= 10;
721		973
722	keys %$cb;	974	for my $pkg (keys %$cb) {
723
724	while (my ($pkg, $cb) = each %$cb) {
725	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	975	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
726	and last;	976	$retval \|\|= $retval_;
727		977
728	if ($@) {	978	if ($@) {
729	$TERM->ungrab; # better to lose the grab than the session	979	$TERM->ungrab; # better to lose the grab than the session
730	warn $@;	980	warn $@;
731	}	981	}
…		…
744	}	994	}
745		995
746	$retval	996	$retval
747	}	997	}
748		998
749	sub exec_async(@) {	999	sub SET_COLOR($$$) {
750	my $pid = fork;	1000	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1001	}
751		1002
752	return	1003	sub rend2mask {
753	if !defined $pid or $pid;	1004	no strict 'refs';
754		1005	my ($str, $mask) = (@_, 0);
755	%ENV = %{ $TERM->env };	1006	my %color = ( fg => undef, bg => undef );
756		1007	my @failed;
757	exec @_;	1008	for my $spec ( split /\s+/, $str ) {
758	_exit 255;	1009	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1010	$color{lc($1)} = $2;
		1011	} else {
		1012	my $neg = $spec =~ s/^[-^]//;
		1013	unless ( exists &{"RS_$spec"} ) {
		1014	push @failed, $spec;
		1015	next;
		1016	}
		1017	my $cur = &{"RS_$spec"};
		1018	if ( $neg ) {
		1019	$mask &= ~$cur;
		1020	} else {
		1021	$mask \|= $cur;
		1022	}
		1023	}
		1024	}
		1025	($mask, @color{qw(fg bg)}, \@failed)
759	}	1026	}
760		1027
761	# urxvt::term::extension	1028	# urxvt::term::extension
762		1029
763	package urxvt::term::extension;	1030	package urxvt::term::extension;
…		…
876	sub DESTROY {	1143	sub DESTROY {
877	$_[0][1]->stop;	1144	$_[0][1]->stop;
878	}	1145	}
879		1146
880	sub condvar {	1147	sub condvar {
881	bless \my $flag, urxvt::anyevent::condvar::	1148	bless \my $flag, urxvt::anyevent::
882	}	1149	}
883		1150
884	sub urxvt::anyevent::condvar::broadcast {	1151	sub broadcast {
885	${$_[0]}++;	1152	${$_[0]}++;
886	}	1153	}
887		1154
888	sub urxvt::anyevent::condvar::wait {	1155	sub wait {
889	unless (${$_[0]}) {	1156	unless (${$_[0]}) {
890	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1157	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
891	}	1158	}
		1159	}
		1160
		1161	sub one_event {
		1162	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
892	}	1163	}
893		1164
894	package urxvt::term;	1165	package urxvt::term;
895		1166
896	=head2 The C<urxvt::term> Class	1167	=head2 The C<urxvt::term> Class
…		…
901		1172
902	# find on_xxx subs in the package and register them	1173	# find on_xxx subs in the package and register them
903	# as hooks	1174	# as hooks
904	sub register_package {	1175	sub register_package {
905	my ($self, $pkg, $argv) = @_;	1176	my ($self, $pkg, $argv) = @_;
		1177
		1178	no strict 'refs';
		1179
		1180	urxvt::verbose 6, "register package $pkg to $self";
		1181
		1182	@{"$pkg\::ISA"} = urxvt::term::extension::;
906		1183
907	my $proxy = bless {	1184	my $proxy = bless {
908	_pkg => $pkg,	1185	_pkg => $pkg,
909	argv => $argv,	1186	argv => $argv,
910	}, $pkg;	1187	}, $pkg;
…		…
926	hash which defines the environment of the new terminal.	1203	hash which defines the environment of the new terminal.
927		1204
928	Croaks (and probably outputs an error message) if the new instance	1205	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	1206	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	1207	initialise perl, and the terminal object otherwise. The C<init> and
931	C<start> hooks will be called during this call.	1208	C<start> hooks will be called before this call returns, and are free to
		1209	refer to global data (which is race free).
932		1210
933	=cut	1211	=cut
934		1212
935	sub new {	1213	sub new {
936	my ($class, $env, @args) = @_;	1214	my ($class, $env, @args) = @_;
937		1215
		1216	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1217	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1218
938	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1219	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
939	}	1220	}
940		1221
941	=item $term->destroy	1222	=item $term->destroy
942		1223
943	Destroy the terminal object (close the window, free resources	1224	Destroy the terminal object (close the window, free resources
944	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1225	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
945	watchers (timers, io watchers) are still active.	1226	watchers (timers, io watchers) are still active.
946		1227
		1228	=item $term->exec_async ($cmd[, @args])
		1229
		1230	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1231	("starts") programs in the background. This function takes care of setting
		1232	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1233	be preferred over explicit calls to C<exec> or C<system>.
		1234
		1235	Returns the pid of the subprocess or C<undef> on error.
		1236
		1237	=cut
		1238
		1239	sub exec_async {
		1240	my $self = shift;
		1241
		1242	my $pid = fork;
		1243
		1244	return $pid
		1245	if !defined $pid or $pid;
		1246
		1247	%ENV = %{ $self->env };
		1248
		1249	exec @_;
		1250	urxvt::_exit 255;
		1251	}
		1252
947	=item $isset = $term->option ($optval[, $set])	1253	=item $isset = $term->option ($optval[, $set])
948		1254
949	Returns true if the option specified by C<$optval> is enabled, and	1255	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	1256	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.	1257	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
952		1258
953	Here is a a likely non-exhaustive list of option names, please see the	1259	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:	1260	source file F</src/optinc.h> to see the actual list:
955		1261
956	borderLess console cursorBlink cursorUnderline hold iconic insecure	1262	borderLess console cursorBlink cursorUnderline hold iconic insecure
957	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1263	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
958	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1264	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
975	likely change).	1281	likely change).
976		1282
977	Please note that resource strings will currently only be freed when the	1283	Please note that resource strings will currently only be freed when the
978	terminal is destroyed, so changing options frequently will eat memory.	1284	terminal is destroyed, so changing options frequently will eat memory.
979		1285
980	Here is a a likely non-exhaustive list of resource names, not all of which	1286	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>	1287	are supported in every build, please see the source file F</src/rsinc.h>
982	to see the actual list:	1288	to see the actual list:
983		1289
984	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1290	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
985	borderLess color cursorBlink cursorUnderline cutchars delete_key	1291	borderLess color cursorBlink cursorUnderline cutchars delete_key
…		…
1175		1481
1176	Normally its not a good idea to use this function, as programs might be	1482	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	1483	confused by changes in cursor position or scrolling. Its useful inside a
1178	C<on_add_lines> hook, though.	1484	C<on_add_lines> hook, though.
1179		1485
		1486	=item $term->scr_change_screen ($screen)
		1487
		1488	Switch to given screen - 0 primary, 1 secondary.
		1489
1180	=item $term->cmd_parse ($octets)	1490	=item $term->cmd_parse ($octets)
1181		1491
1182	Similar to C<scr_add_lines>, but the argument must be in the	1492	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	1493	locale-specific encoding of the terminal and can contain command sequences
1184	(escape codes) that will be interpreted.	1494	(escape codes) that will be interpreted.
…		…
1194	Replaces the event mask of the pty watcher by the given event mask. Can	1504	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	1505	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	1506	description of C<< urxvt::timer->events >>. Make sure to always restore
1197	the previous value.	1507	the previous value.
1198		1508
		1509	=item $fd = $term->pty_fd
		1510
		1511	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1512	is used.
		1513
1199	=item $windowid = $term->parent	1514	=item $windowid = $term->parent
1200		1515
1201	Return the window id of the toplevel window.	1516	Return the window id of the toplevel window.
1202		1517
1203	=item $windowid = $term->vt	1518	=item $windowid = $term->vt
…		…
1209	Adds the specified events to the vt event mask. Useful e.g. when you want	1524	Adds the specified events to the vt event mask. Useful e.g. when you want
1210	to receive pointer events all the times:	1525	to receive pointer events all the times:
1211		1526
1212	$term->vt_emask_add (urxvt::PointerMotionMask);	1527	$term->vt_emask_add (urxvt::PointerMotionMask);
1213		1528
		1529	=item $term->focus_in
		1530
		1531	=item $term->focus_out
		1532
		1533	=item $term->key_press ($state, $keycode[, $time])
		1534
		1535	=item $term->key_release ($state, $keycode[, $time])
		1536
		1537	Deliver various fake events to to terminal.
		1538
1214	=item $window_width = $term->width	1539	=item $window_width = $term->width
1215		1540
1216	=item $window_height = $term->height	1541	=item $window_height = $term->height
1217		1542
1218	=item $font_width = $term->fwidth	1543	=item $font_width = $term->fwidth
…		…
1248	=item $env = $term->env	1573	=item $env = $term->env
1249		1574
1250	Returns a copy of the environment in effect for the terminal as a hashref	1575	Returns a copy of the environment in effect for the terminal as a hashref
1251	similar to C<\%ENV>.	1576	similar to C<\%ENV>.
1252		1577
		1578	=item @envv = $term->envv
		1579
		1580	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1581
		1582	=item @argv = $term->argv
		1583
		1584	Return the argument vector as this terminal, similar to @ARGV, but
		1585	includes the program name as first element.
		1586
1253	=cut	1587	=cut
1254		1588
1255	sub env {	1589	sub env {
1256	if (my $env = $_[0]->_env) {
1257	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1590	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1258	} else {
1259	+{ %ENV }
1260	}
1261	}	1591	}
1262		1592
1263	=item $modifiermask = $term->ModLevel3Mask	1593	=item $modifiermask = $term->ModLevel3Mask
1264		1594
1265	=item $modifiermask = $term->ModMetaMask	1595	=item $modifiermask = $term->ModMetaMask
1266		1596
1267	=item $modifiermask = $term->ModNumLockMask	1597	=item $modifiermask = $term->ModNumLockMask
1268		1598
1269	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1599	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.	1600	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1601
		1602	=item $screen = $term->current_screen
		1603
		1604	Returns the currently displayed screen (0 primary, 1 secondary).
		1605
		1606	=item $cursor_is_hidden = $term->hidden_cursor
		1607
		1608	Returns whether the cursor is currently hidden or not.
1271		1609
1272	=item $view_start = $term->view_start ([$newvalue])	1610	=item $view_start = $term->view_start ([$newvalue])
1273		1611
1274	Returns the row number of the topmost displayed line. Maximum value is	1612	Returns the row number of the topmost displayed line. Maximum value is
1275	C<0>, which displays the normal terminal contents. Lower values scroll	1613	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	1633	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	1634	to replace only parts of a line. The font index in the rendition will
1297	automatically be updated.	1635	automatically be updated.
1298		1636
1299	C<$text> is in a special encoding: tabs and wide characters that use more	1637	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	1638	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1301	(C<chr 65535>). Characters with combining characters and other characters	1639	characters. Characters with combining characters and other characters that
1302	that do not fit into the normal tetx encoding will be replaced with	1640	do not fit into the normal tetx encoding will be replaced with characters
1303	characters in the private use area.	1641	in the private use area.
1304		1642
1305	You have to obey this encoding when changing text. The advantage is	1643	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	1644	that C<substr> and similar functions work on screen cells and not on
1307	characters.	1645	characters.
1308		1646
…		…
1452	where one character corresponds to one screen cell. See	1790	where one character corresponds to one screen cell. See
1453	C<< $term->ROW_t >> for details.	1791	C<< $term->ROW_t >> for details.
1454		1792
1455	=item $string = $term->special_decode $text	1793	=item $string = $term->special_decode $text
1456		1794
1457	Converts rxvt-unicodes text reprsentation into a perl string. See	1795	Converts rxvt-unicodes text representation into a perl string. See
1458	C<< $term->ROW_t >> for details.	1796	C<< $term->ROW_t >> for details.
1459		1797
1460	=item $success = $term->grab_button ($button, $modifiermask)	1798	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1461		1799
		1800	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1801
1462	Registers a synchronous button grab. See the XGrabButton manpage.	1802	Register/unregister a synchronous button grab. See the XGrabButton
		1803	manpage.
1463		1804
1464	=item $success = $term->grab ($eventtime[, $sync])	1805	=item $success = $term->grab ($eventtime[, $sync])
1465		1806
1466	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1807	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1467	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1808	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1468		1809
1469	=item $term->allow_events_async	1810	=item $term->allow_events_async
1470		1811
1471	Calls XAllowEvents with AsyncBoth for the most recent grab.	1812	Calls XAllowEvents with AsyncBoth for the most recent grab.
1472		1813
…		…
1482	=item $term->ungrab	1823	=item $term->ungrab
1483		1824
1484	Calls XUngrab for the most recent grab. Is called automatically on	1825	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	1826	evaluation errors, as it is better to lose the grab in the error case as
1486	the session.	1827	the session.
		1828
		1829	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1830
		1831	=item $atom_name = $term->XGetAtomName ($atom)
		1832
		1833	=item @atoms = $term->XListProperties ($window)
		1834
		1835	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1836
		1837	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1838
		1839	=item $term->XDeleteProperty ($window, $property)
		1840
		1841	=item $window = $term->DefaultRootWindow
		1842
		1843	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1844
		1845	=item $term->XMapWindow ($window)
		1846
		1847	=item $term->XUnmapWindow ($window)
		1848
		1849	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1850
		1851	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1852
		1853	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1854
		1855	Various X or X-related functions. The C<$term> object only serves as
		1856	the source of the display, otherwise those functions map more-or-less
		1857	directory onto the X functions of the same name.
1487		1858
1488	=back	1859	=back
1489		1860
1490	=cut	1861	=cut
1491		1862
…		…
1555	my ($self, $text, $cb) = @_;	1926	my ($self, $text, $cb) = @_;
1556		1927
1557	$self->add_item ({ type => "button", text => $text, activate => $cb});	1928	$self->add_item ({ type => "button", text => $text, activate => $cb});
1558	}	1929	}
1559		1930
1560	=item $popup->add_toggle ($text, $cb, $initial_value)	1931	=item $popup->add_toggle ($text, $initial_value, $cb)
1561		1932
1562	Adds a toggle/checkbox item to the popup. Teh callback gets called	1933	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	1934	whenever it gets toggled, with a boolean indicating its new value as its
1564	argument.	1935	first argument.
1565		1936
1566	=cut	1937	=cut
1567		1938
1568	sub add_toggle {	1939	sub add_toggle {
1569	my ($self, $text, $cb, $value) = @_;	1940	my ($self, $text, $value, $cb) = @_;
1570		1941
1571	my $item; $item = {	1942	my $item; $item = {
1572	type => "button",	1943	type => "button",
1573	text => " $text",	1944	text => " $text",
1574	value => $value,	1945	value => $value,
…		…
1611	delete $self->{term}{_destroy}{$self};	1982	delete $self->{term}{_destroy}{$self};
1612	$self->{term}->ungrab;	1983	$self->{term}->ungrab;
1613	}	1984	}
1614		1985
1615	=back	1986	=back
		1987
		1988	=cut
		1989
		1990	package urxvt::watcher;
1616		1991
1617	=head2 The C<urxvt::timer> Class	1992	=head2 The C<urxvt::timer> Class
1618		1993
1619	This class implements timer watchers/events. Time is represented as a	1994	This class implements timer watchers/events. Time is represented as a
1620	fractional number of seconds since the epoch. Example:	1995	fractional number of seconds since the epoch. Example:
…		…
1700	Set the callback to be called when io events are triggered. C<$reventmask>	2075	Set the callback to be called when io events are triggered. C<$reventmask>
1701	is a bitset as described in the C<events> method.	2076	is a bitset as described in the C<events> method.
1702		2077
1703	=item $iow = $iow->fd ($fd)	2078	=item $iow = $iow->fd ($fd)
1704		2079
1705	Set the filedescriptor (not handle) to watch.	2080	Set the file descriptor (not handle) to watch.
1706		2081
1707	=item $iow = $iow->events ($eventmask)	2082	=item $iow = $iow->events ($eventmask)
1708		2083
1709	Set the event mask to watch. The only allowed values are	2084	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	2085	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
…		…
1714		2089
1715	Start watching for requested events on the given handle.	2090	Start watching for requested events on the given handle.
1716		2091
1717	=item $iow = $iow->stop	2092	=item $iow = $iow->stop
1718		2093
1719	Stop watching for events on the given filehandle.	2094	Stop watching for events on the given file handle.
		2095
		2096	=back
		2097
		2098	=head2 The C<urxvt::iw> Class
		2099
		2100	This class implements idle watchers, that get called automatically when
		2101	the process is idle. They should return as fast as possible, after doing
		2102	some useful work.
		2103
		2104	=over 4
		2105
		2106	=item $iw = new urxvt::iw
		2107
		2108	Create a new idle watcher object in stopped state.
		2109
		2110	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2111
		2112	Set the callback to be called when the watcher triggers.
		2113
		2114	=item $timer = $timer->start
		2115
		2116	Start the watcher.
		2117
		2118	=item $timer = $timer->stop
		2119
		2120	Stop the watcher.
		2121
		2122	=back
		2123
		2124	=head2 The C<urxvt::pw> Class
		2125
		2126	This class implements process watchers. They create an event whenever a
		2127	process exits, after which they stop automatically.
		2128
		2129	my $pid = fork;
		2130	...
		2131	$term->{pw} = urxvt::pw
		2132	->new
		2133	->start ($pid)
		2134	->cb (sub {
		2135	my ($pw, $exit_status) = @_;
		2136	...
		2137	});
		2138
		2139	=over 4
		2140
		2141	=item $pw = new urxvt::pw
		2142
		2143	Create a new process watcher in stopped state.
		2144
		2145	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2146
		2147	Set the callback to be called when the timer triggers.
		2148
		2149	=item $pw = $timer->start ($pid)
		2150
		2151	Tells the watcher to start watching for process C<$pid>.
		2152
		2153	=item $pw = $pw->stop
		2154
		2155	Stop the watcher.
1720		2156
1721	=back	2157	=back
1722		2158
1723	=head1 ENVIRONMENT	2159	=head1 ENVIRONMENT
1724		2160
…		…
1733		2169
1734	=item >= 3 - script loading and management	2170	=item >= 3 - script loading and management
1735		2171
1736	=item >=10 - all called hooks	2172	=item >=10 - all called hooks
1737		2173
1738	=item >=11 - hook reutrn values	2174	=item >=11 - hook return values
1739		2175
1740	=back	2176	=back
1741		2177
1742	=head1 AUTHOR	2178	=head1 AUTHOR
1743		2179
…		…
1745	http://software.schmorp.de/pkg/rxvt-unicode	2181	http://software.schmorp.de/pkg/rxvt-unicode
1746		2182
1747	=cut	2183	=cut
1748		2184
1749	1	2185	1
		2186
		2187	# 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.154 by root, Sat Jun 2 06:43:02 2007 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.154 by root, Sat Jun 2 06:43:02 2007 UTC