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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.96 by root, Tue Jan 17 16:22:41 2006 UTC vs.
Revision 1.171 by root, Fri Oct 10 00:11:44 2008 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	71	between two vertical bars:
65		72
66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
67		81
68	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
76		90
77	Rot-13 the selection when activated. Used via keyboard trigger:	91	Rot-13 the selection when activated. Used via keyboard trigger:
78		92
79	URxvt.keysym.C-M-r: perl:selection:rot13	93	URxvt.keysym.C-M-r: perl:selection:rot13
80		94
81	=item remote-pastebin
82
83	Upload the selection as textfile to a remote site.
84
85	URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87	To set the command to upload the file set this resource:
88
89	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92	md5 sum of the selection.
93	After an successful upload the selection will be replaced by the following url
94	(the % is the placeholder for the filename):
95
96	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
97
98	=back	95	=back
99		96
100	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
101		98
102	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
103	runtime.	100	runtime.
104		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
105	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
106		120
107	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
108	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
109	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
		124
		125	Other extensions can extend this popup menu by pushing a code reference
		126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
		128
		129	Its sole argument is the popup menu, which can be modified. The selection
		130	is in C<$_>, which can be used to decide whether to add something or not.
		131	It should either return nothing or a string and a code reference. The
		132	string will be used as button text and the code reference will be called
		133	when the button gets activated and should transform C<$_>.
		134
		135	The following will add an entry C<a to b> that transforms all C<a>s in
		136	the selection to C<b>s, but only if the selection currently contains any
		137	C<a>s:
		138
		139	push @{ $self->{term}{selection_popup_hook} }, sub {
		140	/a/ ? ("a to b" => sub { s/a/b/g }
		141	: ()
		142	};
110		143
111	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
112		145
113	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
114	by a hotkey (default: C<M-s>). While in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
119	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>
120	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
121	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
122	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
123	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
124	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
125		189
126	=item selection-autotransform	190	=item selection-autotransform
127		191
128	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
129	whenever a selection is made.	193	whenever a selection is made.
…		…
142	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/
143		207
144	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
145	paste directly into your (vi :) editor:	209	paste directly into your (vi :) editor:
146		210
147	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/
148		212
149	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 :)
150		214
151	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
152	FILENAME line YYY."), you need a slightly more elaborate solution:	216	FILENAME line YYY."), you need a slightly more elaborate solution:
153		217
154	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
155	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/
156		220
157	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
158	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
159	the message into vi commands to load the file.	223	the message into vi commands to load the file.
160		224
161	=item mark-urls	225	=item tabbed
162		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
163	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
164	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
165	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
166	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).
167		307
168	=item block-graphics-to-ascii	308	=item block-graphics-to-ascii
169		309
170	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
171	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
172	similar-looking ascii character.	312	similar-looking ascii character.
173		313
174	=item digital-clock	314	=item digital-clock
175		315
176	Displays a digital clock using the built-in overlay.	316	Displays a digital clock using the built-in overlay.
		317
		318	=item remote-clipboard
		319
		320	Somewhat of a misnomer, this extension adds two menu entries to the
		321	selection popup that allows one to run external commands to store the
		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'
		337
		338	=item selection-pastebin
		339
		340	This is a little rarely useful extension that Uploads the selection as
		341	textfile to a remote site (or does other things). (The implementation is
		342	not currently secure for use in a multiuser environment as it writes to
		343	F</tmp> directly.).
		344
		345	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		346	i.e.
		347
		348	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		349
		350	Pressing this combination runs a command with C<%> replaced by the name of
		351	the textfile. This command can be set via a resource:
		352
		353	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		354
		355	And the default is likely not useful to anybody but the few people around
		356	here :)
		357
		358	The name of the textfile is the hex encoded md5 sum of the selection, so
		359	the same content should lead to the same filename.
		360
		361	After a successful upload the selection will be replaced by the text given
		362	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		363	for the filename):
		364
		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.
177		371
178	=item example-refresh-hooks	372	=item example-refresh-hooks
179		373
180	Displays a very simple digital clock in the upper right corner of the	374	Displays a very simple digital clock in the upper right corner of the
181	window. Illustrates overwriting the refresh callbacks to create your own	375	window. Illustrates overwriting the refresh callbacks to create your own
…		…
221		415
222	=back	416	=back
223		417
224	=head2 Extension Objects	418	=head2 Extension Objects
225		419
226	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
227	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,
228	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
229	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
230	begin with an underscore character C<_>: these are reserved for internal	425	that begin with an underscore character C<_>: these are reserved for
231	use.	426	internal use.
232		427
233	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
234	C<urxvt::term> class on this object.	429	C<urxvt::term> class on this object.
235		430
236	It has the following methods and data members:	431	It has the following methods and data members:
…		…
257	=head2 Hooks	452	=head2 Hooks
258		453
259	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
260	called whenever the relevant event happens.	455	called whenever the relevant event happens.
261		456
262	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
263	the in the C<Extension Objects> section.	458	the in the C<Extension Objects> section.
264		459
265	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
266	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
267	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.
268		463
269	I<< When in doubt, return a false value (preferably C<()>). >>	464	I<< When in doubt, return a false value (preferably C<()>). >>
270		465
271	=over 4	466	=over 4
272		467
273	=item on_init $term	468	=item on_init $term
274		469
275	Called after a new terminal object has been initialized, but before	470	Called after a new terminal object has been initialized, but before
276	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
277	call or deliver senseless data, as terminal size and other characteristics	472	call or deliver senseless data, as terminal size and other characteristics
278	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
279	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).
280		486
281	=item on_reset $term	487	=item on_reset $term
282		488
283	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
284	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
285	variables.	491	variables.
286		492
287	=item on_start $term	493	=item on_child_start $term, $pid
288		494
289	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.
290	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>.
291		501
292	=item on_sel_make $term, $eventtime	502	=item on_sel_make $term, $eventtime
293		503
294	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
295	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
…		…
302		512
303	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
304	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
305	by calling C<< $term->selection >>.	515	by calling C<< $term->selection >>.
306		516
307	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.
308		518
309	=item on_sel_extend $term	519	=item on_sel_extend $term
310		520
311	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
312	click) and is either supposed to return false (normal operation), or	522	click) and is either supposed to return false (normal operation), or
313	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
314	processing. This can happen multiple times, as long as the callback	524	processing. This can happen multiple times, as long as the callback
315	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
316	supposed to enlarge the selection more and more, if possible.	526	supposed to enlarge the selection more and more, if possible.
317		527
318	See the F<selection> example extension.	528	See the F<selection> example extension.
319		529
320	=item on_view_change $term, $offset	530	=item on_view_change $term, $offset
321		531
322	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
323	scrolls. Offset C<0> means display the normal terminal, positive values	533	scrolls. Offset C<0> means display the normal terminal, positive values
324	show this many lines of scrollback.	534	show this many lines of scrollback.
325		535
326	=item on_scroll_back $term, $lines, $saved	536	=item on_scroll_back $term, $lines, $saved
327		537
…		…
331		541
332	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,
333	$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
334	number of lines that will be in the scrollback buffer.	544	number of lines that will be in the scrollback buffer.
335		545
336	=item on_osc_seq $term, $string	546	=item on_osc_seq $term, $op, $args, $resp
		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
		556	=item on_osc_seq_perl $term, $args, $resp
337		557
338	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
339	operating system command) is processed. Cursor position and other state	559	operating system command) is processed. Cursor position and other state
340	information is up-to-date when this happens. For interoperability, the	560	information is up-to-date when this happens. For interoperability, the
341	string should start with the extension name and a colon, to distinguish	561	string should start with the extension name (sans -osc) and a semicolon,
342	it from commands for other extensions, and this might be enforced in the	562	to distinguish it from commands for other extensions, and this might be
343	future.	563	enforced in the future.
		564
		565	For example, C<overlay-osc> uses this:
		566
		567	sub on_osc_seq_perl {
		568	my ($self, $osc, $resp) = @_;
		569
		570	return unless $osc =~ s/^overlay;//;
		571
		572	... process remaining $osc string
		573	}
344		574
345	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,
346	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
347	other users on the same system etc.).	577	other users on the same system etc.).
		578
		579	For responses, C<$resp> contains the end-of-args separator used by the
		580	sender.
348		581
349	=item on_add_lines $term, $string	582	=item on_add_lines $term, $string
350		583
351	Called whenever text is about to be output, with the text as argument. You	584	Called whenever text is about to be output, with the text as argument. You
352	can filter/change and output the text yourself by returning a true value	585	can filter/change and output the text yourself by returning a true value
…		…
373	later with the already-modified line (e.g. if unrelated parts change), so	606	later with the already-modified line (e.g. if unrelated parts change), so
374	you cannot just toggle rendition bits, but only set them.	607	you cannot just toggle rendition bits, but only set them.
375		608
376	=item on_refresh_begin $term	609	=item on_refresh_begin $term
377		610
378	Called just before the screen gets redrawn. Can be used for overlay	611	Called just before the screen gets redrawn. Can be used for overlay or
379	or similar effects by modify terminal contents in refresh_begin, and	612	similar effects by modifying the terminal contents in refresh_begin, and
380	restoring them in refresh_end. The built-in overlay and selection display	613	restoring them in refresh_end. The built-in overlay and selection display
381	code is run after this hook, and takes precedence.	614	code is run after this hook, and takes precedence.
382		615
383	=item on_refresh_end $term	616	=item on_refresh_end $term
384		617
385	Called just after the screen gets redrawn. See C<on_refresh_begin>.	618	Called just after the screen gets redrawn. See C<on_refresh_begin>.
386		619
387	=item on_keyboard_command $term, $string	620	=item on_user_command $term, $string
388		621
389	Called whenever the user presses a key combination that has a	622	Called whenever a user-configured event is being activated (e.g. via
390	C<perl:string> action bound to it (see description of the B<keysym>	623	a C<perl:string> action bound to a key, see description of the B<keysym>
391	resource in the @@RXVT_NAME@@(1) manpage).	624	resource in the @@RXVT_NAME@@(1) manpage).
		625
		626	The event is simply the action string. This interface is assumed to change
		627	slightly in the future.
		628
		629	=item on_resize_all_windows $tern, $new_width, $new_height
		630
		631	Called just after the new window size has been calculated, but before
		632	windows are actually being resized or hints are being set. If this hook
		633	returns TRUE, setting of the window hints is being skipped.
392		634
393	=item on_x_event $term, $event	635	=item on_x_event $term, $event
394		636
395	Called on every X event received on the vt window (and possibly other	637	Called on every X event received on the vt window (and possibly other
396	windows). Should only be used as a last resort. Most event structure	638	windows). Should only be used as a last resort. Most event structure
397	members are not passed.	639	members are not passed.
398		640
		641	=item on_root_event $term, $event
		642
		643	Like C<on_x_event>, but is called for events on the root window.
		644
399	=item on_focus_in $term	645	=item on_focus_in $term
400		646
401	Called whenever the window gets the keyboard focus, before rxvt-unicode	647	Called whenever the window gets the keyboard focus, before rxvt-unicode
402	does focus in processing.	648	does focus in processing.
403		649
404	=item on_focus_out $term	650	=item on_focus_out $term
405		651
406	Called wheneever the window loses keyboard focus, before rxvt-unicode does	652	Called whenever the window loses keyboard focus, before rxvt-unicode does
407	focus out processing.	653	focus out processing.
		654
		655	=item on_configure_notify $term, $event
		656
		657	=item on_property_notify $term, $event
408		658
409	=item on_key_press $term, $event, $keysym, $octets	659	=item on_key_press $term, $event, $keysym, $octets
410		660
411	=item on_key_release $term, $event, $keysym	661	=item on_key_release $term, $event, $keysym
412		662
…		…
422		672
423	Called whenever the corresponding X event is received for the terminal If	673	Called whenever the corresponding X event is received for the terminal If
424	the hook returns true, then the even will be ignored by rxvt-unicode.	674	the hook returns true, then the even will be ignored by rxvt-unicode.
425		675
426	The event is a hash with most values as named by Xlib (see the XEvent	676	The event is a hash with most values as named by Xlib (see the XEvent
427	manpage), with the additional members C<row> and C<col>, which are the row	677	manpage), with the additional members C<row> and C<col>, which are the
428	and column under the mouse cursor.	678	(real, not screen-based) row and column under the mouse cursor.
429		679
430	C<on_key_press> additionally receives the string rxvt-unicode would	680	C<on_key_press> additionally receives the string rxvt-unicode would
431	output, if any, in locale-specific encoding.	681	output, if any, in locale-specific encoding.
432		682
433	subwindow.	683	subwindow.
		684
		685	=item on_client_message $term, $event
		686
		687	=item on_wm_protocols $term, $event
		688
		689	=item on_wm_delete_window $term, $event
		690
		691	Called when various types of ClientMessage events are received (all with
		692	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
434		693
435	=back	694	=back
436		695
437	=cut	696	=cut
438		697
…		…
444	use Scalar::Util ();	703	use Scalar::Util ();
445	use List::Util ();	704	use List::Util ();
446		705
447	our $VERSION = 1;	706	our $VERSION = 1;
448	our $TERM;	707	our $TERM;
		708	our @TERM_INIT;
		709	our @TERM_EXT;
449	our @HOOKNAME;	710	our @HOOKNAME;
450	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	711	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451	our %OPTION;	712	our %OPTION;
452		713
453	our $LIBDIR;	714	our $LIBDIR;
454	our $RESNAME;	715	our $RESNAME;
455	our $RESCLASS;	716	our $RESCLASS;
456	our $RXVTNAME;	717	our $RXVTNAME;
457		718
		719	our $NOCHAR = chr 0xffff;
		720
458	=head2 Variables in the C<urxvt> Package	721	=head2 Variables in the C<urxvt> Package
459		722
460	=over 4	723	=over 4
461		724
462	=item $urxvt::LIBDIR	725	=item $urxvt::LIBDIR
…		…
474		737
475	=item $urxvt::TERM	738	=item $urxvt::TERM
476		739
477	The current terminal. This variable stores the current C<urxvt::term>	740	The current terminal. This variable stores the current C<urxvt::term>
478	object, whenever a callback/hook is executing.	741	object, whenever a callback/hook is executing.
		742
		743	=item @urxvt::TERM_INIT
		744
		745	All code references in this array will be called as methods of the next newly
		746	created C<urxvt::term> object (during the C<on_init> phase). The array
		747	gets cleared before the code references that were in it are being executed,
		748	so references can push themselves onto it again if they so desire.
		749
		750	This complements to the perl-eval command line option, but gets executed
		751	first.
		752
		753	=item @urxvt::TERM_EXT
		754
		755	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		756	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		757	but before other extensions. Gets cleared just like C<@TERM_INIT>.
479		758
480	=back	759	=back
481		760
482	=head2 Functions in the C<urxvt> Package	761	=head2 Functions in the C<urxvt> Package
483		762
…		…
497		776
498	Using this function has the advantage that its output ends up in the	777	Using this function has the advantage that its output ends up in the
499	correct place, e.g. on stderr of the connecting urxvtc client.	778	correct place, e.g. on stderr of the connecting urxvtc client.
500		779
501	Messages have a size limit of 1023 bytes currently.	780	Messages have a size limit of 1023 bytes currently.
		781
		782	=item @terms = urxvt::termlist
		783
		784	Returns all urxvt::term objects that exist in this process, regardless of
		785	whether they are started, being destroyed etc., so be careful. Only term
		786	objects that have perl extensions attached will be returned (because there
		787	is no urxvt::term objet associated with others).
502		788
503	=item $time = urxvt::NOW	789	=item $time = urxvt::NOW
504		790
505	Returns the "current time" (as per the event loop).	791	Returns the "current time" (as per the event loop).
506		792
…		…
565		851
566	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	852	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
567		853
568	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	854	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
569		855
		856	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		857
570	Replace the foreground/background colour in the rendition mask with the	858	Replace the foreground/background colour in the rendition mask with the
571	specified one.	859	specified one.
572		860
573	=item $value = urxvt::GET_CUSTOM $rend	861	=item $value = urxvt::GET_CUSTOM $rend
574		862
…		…
583	=back	871	=back
584		872
585	=cut	873	=cut
586		874
587	BEGIN {	875	BEGIN {
588	urxvt->bootstrap;
589
590	# overwrite perl's warn	876	# overwrite perl's warn
591	*CORE::GLOBAL::warn = sub {	877	*CORE::GLOBAL::warn = sub {
592	my $msg = join "", @_;	878	my $msg = join "", @_;
593	$msg .= "\n"	879	$msg .= "\n"
594	unless $msg =~ /\n$/;	880	unless $msg =~ /\n$/;
595	urxvt::warn ($msg);	881	urxvt::warn ($msg);
596	};	882	};
597
598	# %ENV is the original startup environment
599	delete $ENV{IFS};
600	delete $ENV{CDPATH};
601	delete $ENV{BASH_ENV};
602	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
603	}	883	}
		884
		885	no warnings 'utf8';
604		886
605	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	887	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
606		888
607	sub verbose {	889	sub verbose {
608	my ($level, $msg) = @_;	890	my ($level, $msg) = @_;
609	warn "$msg\n" if $level <= $verbosity;	891	warn "$msg\n" if $level <= $verbosity;
610	}	892	}
611		893
612	my $extension_pkg = "extension0000";
613	my %extension_pkg;	894	my %extension_pkg;
614		895
615	# load a single script into its own package, once only	896	# load a single script into its own package, once only
616	sub extension_package($) {	897	sub extension_package($) {
617	my ($path) = @_;	898	my ($path) = @_;
618		899
619	$extension_pkg{$path} \|\|= do {	900	$extension_pkg{$path} \|\|= do {
620	my $pkg = "urxvt::" . ($extension_pkg++);	901	$path =~ /([^\/\\]+)$/;
		902	my $pkg = $1;
		903	$pkg =~ s/[^[:word:]]/_/g;
		904	$pkg = "urxvt::ext::$pkg";
621		905
622	verbose 3, "loading extension '$path' into package '$pkg'";	906	verbose 3, "loading extension '$path' into package '$pkg'";
623		907
624	open my $fh, "<:raw", $path	908	open my $fh, "<:raw", $path
625	or die "$path: $!";	909	or die "$path: $!";
626		910
627	my $source =	911	my $source =
628	"package $pkg; use strict; use utf8;\n"	912	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
629	. "use base urxvt::term::extension::;\n"
630	. "#line 1 \"$path\"\n{\n"	913	. "#line 1 \"$path\"\n{\n"
631	. (do { local $/; <$fh> })	914	. (do { local $/; <$fh> })
632	. "\n};\n1";	915	. "\n};\n1";
633		916
634	eval $source	917	eval $source
…		…
645	local $TERM = shift;	928	local $TERM = shift;
646	my $htype = shift;	929	my $htype = shift;
647		930
648	if ($htype == 0) { # INIT	931	if ($htype == 0) { # INIT
649	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
650		933
651	my %ext_arg;	934	my %ext_arg;
652		935
		936	{
		937	my @init = @TERM_INIT;
		938	@TERM_INIT = ();
		939	$_->($TERM) for @init;
		940	my @pkg = @TERM_EXT;
		941	@TERM_EXT = ();
		942	$TERM->register_package ($_) for @pkg;
		943	}
		944
653	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	945	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
654	if ($_ eq "default") {	946	if ($_ eq "default") {
655	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	947	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
656	} elsif (/^-(.*)$/) {	948	} elsif (/^-(.*)$/) {
657	delete $ext_arg{$1};	949	delete $ext_arg{$1};
658	} elsif (/^([^<]+)<(.*)>$/) {	950	} elsif (/^([^<]+)<(.*)>$/) {
659	push @{ $ext_arg{$1} }, $2;	951	push @{ $ext_arg{$1} }, $2;
660	} else {	952	} else {
661	$ext_arg{$_} \|\|= [];	953	$ext_arg{$_} \|\|= [];
662	}	954	}
663	}	955	}
664		956
665	while (my ($ext, $argv) = each %ext_arg) {	957	for my $ext (sort keys %ext_arg) {
666	my @files = grep -f $_, map "$_/$ext", @dirs;	958	my @files = grep -f $_, map "$_/$ext", @dirs;
667		959
668	if (@files) {	960	if (@files) {
669	$TERM->register_package (extension_package $files[0], $argv);	961	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
670	} else {	962	} else {
671	warn "perl extension '$ext' not found in perl library search path\n";	963	warn "perl extension '$ext' not found in perl library search path\n";
672	}	964	}
673	}	965	}
674		966
…		…
680		972
681	if (my $cb = $TERM->{_hook}[$htype]) {	973	if (my $cb = $TERM->{_hook}[$htype]) {
682	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	974	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
683	if $verbosity >= 10;	975	if $verbosity >= 10;
684		976
685	keys %$cb;	977	for my $pkg (keys %$cb) {
686
687	while (my ($pkg, $cb) = each %$cb) {
688	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	978	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
689	and last;	979	$retval \|\|= $retval_;
690		980
691	if ($@) {	981	if ($@) {
692	$TERM->ungrab; # better to lose the grab than the session	982	$TERM->ungrab; # better to lose the grab than the session
693	warn $@;	983	warn $@;
694	}	984	}
…		…
707	}	997	}
708		998
709	$retval	999	$retval
710	}	1000	}
711		1001
712	sub exec_async(@) {	1002	sub SET_COLOR($$$) {
713	my $pid = fork;	1003	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1004	}
714		1005
715	return	1006	sub rend2mask {
716	if !defined $pid or $pid;	1007	no strict 'refs';
717		1008	my ($str, $mask) = (@_, 0);
718	%ENV = %{ $TERM->env };	1009	my %color = ( fg => undef, bg => undef );
719		1010	my @failed;
720	exec @_;	1011	for my $spec ( split /\s+/, $str ) {
721	_exit 255;	1012	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1013	$color{lc($1)} = $2;
		1014	} else {
		1015	my $neg = $spec =~ s/^[-^]//;
		1016	unless ( exists &{"RS_$spec"} ) {
		1017	push @failed, $spec;
		1018	next;
		1019	}
		1020	my $cur = &{"RS_$spec"};
		1021	if ( $neg ) {
		1022	$mask &= ~$cur;
		1023	} else {
		1024	$mask \|= $cur;
		1025	}
		1026	}
		1027	}
		1028	($mask, @color{qw(fg bg)}, \@failed)
722	}	1029	}
723		1030
724	# urxvt::term::extension	1031	# urxvt::term::extension
725		1032
726	package urxvt::term::extension;	1033	package urxvt::term::extension;
…		…
797	is that you cannot use blocking APIs, but the non-blocking variant should	1104	is that you cannot use blocking APIs, but the non-blocking variant should
798	work.	1105	work.
799		1106
800	=cut	1107	=cut
801		1108
802	our $VERSION = 1;	1109	our $VERSION = '3.4';
803		1110
804	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
805	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
806		1113
807	sub timer {	1114	sub timer {
…		…
838		1145
839	sub DESTROY {	1146	sub DESTROY {
840	$_[0][1]->stop;	1147	$_[0][1]->stop;
841	}	1148	}
842		1149
843	sub condvar {	1150	sub one_event {
844	bless \my $flag, urxvt::anyevent::condvar::
845	}
846
847	sub urxvt::anyevent::condvar::broadcast {
848	${$_[0]}++;
849	}
850
851	sub urxvt::anyevent::condvar::wait {
852	unless (${$_[0]}) {
853	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1151	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
854	}
855	}	1152	}
856		1153
857	package urxvt::term;	1154	package urxvt::term;
858		1155
859	=head2 The C<urxvt::term> Class	1156	=head2 The C<urxvt::term> Class
…		…
864		1161
865	# find on_xxx subs in the package and register them	1162	# find on_xxx subs in the package and register them
866	# as hooks	1163	# as hooks
867	sub register_package {	1164	sub register_package {
868	my ($self, $pkg, $argv) = @_;	1165	my ($self, $pkg, $argv) = @_;
		1166
		1167	no strict 'refs';
		1168
		1169	urxvt::verbose 6, "register package $pkg to $self";
		1170
		1171	@{"$pkg\::ISA"} = urxvt::term::extension::;
869		1172
870	my $proxy = bless {	1173	my $proxy = bless {
871	_pkg => $pkg,	1174	_pkg => $pkg,
872	argv => $argv,	1175	argv => $argv,
873	}, $pkg;	1176	}, $pkg;
…		…
889	hash which defines the environment of the new terminal.	1192	hash which defines the environment of the new terminal.
890		1193
891	Croaks (and probably outputs an error message) if the new instance	1194	Croaks (and probably outputs an error message) if the new instance
892	couldn't be created. Returns C<undef> if the new instance didn't	1195	couldn't be created. Returns C<undef> if the new instance didn't
893	initialise perl, and the terminal object otherwise. The C<init> and	1196	initialise perl, and the terminal object otherwise. The C<init> and
894	C<start> hooks will be called during this call.	1197	C<start> hooks will be called before this call returns, and are free to
		1198	refer to global data (which is race free).
895		1199
896	=cut	1200	=cut
897		1201
898	sub new {	1202	sub new {
899	my ($class, $env, @args) = @_;	1203	my ($class, $env, @args) = @_;
900		1204
		1205	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1206	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1207
901	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1208	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
902	}	1209	}
903		1210
904	=item $term->destroy	1211	=item $term->destroy
905		1212
906	Destroy the terminal object (close the window, free resources	1213	Destroy the terminal object (close the window, free resources
907	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1214	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
908	watchers (timers, io watchers) are still active.	1215	watchers (timers, io watchers) are still active.
909		1216
		1217	=item $term->exec_async ($cmd[, @args])
		1218
		1219	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1220	("starts") programs in the background. This function takes care of setting
		1221	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1222	be preferred over explicit calls to C<exec> or C<system>.
		1223
		1224	Returns the pid of the subprocess or C<undef> on error.
		1225
		1226	=cut
		1227
		1228	sub exec_async {
		1229	my $self = shift;
		1230
		1231	my $pid = fork;
		1232
		1233	return $pid
		1234	if !defined $pid or $pid;
		1235
		1236	%ENV = %{ $self->env };
		1237
		1238	exec @_;
		1239	urxvt::_exit 255;
		1240	}
		1241
910	=item $isset = $term->option ($optval[, $set])	1242	=item $isset = $term->option ($optval[, $set])
911		1243
912	Returns true if the option specified by C<$optval> is enabled, and	1244	Returns true if the option specified by C<$optval> is enabled, and
913	optionally change it. All option values are stored by name in the hash	1245	optionally change it. All option values are stored by name in the hash
914	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1246	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
915		1247
916	Here is a a likely non-exhaustive list of option names, please see the	1248	Here is a likely non-exhaustive list of option names, please see the
917	source file F</src/optinc.h> to see the actual list:	1249	source file F</src/optinc.h> to see the actual list:
918		1250
919	borderLess console cursorBlink cursorUnderline hold iconic insecure	1251	borderLess console cursorBlink cursorUnderline hold iconic insecure
920	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1252	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
921	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1253	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
922	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1254	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
923	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1255	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
924	tripleclickwords utmpInhibit visualBell	1256	transparent tripleclickwords utmpInhibit visualBell
925		1257
926	=item $value = $term->resource ($name[, $newval])	1258	=item $value = $term->resource ($name[, $newval])
927		1259
928	Returns the current resource value associated with a given name and	1260	Returns the current resource value associated with a given name and
929	optionally sets a new value. Setting values is most useful in the C<init>	1261	optionally sets a new value. Setting values is most useful in the C<init>
…		…
938	likely change).	1270	likely change).
939		1271
940	Please note that resource strings will currently only be freed when the	1272	Please note that resource strings will currently only be freed when the
941	terminal is destroyed, so changing options frequently will eat memory.	1273	terminal is destroyed, so changing options frequently will eat memory.
942		1274
943	Here is a a likely non-exhaustive list of resource names, not all of which	1275	Here is a likely non-exhaustive list of resource names, not all of which
944	are supported in every build, please see the source file F</src/rsinc.h>	1276	are supported in every build, please see the source file F</src/rsinc.h>
945	to see the actual list:	1277	to see the actual list:
946		1278
947	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1279	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
948	borderLess color cursorBlink cursorUnderline cutchars delete_key	1280	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
949	display_name embed ext_bwidth fade font geometry hold iconName	1281	display_name embed ext_bwidth fade font geometry hold iconName
950	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1282	imFont imLocale inputMethod insecure int_bwidth intensityStyles
951	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1283	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
952	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1284	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
953	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1285	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
954	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1286	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
955	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1287	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
956	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1288	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
957	shade term_name title transparent transparent_all tripleclickwords	1289	secondaryScreen secondaryScroll shade term_name title
958	utmpInhibit visualBell	1290	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1291	visualBell
959		1292
960	=cut	1293	=cut
961		1294
962	sub resource($$;$) {	1295	sub resource($$;$) {
963	my ($self, $name) = (shift, shift);	1296	my ($self, $name) = (shift, shift);
964	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1297	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
965	&urxvt::term::_resource	1298	goto &urxvt::term::_resource
966	}	1299	}
967		1300
968	=item $value = $term->x_resource ($pattern)	1301	=item $value = $term->x_resource ($pattern)
969		1302
970	Returns the X-Resource for the given pattern, excluding the program or	1303	Returns the X-Resource for the given pattern, excluding the program or
…		…
1137		1470
1138	Normally its not a good idea to use this function, as programs might be	1471	Normally its not a good idea to use this function, as programs might be
1139	confused by changes in cursor position or scrolling. Its useful inside a	1472	confused by changes in cursor position or scrolling. Its useful inside a
1140	C<on_add_lines> hook, though.	1473	C<on_add_lines> hook, though.
1141		1474
		1475	=item $term->scr_change_screen ($screen)
		1476
		1477	Switch to given screen - 0 primary, 1 secondary.
		1478
1142	=item $term->cmd_parse ($octets)	1479	=item $term->cmd_parse ($octets)
1143		1480
1144	Similar to C<scr_add_lines>, but the argument must be in the	1481	Similar to C<scr_add_lines>, but the argument must be in the
1145	locale-specific encoding of the terminal and can contain command sequences	1482	locale-specific encoding of the terminal and can contain command sequences
1146	(escape codes) that will be interpreted.	1483	(escape codes) that will be interpreted.
…		…
1156	Replaces the event mask of the pty watcher by the given event mask. Can	1493	Replaces the event mask of the pty watcher by the given event mask. Can
1157	be used to suppress input and output handling to the pty/tty. See the	1494	be used to suppress input and output handling to the pty/tty. See the
1158	description of C<< urxvt::timer->events >>. Make sure to always restore	1495	description of C<< urxvt::timer->events >>. Make sure to always restore
1159	the previous value.	1496	the previous value.
1160		1497
		1498	=item $fd = $term->pty_fd
		1499
		1500	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1501	is used.
		1502
1161	=item $windowid = $term->parent	1503	=item $windowid = $term->parent
1162		1504
1163	Return the window id of the toplevel window.	1505	Return the window id of the toplevel window.
1164		1506
1165	=item $windowid = $term->vt	1507	=item $windowid = $term->vt
…		…
1171	Adds the specified events to the vt event mask. Useful e.g. when you want	1513	Adds the specified events to the vt event mask. Useful e.g. when you want
1172	to receive pointer events all the times:	1514	to receive pointer events all the times:
1173		1515
1174	$term->vt_emask_add (urxvt::PointerMotionMask);	1516	$term->vt_emask_add (urxvt::PointerMotionMask);
1175		1517
		1518	=item $term->focus_in
		1519
		1520	=item $term->focus_out
		1521
		1522	=item $term->key_press ($state, $keycode[, $time])
		1523
		1524	=item $term->key_release ($state, $keycode[, $time])
		1525
		1526	Deliver various fake events to to terminal.
		1527
1176	=item $window_width = $term->width	1528	=item $window_width = $term->width
1177		1529
1178	=item $window_height = $term->height	1530	=item $window_height = $term->height
1179		1531
1180	=item $font_width = $term->fwidth	1532	=item $font_width = $term->fwidth
…		…
1210	=item $env = $term->env	1562	=item $env = $term->env
1211		1563
1212	Returns a copy of the environment in effect for the terminal as a hashref	1564	Returns a copy of the environment in effect for the terminal as a hashref
1213	similar to C<\%ENV>.	1565	similar to C<\%ENV>.
1214		1566
		1567	=item @envv = $term->envv
		1568
		1569	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1570
		1571	=item @argv = $term->argv
		1572
		1573	Return the argument vector as this terminal, similar to @ARGV, but
		1574	includes the program name as first element.
		1575
1215	=cut	1576	=cut
1216		1577
1217	sub env {	1578	sub env {
1218	if (my $env = $_[0]->_env) {
1219	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1579	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1220	} else {
1221	+{ %ENV }
1222	}
1223	}	1580	}
1224		1581
1225	=item $modifiermask = $term->ModLevel3Mask	1582	=item $modifiermask = $term->ModLevel3Mask
1226		1583
1227	=item $modifiermask = $term->ModMetaMask	1584	=item $modifiermask = $term->ModMetaMask
1228		1585
1229	=item $modifiermask = $term->ModNumLockMask	1586	=item $modifiermask = $term->ModNumLockMask
1230		1587
1231	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1588	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1232	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1589	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1590
		1591	=item $screen = $term->current_screen
		1592
		1593	Returns the currently displayed screen (0 primary, 1 secondary).
		1594
		1595	=item $cursor_is_hidden = $term->hidden_cursor
		1596
		1597	Returns whether the cursor is currently hidden or not.
1233		1598
1234	=item $view_start = $term->view_start ([$newvalue])	1599	=item $view_start = $term->view_start ([$newvalue])
1235		1600
1236	Returns the row number of the topmost displayed line. Maximum value is	1601	Returns the row number of the topmost displayed line. Maximum value is
1237	C<0>, which displays the normal terminal contents. Lower values scroll	1602	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1245		1610
1246	Used after changing terminal contents to display them.	1611	Used after changing terminal contents to display them.
1247		1612
1248	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1613	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1249		1614
1250	Returns the text of the entire row with number C<$row_number>. Row C<0>	1615	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1251	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1616	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1252	terminal line. The scrollback buffer starts at line C<-1> and extends to
1253	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1617	terminal line. Nothing will be returned if a nonexistent line
1254	is requested.	1618	is requested.
1255		1619
1256	If C<$new_text> is specified, it will replace characters in the current	1620	If C<$new_text> is specified, it will replace characters in the current
1257	line, starting at column C<$start_col> (default C<0>), which is useful	1621	line, starting at column C<$start_col> (default C<0>), which is useful
1258	to replace only parts of a line. The font index in the rendition will	1622	to replace only parts of a line. The font index in the rendition will
1259	automatically be updated.	1623	automatically be updated.
1260		1624
1261	C<$text> is in a special encoding: tabs and wide characters that use more	1625	C<$text> is in a special encoding: tabs and wide characters that use more
1262	than one cell when displayed are padded with urxvt::NOCHAR characters	1626	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1263	(C<chr 65535>). Characters with combining characters and other characters	1627	characters. Characters with combining characters and other characters that
1264	that do not fit into the normal tetx encoding will be replaced with	1628	do not fit into the normal text encoding will be replaced with characters
1265	characters in the private use area.	1629	in the private use area.
1266		1630
1267	You have to obey this encoding when changing text. The advantage is	1631	You have to obey this encoding when changing text. The advantage is
1268	that C<substr> and similar functions work on screen cells and not on	1632	that C<substr> and similar functions work on screen cells and not on
1269	characters.	1633	characters.
1270		1634
…		…
1414	where one character corresponds to one screen cell. See	1778	where one character corresponds to one screen cell. See
1415	C<< $term->ROW_t >> for details.	1779	C<< $term->ROW_t >> for details.
1416		1780
1417	=item $string = $term->special_decode $text	1781	=item $string = $term->special_decode $text
1418		1782
1419	Converts rxvt-unicodes text reprsentation into a perl string. See	1783	Converts rxvt-unicodes text representation into a perl string. See
1420	C<< $term->ROW_t >> for details.	1784	C<< $term->ROW_t >> for details.
1421		1785
1422	=item $success = $term->grab_button ($button, $modifiermask)	1786	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1423		1787
		1788	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1789
1424	Registers a synchronous button grab. See the XGrabButton manpage.	1790	Register/unregister a synchronous button grab. See the XGrabButton
		1791	manpage.
1425		1792
1426	=item $success = $term->grab ($eventtime[, $sync])	1793	=item $success = $term->grab ($eventtime[, $sync])
1427		1794
1428	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1795	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1429	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1796	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1430		1797
1431	=item $term->allow_events_async	1798	=item $term->allow_events_async
1432		1799
1433	Calls XAllowEvents with AsyncBoth for the most recent grab.	1800	Calls XAllowEvents with AsyncBoth for the most recent grab.
1434		1801
…		…
1444	=item $term->ungrab	1811	=item $term->ungrab
1445		1812
1446	Calls XUngrab for the most recent grab. Is called automatically on	1813	Calls XUngrab for the most recent grab. Is called automatically on
1447	evaluation errors, as it is better to lose the grab in the error case as	1814	evaluation errors, as it is better to lose the grab in the error case as
1448	the session.	1815	the session.
		1816
		1817	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1818
		1819	=item $atom_name = $term->XGetAtomName ($atom)
		1820
		1821	=item @atoms = $term->XListProperties ($window)
		1822
		1823	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1824
		1825	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1826
		1827	=item $term->XDeleteProperty ($window, $property)
		1828
		1829	=item $window = $term->DefaultRootWindow
		1830
		1831	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1832
		1833	=item $term->XMapWindow ($window)
		1834
		1835	=item $term->XUnmapWindow ($window)
		1836
		1837	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1838
		1839	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1840
		1841	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1842
		1843	Various X or X-related functions. The C<$term> object only serves as
		1844	the source of the display, otherwise those functions map more-or-less
		1845	directory onto the X functions of the same name.
1449		1846
1450	=back	1847	=back
1451		1848
1452	=cut	1849	=cut
1453		1850
…		…
1517	my ($self, $text, $cb) = @_;	1914	my ($self, $text, $cb) = @_;
1518		1915
1519	$self->add_item ({ type => "button", text => $text, activate => $cb});	1916	$self->add_item ({ type => "button", text => $text, activate => $cb});
1520	}	1917	}
1521		1918
1522	=item $popup->add_toggle ($text, $cb, $initial_value)	1919	=item $popup->add_toggle ($text, $initial_value, $cb)
1523		1920
1524	Adds a toggle/checkbox item to the popup. Teh callback gets called	1921	Adds a toggle/checkbox item to the popup. The callback gets called
1525	whenever it gets toggled, with a boolean indicating its value as its first	1922	whenever it gets toggled, with a boolean indicating its new value as its
1526	argument.	1923	first argument.
1527		1924
1528	=cut	1925	=cut
1529		1926
1530	sub add_toggle {	1927	sub add_toggle {
1531	my ($self, $text, $cb, $value) = @_;	1928	my ($self, $text, $value, $cb) = @_;
1532		1929
1533	my $item; $item = {	1930	my $item; $item = {
1534	type => "button",	1931	type => "button",
1535	text => " $text",	1932	text => " $text",
1536	value => $value,	1933	value => $value,
…		…
1555	my $env = $self->{term}->env;	1952	my $env = $self->{term}->env;
1556	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1953	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1557	delete $env->{LC_ALL};	1954	delete $env->{LC_ALL};
1558	$env->{LC_CTYPE} = $self->{term}->locale;	1955	$env->{LC_CTYPE} = $self->{term}->locale;
1559		1956
1560	urxvt::term->new ($env, $self->{term}->resource ("name"),	1957	my $term = urxvt::term->new (
1561	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1958	$env, "popup",
		1959	"--perl-lib" => "", "--perl-ext-common" => "",
		1960	"-pty-fd" => -1, "-sl" => 0,
		1961	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1562	"--transient-for" => $self->{term}->parent,	1962	"--transient-for" => $self->{term}->parent,
1563	"-display" => $self->{term}->display_id,	1963	"-display" => $self->{term}->display_id,
1564	"-pe" => "urxvt-popup")	1964	"-pe" => "urxvt-popup",
1565	or die "unable to create popup window\n";	1965	) or die "unable to create popup window\n";
		1966
		1967	unless (delete $term->{urxvt_popup_init_done}) {
		1968	$term->ungrab;
		1969	$term->destroy;
		1970	die "unable to initialise popup window\n";
		1971	}
1566	}	1972	}
1567		1973
1568	sub DESTROY {	1974	sub DESTROY {
1569	my ($self) = @_;	1975	my ($self) = @_;
1570		1976
1571	delete $self->{term}{_destroy}{$self};	1977	delete $self->{term}{_destroy}{$self};
1572	$self->{term}->ungrab;	1978	$self->{term}->ungrab;
1573	}	1979	}
1574		1980
1575	=back	1981	=back
		1982
		1983	=cut
		1984
		1985	package urxvt::watcher;
1576		1986
1577	=head2 The C<urxvt::timer> Class	1987	=head2 The C<urxvt::timer> Class
1578		1988
1579	This class implements timer watchers/events. Time is represented as a	1989	This class implements timer watchers/events. Time is represented as a
1580	fractional number of seconds since the epoch. Example:	1990	fractional number of seconds since the epoch. Example:
…		…
1584	->new	1994	->new
1585	->interval (1)	1995	->interval (1)
1586	->cb (sub {	1996	->cb (sub {
1587	$term->{overlay}->set (0, 0,	1997	$term->{overlay}->set (0, 0,
1588	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1998	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1589	});	1999	});
1590		2000
1591	=over 4	2001	=over 4
1592		2002
1593	=item $timer = new urxvt::timer	2003	=item $timer = new urxvt::timer
1594		2004
…		…
1618	Start the timer.	2028	Start the timer.
1619		2029
1620	=item $timer = $timer->start ($tstamp)	2030	=item $timer = $timer->start ($tstamp)
1621		2031
1622	Set the event trigger time to C<$tstamp> and start the timer.	2032	Set the event trigger time to C<$tstamp> and start the timer.
		2033
		2034	=item $timer = $timer->after ($delay)
		2035
		2036	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1623		2037
1624	=item $timer = $timer->stop	2038	=item $timer = $timer->stop
1625		2039
1626	Stop the timer.	2040	Stop the timer.
1627		2041
…		…
1633		2047
1634	$term->{socket} = ...	2048	$term->{socket} = ...
1635	$term->{iow} = urxvt::iow	2049	$term->{iow} = urxvt::iow
1636	->new	2050	->new
1637	->fd (fileno $term->{socket})	2051	->fd (fileno $term->{socket})
1638	->events (urxvt::EVENT_READ)	2052	->events (urxvt::EV_READ)
1639	->start	2053	->start
1640	->cb (sub {	2054	->cb (sub {
1641	my ($iow, $revents) = @_;	2055	my ($iow, $revents) = @_;
1642	# $revents must be 1 here, no need to check	2056	# $revents must be 1 here, no need to check
1643	sysread $term->{socket}, my $buf, 8192	2057	sysread $term->{socket}, my $buf, 8192
…		…
1656	Set the callback to be called when io events are triggered. C<$reventmask>	2070	Set the callback to be called when io events are triggered. C<$reventmask>
1657	is a bitset as described in the C<events> method.	2071	is a bitset as described in the C<events> method.
1658		2072
1659	=item $iow = $iow->fd ($fd)	2073	=item $iow = $iow->fd ($fd)
1660		2074
1661	Set the filedescriptor (not handle) to watch.	2075	Set the file descriptor (not handle) to watch.
1662		2076
1663	=item $iow = $iow->events ($eventmask)	2077	=item $iow = $iow->events ($eventmask)
1664		2078
1665	Set the event mask to watch. The only allowed values are	2079	Set the event mask to watch. The only allowed values are
1666	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2080	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1667	together, or C<urxvt::EVENT_NONE>.	2081	together, or C<urxvt::EV_NONE>.
1668		2082
1669	=item $iow = $iow->start	2083	=item $iow = $iow->start
1670		2084
1671	Start watching for requested events on the given handle.	2085	Start watching for requested events on the given handle.
1672		2086
1673	=item $iow = $iow->stop	2087	=item $iow = $iow->stop
1674		2088
1675	Stop watching for events on the given filehandle.	2089	Stop watching for events on the given file handle.
		2090
		2091	=back
		2092
		2093	=head2 The C<urxvt::iw> Class
		2094
		2095	This class implements idle watchers, that get called automatically when
		2096	the process is idle. They should return as fast as possible, after doing
		2097	some useful work.
		2098
		2099	=over 4
		2100
		2101	=item $iw = new urxvt::iw
		2102
		2103	Create a new idle watcher object in stopped state.
		2104
		2105	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2106
		2107	Set the callback to be called when the watcher triggers.
		2108
		2109	=item $timer = $timer->start
		2110
		2111	Start the watcher.
		2112
		2113	=item $timer = $timer->stop
		2114
		2115	Stop the watcher.
		2116
		2117	=back
		2118
		2119	=head2 The C<urxvt::pw> Class
		2120
		2121	This class implements process watchers. They create an event whenever a
		2122	process exits, after which they stop automatically.
		2123
		2124	my $pid = fork;
		2125	...
		2126	$term->{pw} = urxvt::pw
		2127	->new
		2128	->start ($pid)
		2129	->cb (sub {
		2130	my ($pw, $exit_status) = @_;
		2131	...
		2132	});
		2133
		2134	=over 4
		2135
		2136	=item $pw = new urxvt::pw
		2137
		2138	Create a new process watcher in stopped state.
		2139
		2140	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2141
		2142	Set the callback to be called when the timer triggers.
		2143
		2144	=item $pw = $timer->start ($pid)
		2145
		2146	Tells the watcher to start watching for process C<$pid>.
		2147
		2148	=item $pw = $pw->stop
		2149
		2150	Stop the watcher.
1676		2151
1677	=back	2152	=back
1678		2153
1679	=head1 ENVIRONMENT	2154	=head1 ENVIRONMENT
1680		2155
…		…
1689		2164
1690	=item >= 3 - script loading and management	2165	=item >= 3 - script loading and management
1691		2166
1692	=item >=10 - all called hooks	2167	=item >=10 - all called hooks
1693		2168
1694	=item >=11 - hook reutrn values	2169	=item >=11 - hook return values
1695		2170
1696	=back	2171	=back
1697		2172
1698	=head1 AUTHOR	2173	=head1 AUTHOR
1699		2174
…		…
1701	http://software.schmorp.de/pkg/rxvt-unicode	2176	http://software.schmorp.de/pkg/rxvt-unicode
1702		2177
1703	=cut	2178	=cut
1704		2179
1705	1	2180	1
		2181
		2182	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.96 by root, Tue Jan 17 16:22:41 2006 UTC vs. Revision 1.171 by root, Fri Oct 10 00:11:44 2008 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.96 by root, Tue Jan 17 16:22:41 2006 UTC vs.
Revision 1.171 by root, Fri Oct 10 00:11:44 2008 UTC