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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC vs.
Revision 1.144 by root, Mon Aug 7 15:59:44 2006 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
…		…
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
39		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
…		…
58	URxvt.selection.pattern-1: perl-regex	62	URxvt.selection.pattern-1: perl-regex
59	...	63	...
60		64
61	The index number (0, 1...) must not have any holes, and each regex must	65	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	66	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	67	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	68	between two vertical bars:
65		69
66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		71
		72	Another example: Programs I use often output "absolute path: " at the
		73	beginning of a line when they process multiple files. The following
		74	pattern matches the filename (note, there is a single space at the very
		75	end):
		76
		77	URxvt.selection.pattern-0: ^(/[^:]+):\
67		78
68	You can look at the source of the selection extension to see more	79	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.	80	interesting uses, such as parsing a line from beginning to end.
70		81
71	This extension also offers following bindable keyboard commands:	82	This extension also offers following bindable keyboard commands:
…		…
83	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
84		95
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.	97	runtime.
87		98
		99	Other extensions can extend this popup menu by pushing a code reference
		100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		101	popup is being displayed.
		102
		103	It's sole argument is the popup menu, which can be modified. It should
		104	either return nothing or a string, the initial boolean value and a code
		105	reference. The string will be used as button text and the code reference
		106	will be called when the toggle changes, with the new boolean value as
		107	first argument.
		108
		109	The following will add an entry C<myoption> that changes
		110	C<$self->{myoption}>:
		111
		112	push @{ $self->{term}{option_popup_hook} }, sub {
		113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		114	};
		115
88	=item selection-popup (enabled by default)	116	=item selection-popup (enabled by default)
89		117
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	118	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	119	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	120	evaluation, web-browser starting etc.), depending on content.
		121
		122	Other extensions can extend this popup menu by pushing a code reference
		123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		124	popup is being displayed.
		125
		126	It's sole argument is the popup menu, which can be modified. The selection
		127	is in C<$_>, which can be used to decide whether to add something or not.
		128	It should either return nothing or a string and a code reference. The
		129	string will be used as button text and the code reference will be called
		130	when the button gets activated and should transform C<$_>.
		131
		132	The following will add an entry C<a to b> that transforms all C<a>s in
		133	the selection to C<b>s, but only if the selection currently contains any
		134	C<a>s:
		135
		136	push @{ $self->{term}{selection_popup_hook} }, sub {
		137	/a/ ? ("a to be" => sub { s/a/b/g }
		138	: ()
		139	};
93		140
94	=item searchable-scrollback<hotkey> (enabled by default)	141	=item searchable-scrollback<hotkey> (enabled by default)
95		142
96	Adds regex search functionality to the scrollback buffer, triggered	143	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
104	bottom. C<Escape> leaves search mode and returns to the point where search	151	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and	152	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary	153	additionally stores the first match in the current line into the primary
107	selection.	154	selection.
108		155
		156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		157	get a case-sensitive search you can delete this prefix using C<BackSpace>
		158	or simply use an uppercase character which removes the "(?i)" prefix.
		159
		160	See L<perlre> for more info about perl regular expression syntax.
		161
		162	=item readline (enabled by default)
		163
		164	A support package that tries to make editing with readline easier. At
		165	the moment, it reacts to clicking shift-left mouse button by trying to
		166	move the text cursor to this position. It does so by generating as many
		167	cursor-left or cursor-right keypresses as required (the this only works
		168	for programs that correctly support wide characters).
		169
		170	To avoid too many false positives, this is only done when:
		171
		172	=over 4
		173
		174	=item - the tty is in ICANON state.
		175
		176	=item - the text cursor is visible.
		177
		178	=item - the primary screen is currently being displayed.
		179
		180	=item - the mouse is on the same (multi-row-) line as the text cursor.
		181
		182	=back
		183
		184	The normal selection mechanism isn't disabled, so quick successive clicks
		185	might interfere with selection creation in harmless ways.
		186
109	=item selection-autotransform	187	=item selection-autotransform
110		188
111	This selection allows you to do automatic transforms on a selection	189	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	190	whenever a selection is made.
113		191
…		…
125	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		204
127	And this example matches the same,but replaces it with vi-commands you can	205	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	206	paste directly into your (vi :) editor:
129		207
130	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		209
132	Of course, this can be modified to suit your needs and your editor :)	210	Of course, this can be modified to suit your needs and your editor :)
133		211
134	To expand the example above to typical perl error messages ("XXX at	212	To expand the example above to typical perl error messages ("XXX at
135	FILENAME line YYY."), you need a slightly more elaborate solution:	213	FILENAME line YYY."), you need a slightly more elaborate solution:
136		214
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139		217
140	The first line tells the selection code to treat the unchanging part of	218	The first line tells the selection code to treat the unchanging part of
141	every error message as a selection pattern, and the second line transforms	219	every error message as a selection pattern, and the second line transforms
142	the message into vi commands to load the file.	220	the message into vi commands to load the file.
		221
		222	=item tabbed
		223
		224	This transforms the terminal into a tabbar with additional terminals, that
		225	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		227	button per tab.
		228
		229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		230	B<Shift-Right> will switch to the tab left or right of the current one,
		231	while B<Shift-Down> creates a new tab.
		232
		233	The tabbar itself can be configured similarly to a normal terminal, but
		234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		235	following four resources (shown with defaults):
		236
		237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		239	URxvt.tabbed.tab-fg: <colour-index, default 0>
		240	URxvt.tabbed.tab-bg: <colour-index, default 1>
		241
		242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		243	indices.
143		244
144	=item mark-urls	245	=item mark-urls
145		246
146	Uses per-line display filtering (C<on_line_update>) to underline urls and	247	Uses per-line display filtering (C<on_line_update>) to underline urls and
147	make them clickable. When middle-clicked, the program specified in the	248	make them clickable. When middle-clicked, the program specified in the
148	resource C<urlLauncher> (default C<x-www-browser>) will be started with	249	resource C<urlLauncher> (default C<x-www-browser>) will be started with
149	the URL as first argument.	250	the URL as first argument.
150		251
		252	=item xim-onthespot
		253
		254	This (experimental) perl extension implements OnTheSpot editing. It does
		255	not work perfectly, and some input methods don't seem to work well with
		256	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		257	kinput2.
		258
		259	You enable it by specifying this extension and a preedit style of
		260	C<OnTheSpot>, i.e.:
		261
		262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		263
		264	=item kuake<hotkey>
		265
		266	A very primitive quake-console-like extension. It was inspired by a
		267	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		268	user presses a global accelerator key (by default C<F10>), the terminal
		269	will show or hide itself. Another press of the accelerator key will hide
		270	or show it again.
		271
		272	Initially, the window will not be shown when using this extension.
		273
		274	This is useful if you need a single terminal thats not using any desktop
		275	space most of the time but is quickly available at the press of a key.
		276
		277	The accelerator key is grabbed regardless of any modifiers, so this
		278	extension will actually grab a physical key just for this function.
		279
		280	If you want a quake-like animation, tell your window manager to do so
		281	(fvwm can do it).
		282
		283	=item automove-background
		284
		285	This is basically a very small extension that dynamically changes the
		286	background pixmap offset to the window position, in effect creating the
		287	same effect as pseudo transparency with a custom pixmap. No scaling is
		288	supported in this mode. Example:
		289
		290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		291
151	=item block-graphics-to-ascii	292	=item block-graphics-to-ascii
152		293
153	A not very useful example of filtering all text output to the terminal,	294	A not very useful example of filtering all text output to the terminal
154	by replacing all line-drawing characters (U+2500 .. U+259F) by a	295	by replacing all line-drawing characters (U+2500 .. U+259F) by a
155	similar-looking ascii character.	296	similar-looking ascii character.
156		297
157	=item digital-clock	298	=item digital-clock
158		299
159	Displays a digital clock using the built-in overlay.	300	Displays a digital clock using the built-in overlay.
		301
		302	=item remote-clipboard
		303
		304	Somewhat of a misnomer, this extension adds two menu entries to the
		305	selection popup that allows one ti run external commands to store the
		306	selection somewhere and fetch it again.
		307
		308	We use it to implement a "distributed selection mechanism", which just
		309	means that one command uploads the file to a remote server, and another
		310	reads it.
		311
		312	The commands can be set using the C<URxvt.remote-selection.store> and
		313	C<URxvt.remote-selection.fetch> resources. The first should read the
		314	selection to store from STDIN (always in UTF-8), the second should provide
		315	the selection data on STDOUT (also in UTF-8).
		316
		317	The defaults (which are likely useless to you) use rsh and cat:
		318
		319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		321
		322	=item selection-pastebin
		323
		324	This is a little rarely useful extension that Uploads the selection as
		325	textfile to a remote site (or does other things). (The implementation is
		326	not currently secure for use in a multiuser environment as it writes to
		327	F</tmp> directly.).
		328
		329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		330	i.e.
		331
		332	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		333
		334	Pressing this combination runs a command with C<%> replaced by the name of
		335	the textfile. This command can be set via a resource:
		336
		337	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		338
		339	And the default is likely not useful to anybody but the few people around
		340	here :)
		341
		342	The name of the textfile is the hex encoded md5 sum of the selection, so
		343	the same content should lead to the same filename.
		344
		345	After a successful upload the selection will be replaced by the text given
		346	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		347	for the filename):
		348
		349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
160		350
161	=item example-refresh-hooks	351	=item example-refresh-hooks
162		352
163	Displays a very simple digital clock in the upper right corner of the	353	Displays a very simple digital clock in the upper right corner of the
164	window. Illustrates overwriting the refresh callbacks to create your own	354	window. Illustrates overwriting the refresh callbacks to create your own
165	overlays or changes.	355	overlays or changes.
166
167	=item selection-pastebin
168
169	This is a little rarely useful extension that Uploads the selection as
170	textfile to a remote site (or does other things).
171
172	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
173	i.e.
174
175	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
176
177	Pressing this combination runs a command with C<%> replaced by the name of
178	the textfile. This command can be set via a resource:
179
180	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
181
182	And the default is likely not useful to anybody but the few people around
183	here :)
184
185	The name of the textfile is the hex encoded md5 sum of the selection, so
186	the same content should lead to the same filename.
187
188	After a successful upload the selection will be replaced by the text given
189	in the C<selection-pastebin-url> resource (again, the % is the placeholder
190	for the filename):
191
192	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
193		356
194	=back	357	=back
195		358
196	=head1 API DOCUMENTATION	359	=head1 API DOCUMENTATION
197		360
…		…
231		394
232	=back	395	=back
233		396
234	=head2 Extension Objects	397	=head2 Extension Objects
235		398
236	Very perl extension is a perl class. A separate perl object is created	399	Every perl extension is a perl class. A separate perl object is created
237	for each terminal and each extension and passed as the first parameter to	400	for each terminal and each extension and passed as the first parameter to
238	hooks. So extensions can use their C<$self> object without having to think	401	hooks. So extensions can use their C<$self> object without having to think
239	about other extensions, with the exception of methods and members that	402	about other extensions, with the exception of methods and members that
240	begin with an underscore character C<_>: these are reserved for internal	403	begin with an underscore character C<_>: these are reserved for internal
241	use.	404	use.
…		…
267	=head2 Hooks	430	=head2 Hooks
268		431
269	The following subroutines can be declared in extension files, and will be	432	The following subroutines can be declared in extension files, and will be
270	called whenever the relevant event happens.	433	called whenever the relevant event happens.
271		434
272	The first argument passed to them is an extension oject as described in	435	The first argument passed to them is an extension object as described in
273	the in the C<Extension Objects> section.	436	the in the C<Extension Objects> section.
274		437
275	B<All> of these hooks must return a boolean value. If it is true, then the	438	B<All> of these hooks must return a boolean value. If any of the called
276	event counts as being I<consumed>, and the invocation of other hooks is	439	hooks returns true, then the event counts as being I<consumed>, and the
277	skipped, and the relevant action might not be carried out by the C++ code.	440	relevant action might not be carried out by the C++ code.
278		441
279	I<< When in doubt, return a false value (preferably C<()>). >>	442	I<< When in doubt, return a false value (preferably C<()>). >>
280		443
281	=over 4	444	=over 4
282		445
283	=item on_init $term	446	=item on_init $term
284		447
285	Called after a new terminal object has been initialized, but before	448	Called after a new terminal object has been initialized, but before
286	windows are created or the command gets run. Most methods are unsafe to	449	windows are created or the command gets run. Most methods are unsafe to
287	call or deliver senseless data, as terminal size and other characteristics	450	call or deliver senseless data, as terminal size and other characteristics
288	have not yet been determined. You can safely query and change resources,	451	have not yet been determined. You can safely query and change resources
289	though.	452	and options, though. For many purposes the C<on_start> hook is a better
		453	place.
		454
		455	=item on_start $term
		456
		457	Called at the very end of initialisation of a new terminal, just before
		458	trying to map (display) the toplevel and returning to the main loop.
		459
		460	=item on_destroy $term
		461
		462	Called whenever something tries to destroy terminal, when the terminal is
		463	still fully functional (not for long, though).
290		464
291	=item on_reset $term	465	=item on_reset $term
292		466
293	Called after the screen is "reset" for any reason, such as resizing or	467	Called after the screen is "reset" for any reason, such as resizing or
294	control sequences. Here is where you can react on changes to size-related	468	control sequences. Here is where you can react on changes to size-related
295	variables.	469	variables.
296		470
297	=item on_start $term	471	=item on_child_start $term, $pid
298		472
299	Called at the very end of initialisation of a new terminal, just before	473	Called just after the child process has been C<fork>ed.
300	returning to the mainloop.	474
		475	=item on_child_exit $term, $status
		476
		477	Called just after the child process has exited. C<$status> is the status
		478	from C<waitpid>.
301		479
302	=item on_sel_make $term, $eventtime	480	=item on_sel_make $term, $eventtime
303		481
304	Called whenever a selection has been made by the user, but before the	482	Called whenever a selection has been made by the user, but before the
305	selection text is copied, so changes to the beginning, end or type of the	483	selection text is copied, so changes to the beginning, end or type of the
…		…
312		490
313	Called whenever a selection has been copied, but before the selection is	491	Called whenever a selection has been copied, but before the selection is
314	requested from the server. The selection text can be queried and changed	492	requested from the server. The selection text can be queried and changed
315	by calling C<< $term->selection >>.	493	by calling C<< $term->selection >>.
316		494
317	Returning a true value aborts selection grabbing. It will still be hilighted.	495	Returning a true value aborts selection grabbing. It will still be highlighted.
318		496
319	=item on_sel_extend $term	497	=item on_sel_extend $term
320		498
321	Called whenever the user tries to extend the selection (e.g. with a double	499	Called whenever the user tries to extend the selection (e.g. with a double
322	click) and is either supposed to return false (normal operation), or	500	click) and is either supposed to return false (normal operation), or
323	should extend the selection itelf and return true to suppress the built-in	501	should extend the selection itself and return true to suppress the built-in
324	processing. This can happen multiple times, as long as the callback	502	processing. This can happen multiple times, as long as the callback
325	returns true, it will be called on every further click by the user and is	503	returns true, it will be called on every further click by the user and is
326	supposed to enlarge the selection more and more, if possible.	504	supposed to enlarge the selection more and more, if possible.
327		505
328	See the F<selection> example extension.	506	See the F<selection> example extension.
329		507
330	=item on_view_change $term, $offset	508	=item on_view_change $term, $offset
331		509
332	Called whenever the view offset changes, i..e the user or program	510	Called whenever the view offset changes, i.e. the user or program
333	scrolls. Offset C<0> means display the normal terminal, positive values	511	scrolls. Offset C<0> means display the normal terminal, positive values
334	show this many lines of scrollback.	512	show this many lines of scrollback.
335		513
336	=item on_scroll_back $term, $lines, $saved	514	=item on_scroll_back $term, $lines, $saved
337		515
…		…
341		519
342	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	520	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
343	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	521	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
344	number of lines that will be in the scrollback buffer.	522	number of lines that will be in the scrollback buffer.
345		523
		524	=item on_osc_seq $term, $op, $args
		525
		526	Called on every OSC sequence and can be used to suppress it or modify its
		527	behaviour. The default should be to return an empty list. A true value
		528	suppresses execution of the request completely. Make sure you don't get
		529	confused by recursive invocations when you output an osc sequence within
		530	this callback.
		531
		532	C<on_osc_seq_perl> should be used for new behaviour.
		533
346	=item on_osc_seq $term, $string	534	=item on_osc_seq_perl $term, $string
347		535
348	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	536	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
349	operating system command) is processed. Cursor position and other state	537	operating system command) is processed. Cursor position and other state
350	information is up-to-date when this happens. For interoperability, the	538	information is up-to-date when this happens. For interoperability, the
351	string should start with the extension name and a colon, to distinguish	539	string should start with the extension name and a colon, to distinguish
352	it from commands for other extensions, and this might be enforced in the	540	it from commands for other extensions, and this might be enforced in the
353	future.	541	future.
354		542
355	Be careful not ever to trust (in a security sense) the data you receive,	543	Be careful not ever to trust (in a security sense) the data you receive,
356	as its source can not easily be controleld (e-mail content, messages from	544	as its source can not easily be controlled (e-mail content, messages from
357	other users on the same system etc.).	545	other users on the same system etc.).
358		546
359	=item on_add_lines $term, $string	547	=item on_add_lines $term, $string
360		548
361	Called whenever text is about to be output, with the text as argument. You	549	Called whenever text is about to be output, with the text as argument. You
…		…
392		580
393	=item on_refresh_end $term	581	=item on_refresh_end $term
394		582
395	Called just after the screen gets redrawn. See C<on_refresh_begin>.	583	Called just after the screen gets redrawn. See C<on_refresh_begin>.
396		584
397	=item on_keyboard_command $term, $string	585	=item on_user_command $term, $string
398		586
399	Called whenever the user presses a key combination that has a	587	Called whenever a user-configured event is being activated (e.g. via
400	C<perl:string> action bound to it (see description of the B<keysym>	588	a C<perl:string> action bound to a key, see description of the B<keysym>
401	resource in the @@RXVT_NAME@@(1) manpage).	589	resource in the @@RXVT_NAME@@(1) manpage).
		590
		591	The event is simply the action string. This interface is assumed to change
		592	slightly in the future.
		593
		594	=item on_resize_all_windows $tern, $new_width, $new_height
		595
		596	Called just after the new window size has been calculated, but before
		597	windows are actually being resized or hints are being set. If this hook
		598	returns TRUE, setting of the window hints is being skipped.
402		599
403	=item on_x_event $term, $event	600	=item on_x_event $term, $event
404		601
405	Called on every X event received on the vt window (and possibly other	602	Called on every X event received on the vt window (and possibly other
406	windows). Should only be used as a last resort. Most event structure	603	windows). Should only be used as a last resort. Most event structure
407	members are not passed.	604	members are not passed.
408		605
		606	=item on_root_event $term, $event
		607
		608	Like C<on_x_event>, but is called for events on the root window.
		609
409	=item on_focus_in $term	610	=item on_focus_in $term
410		611
411	Called whenever the window gets the keyboard focus, before rxvt-unicode	612	Called whenever the window gets the keyboard focus, before rxvt-unicode
412	does focus in processing.	613	does focus in processing.
413		614
414	=item on_focus_out $term	615	=item on_focus_out $term
415		616
416	Called wheneever the window loses keyboard focus, before rxvt-unicode does	617	Called whenever the window loses keyboard focus, before rxvt-unicode does
417	focus out processing.	618	focus out processing.
		619
		620	=item on_configure_notify $term, $event
		621
		622	=item on_property_notify $term, $event
418		623
419	=item on_key_press $term, $event, $keysym, $octets	624	=item on_key_press $term, $event, $keysym, $octets
420		625
421	=item on_key_release $term, $event, $keysym	626	=item on_key_release $term, $event, $keysym
422		627
…		…
432		637
433	Called whenever the corresponding X event is received for the terminal If	638	Called whenever the corresponding X event is received for the terminal If
434	the hook returns true, then the even will be ignored by rxvt-unicode.	639	the hook returns true, then the even will be ignored by rxvt-unicode.
435		640
436	The event is a hash with most values as named by Xlib (see the XEvent	641	The event is a hash with most values as named by Xlib (see the XEvent
437	manpage), with the additional members C<row> and C<col>, which are the row	642	manpage), with the additional members C<row> and C<col>, which are the
438	and column under the mouse cursor.	643	(real, not screen-based) row and column under the mouse cursor.
439		644
440	C<on_key_press> additionally receives the string rxvt-unicode would	645	C<on_key_press> additionally receives the string rxvt-unicode would
441	output, if any, in locale-specific encoding.	646	output, if any, in locale-specific encoding.
442		647
443	subwindow.	648	subwindow.
		649
		650	=item on_client_message $term, $event
		651
		652	=item on_wm_protocols $term, $event
		653
		654	=item on_wm_delete_window $term, $event
		655
		656	Called when various types of ClientMessage events are received (all with
		657	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
444		658
445	=back	659	=back
446		660
447	=cut	661	=cut
448		662
…		…
454	use Scalar::Util ();	668	use Scalar::Util ();
455	use List::Util ();	669	use List::Util ();
456		670
457	our $VERSION = 1;	671	our $VERSION = 1;
458	our $TERM;	672	our $TERM;
		673	our @TERM_INIT;
		674	our @TERM_EXT;
459	our @HOOKNAME;	675	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	676	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	677	our %OPTION;
462		678
463	our $LIBDIR;	679	our $LIBDIR;
464	our $RESNAME;	680	our $RESNAME;
465	our $RESCLASS;	681	our $RESCLASS;
466	our $RXVTNAME;	682	our $RXVTNAME;
467		683
		684	our $NOCHAR = chr 0xffff;
		685
468	=head2 Variables in the C<urxvt> Package	686	=head2 Variables in the C<urxvt> Package
469		687
470	=over 4	688	=over 4
471		689
472	=item $urxvt::LIBDIR	690	=item $urxvt::LIBDIR
…		…
484		702
485	=item $urxvt::TERM	703	=item $urxvt::TERM
486		704
487	The current terminal. This variable stores the current C<urxvt::term>	705	The current terminal. This variable stores the current C<urxvt::term>
488	object, whenever a callback/hook is executing.	706	object, whenever a callback/hook is executing.
		707
		708	=item @urxvt::TERM_INIT
		709
		710	All code references in this array will be called as methods of the next newly
		711	created C<urxvt::term> object (during the C<on_init> phase). The array
		712	gets cleared before the code references that were in it are being executed,
		713	so references can push themselves onto it again if they so desire.
		714
		715	This complements to the perl-eval command line option, but gets executed
		716	first.
		717
		718	=item @urxvt::TERM_EXT
		719
		720	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		721	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		722	but before other extensions. Gets cleared just like C<@TERM_INIT>.
489		723
490	=back	724	=back
491		725
492	=head2 Functions in the C<urxvt> Package	726	=head2 Functions in the C<urxvt> Package
493		727
…		…
507		741
508	Using this function has the advantage that its output ends up in the	742	Using this function has the advantage that its output ends up in the
509	correct place, e.g. on stderr of the connecting urxvtc client.	743	correct place, e.g. on stderr of the connecting urxvtc client.
510		744
511	Messages have a size limit of 1023 bytes currently.	745	Messages have a size limit of 1023 bytes currently.
		746
		747	=item @terms = urxvt::termlist
		748
		749	Returns all urxvt::term objects that exist in this process, regardless of
		750	whether they are started, being destroyed etc., so be careful. Only term
		751	objects that have perl extensions attached will be returned (because there
		752	is no urxvt::term objet associated with others).
512		753
513	=item $time = urxvt::NOW	754	=item $time = urxvt::NOW
514		755
515	Returns the "current time" (as per the event loop).	756	Returns the "current time" (as per the event loop).
516		757
…		…
575		816
576	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	817	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
577		818
578	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	819	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
579		820
		821	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		822
580	Replace the foreground/background colour in the rendition mask with the	823	Replace the foreground/background colour in the rendition mask with the
581	specified one.	824	specified one.
582		825
583	=item $value = urxvt::GET_CUSTOM $rend	826	=item $value = urxvt::GET_CUSTOM $rend
584		827
…		…
593	=back	836	=back
594		837
595	=cut	838	=cut
596		839
597	BEGIN {	840	BEGIN {
598	urxvt->bootstrap;
599
600	# overwrite perl's warn	841	# overwrite perl's warn
601	*CORE::GLOBAL::warn = sub {	842	*CORE::GLOBAL::warn = sub {
602	my $msg = join "", @_;	843	my $msg = join "", @_;
603	$msg .= "\n"	844	$msg .= "\n"
604	unless $msg =~ /\n$/;	845	unless $msg =~ /\n$/;
605	urxvt::warn ($msg);	846	urxvt::warn ($msg);
606	};	847	};
607
608	# %ENV is the original startup environment
609	delete $ENV{IFS};
610	delete $ENV{CDPATH};
611	delete $ENV{BASH_ENV};
612	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
613	}	848	}
		849
		850	no warnings 'utf8';
614		851
615	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	852	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
616		853
617	sub verbose {	854	sub verbose {
618	my ($level, $msg) = @_;	855	my ($level, $msg) = @_;
619	warn "$msg\n" if $level <= $verbosity;	856	warn "$msg\n" if $level <= $verbosity;
620	}	857	}
621		858
622	my $extension_pkg = "extension0000";
623	my %extension_pkg;	859	my %extension_pkg;
624		860
625	# load a single script into its own package, once only	861	# load a single script into its own package, once only
626	sub extension_package($) {	862	sub extension_package($) {
627	my ($path) = @_;	863	my ($path) = @_;
628		864
629	$extension_pkg{$path} \|\|= do {	865	$extension_pkg{$path} \|\|= do {
630	my $pkg = "urxvt::" . ($extension_pkg++);	866	$path =~ /([^\/\\]+)$/;
		867	my $pkg = $1;
		868	$pkg =~ s/[^[:word:]]/_/g;
		869	$pkg = "urxvt::ext::$pkg";
631		870
632	verbose 3, "loading extension '$path' into package '$pkg'";	871	verbose 3, "loading extension '$path' into package '$pkg'";
633		872
634	open my $fh, "<:raw", $path	873	open my $fh, "<:raw", $path
635	or die "$path: $!";	874	or die "$path: $!";
636		875
637	my $source =	876	my $source =
638	"package $pkg; use strict; use utf8;\n"	877	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
639	. "use base urxvt::term::extension::;\n"
640	. "#line 1 \"$path\"\n{\n"	878	. "#line 1 \"$path\"\n{\n"
641	. (do { local $/; <$fh> })	879	. (do { local $/; <$fh> })
642	. "\n};\n1";	880	. "\n};\n1";
643		881
644	eval $source	882	eval $source
…		…
658	if ($htype == 0) { # INIT	896	if ($htype == 0) { # INIT
659	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	897	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
660		898
661	my %ext_arg;	899	my %ext_arg;
662		900
		901	{
		902	my @init = @TERM_INIT;
		903	@TERM_INIT = ();
		904	$_->($TERM) for @init;
		905	my @pkg = @TERM_EXT;
		906	@TERM_EXT = ();
		907	$TERM->register_package ($_) for @pkg;
		908	}
		909
663	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	910	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
664	if ($_ eq "default") {	911	if ($_ eq "default") {
665	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	912	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
666	} elsif (/^-(.*)$/) {	913	} elsif (/^-(.*)$/) {
667	delete $ext_arg{$1};	914	delete $ext_arg{$1};
668	} elsif (/^([^<]+)<(.*)>$/) {	915	} elsif (/^([^<]+)<(.*)>$/) {
669	push @{ $ext_arg{$1} }, $2;	916	push @{ $ext_arg{$1} }, $2;
670	} else {	917	} else {
671	$ext_arg{$_} \|\|= [];	918	$ext_arg{$_} \|\|= [];
672	}	919	}
673	}	920	}
674		921
675	while (my ($ext, $argv) = each %ext_arg) {	922	for my $ext (sort keys %ext_arg) {
676	my @files = grep -f $_, map "$_/$ext", @dirs;	923	my @files = grep -f $_, map "$_/$ext", @dirs;
677		924
678	if (@files) {	925	if (@files) {
679	$TERM->register_package (extension_package $files[0], $argv);	926	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
680	} else {	927	} else {
681	warn "perl extension '$ext' not found in perl library search path\n";	928	warn "perl extension '$ext' not found in perl library search path\n";
682	}	929	}
683	}	930	}
684		931
…		…
690		937
691	if (my $cb = $TERM->{_hook}[$htype]) {	938	if (my $cb = $TERM->{_hook}[$htype]) {
692	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	939	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
693	if $verbosity >= 10;	940	if $verbosity >= 10;
694		941
695	keys %$cb;	942	for my $pkg (keys %$cb) {
696
697	while (my ($pkg, $cb) = each %$cb) {
698	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	943	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
699	and last;	944	$retval \|\|= $retval_;
700		945
701	if ($@) {	946	if ($@) {
702	$TERM->ungrab; # better to lose the grab than the session	947	$TERM->ungrab; # better to lose the grab than the session
703	warn $@;	948	warn $@;
704	}	949	}
…		…
717	}	962	}
718		963
719	$retval	964	$retval
720	}	965	}
721		966
722	sub exec_async(@) {	967	sub SET_COLOR($$$) {
723	my $pid = fork;	968	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
724
725	return
726	if !defined $pid or $pid;
727
728	%ENV = %{ $TERM->env };
729
730	exec @_;
731	_exit 255;
732	}	969	}
733		970
734	# urxvt::term::extension	971	# urxvt::term::extension
735		972
736	package urxvt::term::extension;	973	package urxvt::term::extension;
…		…
875	# find on_xxx subs in the package and register them	1112	# find on_xxx subs in the package and register them
876	# as hooks	1113	# as hooks
877	sub register_package {	1114	sub register_package {
878	my ($self, $pkg, $argv) = @_;	1115	my ($self, $pkg, $argv) = @_;
879		1116
		1117	no strict 'refs';
		1118
		1119	urxvt::verbose 6, "register package $pkg to $self";
		1120
		1121	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1122
880	my $proxy = bless {	1123	my $proxy = bless {
881	_pkg => $pkg,	1124	_pkg => $pkg,
882	argv => $argv,	1125	argv => $argv,
883	}, $pkg;	1126	}, $pkg;
884	Scalar::Util::weaken ($proxy->{term} = $self);	1127	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
899	hash which defines the environment of the new terminal.	1142	hash which defines the environment of the new terminal.
900		1143
901	Croaks (and probably outputs an error message) if the new instance	1144	Croaks (and probably outputs an error message) if the new instance
902	couldn't be created. Returns C<undef> if the new instance didn't	1145	couldn't be created. Returns C<undef> if the new instance didn't
903	initialise perl, and the terminal object otherwise. The C<init> and	1146	initialise perl, and the terminal object otherwise. The C<init> and
904	C<start> hooks will be called during this call.	1147	C<start> hooks will be called before this call returns, and are free to
		1148	refer to global data (which is race free).
905		1149
906	=cut	1150	=cut
907		1151
908	sub new {	1152	sub new {
909	my ($class, $env, @args) = @_;	1153	my ($class, $env, @args) = @_;
910		1154
		1155	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1156	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1157
911	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1158	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
912	}	1159	}
913		1160
914	=item $term->destroy	1161	=item $term->destroy
915		1162
916	Destroy the terminal object (close the window, free resources	1163	Destroy the terminal object (close the window, free resources
917	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1164	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
918	watchers (timers, io watchers) are still active.	1165	watchers (timers, io watchers) are still active.
919		1166
		1167	=item $term->exec_async ($cmd[, @args])
		1168
		1169	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1170	("starts") programs in the background. This function takes care of setting
		1171	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1172	be preferred over explicit calls to C<exec> or C<system>.
		1173
		1174	Returns the pid of the subprocess or C<undef> on error.
		1175
		1176	=cut
		1177
		1178	sub exec_async {
		1179	my $self = shift;
		1180
		1181	my $pid = fork;
		1182
		1183	return $pid
		1184	if !defined $pid or $pid;
		1185
		1186	%ENV = %{ $self->env };
		1187
		1188	exec @_;
		1189	urxvt::_exit 255;
		1190	}
		1191
920	=item $isset = $term->option ($optval[, $set])	1192	=item $isset = $term->option ($optval[, $set])
921		1193
922	Returns true if the option specified by C<$optval> is enabled, and	1194	Returns true if the option specified by C<$optval> is enabled, and
923	optionally change it. All option values are stored by name in the hash	1195	optionally change it. All option values are stored by name in the hash
924	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1196	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
925		1197
926	Here is a a likely non-exhaustive list of option names, please see the	1198	Here is a likely non-exhaustive list of option names, please see the
927	source file F</src/optinc.h> to see the actual list:	1199	source file F</src/optinc.h> to see the actual list:
928		1200
929	borderLess console cursorBlink cursorUnderline hold iconic insecure	1201	borderLess console cursorBlink cursorUnderline hold iconic insecure
930	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1202	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
931	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1203	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
932	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1204	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
933	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1205	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
934	tripleclickwords utmpInhibit visualBell	1206	transparent tripleclickwords utmpInhibit visualBell
935		1207
936	=item $value = $term->resource ($name[, $newval])	1208	=item $value = $term->resource ($name[, $newval])
937		1209
938	Returns the current resource value associated with a given name and	1210	Returns the current resource value associated with a given name and
939	optionally sets a new value. Setting values is most useful in the C<init>	1211	optionally sets a new value. Setting values is most useful in the C<init>
…		…
948	likely change).	1220	likely change).
949		1221
950	Please note that resource strings will currently only be freed when the	1222	Please note that resource strings will currently only be freed when the
951	terminal is destroyed, so changing options frequently will eat memory.	1223	terminal is destroyed, so changing options frequently will eat memory.
952		1224
953	Here is a a likely non-exhaustive list of resource names, not all of which	1225	Here is a likely non-exhaustive list of resource names, not all of which
954	are supported in every build, please see the source file F</src/rsinc.h>	1226	are supported in every build, please see the source file F</src/rsinc.h>
955	to see the actual list:	1227	to see the actual list:
956		1228
957	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1229	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
958	borderLess color cursorBlink cursorUnderline cutchars delete_key	1230	borderLess color cursorBlink cursorUnderline cutchars delete_key
959	display_name embed ext_bwidth fade font geometry hold iconName	1231	display_name embed ext_bwidth fade font geometry hold iconName
960	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1232	imFont imLocale inputMethod insecure int_bwidth intensityStyles
961	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1233	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
962	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1234	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
963	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1235	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
964	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1236	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
965	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1237	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
966	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1238	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
967	shade term_name title transparent transparent_all tripleclickwords	1239	secondaryScreen secondaryScroll selectstyle shade term_name title
968	utmpInhibit visualBell	1240	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1241	visualBell
969		1242
970	=cut	1243	=cut
971		1244
972	sub resource($$;$) {	1245	sub resource($$;$) {
973	my ($self, $name) = (shift, shift);	1246	my ($self, $name) = (shift, shift);
…		…
1147		1420
1148	Normally its not a good idea to use this function, as programs might be	1421	Normally its not a good idea to use this function, as programs might be
1149	confused by changes in cursor position or scrolling. Its useful inside a	1422	confused by changes in cursor position or scrolling. Its useful inside a
1150	C<on_add_lines> hook, though.	1423	C<on_add_lines> hook, though.
1151		1424
		1425	=item $term->scr_change_screen ($screen)
		1426
		1427	Switch to given screen - 0 primary, 1 secondary.
		1428
1152	=item $term->cmd_parse ($octets)	1429	=item $term->cmd_parse ($octets)
1153		1430
1154	Similar to C<scr_add_lines>, but the argument must be in the	1431	Similar to C<scr_add_lines>, but the argument must be in the
1155	locale-specific encoding of the terminal and can contain command sequences	1432	locale-specific encoding of the terminal and can contain command sequences
1156	(escape codes) that will be interpreted.	1433	(escape codes) that will be interpreted.
…		…
1166	Replaces the event mask of the pty watcher by the given event mask. Can	1443	Replaces the event mask of the pty watcher by the given event mask. Can
1167	be used to suppress input and output handling to the pty/tty. See the	1444	be used to suppress input and output handling to the pty/tty. See the
1168	description of C<< urxvt::timer->events >>. Make sure to always restore	1445	description of C<< urxvt::timer->events >>. Make sure to always restore
1169	the previous value.	1446	the previous value.
1170		1447
		1448	=item $fd = $term->pty_fd
		1449
		1450	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1451	is used.
		1452
1171	=item $windowid = $term->parent	1453	=item $windowid = $term->parent
1172		1454
1173	Return the window id of the toplevel window.	1455	Return the window id of the toplevel window.
1174		1456
1175	=item $windowid = $term->vt	1457	=item $windowid = $term->vt
…		…
1181	Adds the specified events to the vt event mask. Useful e.g. when you want	1463	Adds the specified events to the vt event mask. Useful e.g. when you want
1182	to receive pointer events all the times:	1464	to receive pointer events all the times:
1183		1465
1184	$term->vt_emask_add (urxvt::PointerMotionMask);	1466	$term->vt_emask_add (urxvt::PointerMotionMask);
1185		1467
		1468	=item $term->focus_in
		1469
		1470	=item $term->focus_out
		1471
		1472	=item $term->key_press ($state, $keycode[, $time])
		1473
		1474	=item $term->key_release ($state, $keycode[, $time])
		1475
		1476	Deliver various fake events to to terminal.
		1477
1186	=item $window_width = $term->width	1478	=item $window_width = $term->width
1187		1479
1188	=item $window_height = $term->height	1480	=item $window_height = $term->height
1189		1481
1190	=item $font_width = $term->fwidth	1482	=item $font_width = $term->fwidth
…		…
1220	=item $env = $term->env	1512	=item $env = $term->env
1221		1513
1222	Returns a copy of the environment in effect for the terminal as a hashref	1514	Returns a copy of the environment in effect for the terminal as a hashref
1223	similar to C<\%ENV>.	1515	similar to C<\%ENV>.
1224		1516
		1517	=item @envv = $term->envv
		1518
		1519	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1520
		1521	=item @argv = $term->argv
		1522
		1523	Return the argument vector as this terminal, similar to @ARGV, but
		1524	includes the program name as first element.
		1525
1225	=cut	1526	=cut
1226		1527
1227	sub env {	1528	sub env {
1228	if (my $env = $_[0]->_env) {
1229	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1529	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1230	} else {
1231	+{ %ENV }
1232	}
1233	}	1530	}
1234		1531
1235	=item $modifiermask = $term->ModLevel3Mask	1532	=item $modifiermask = $term->ModLevel3Mask
1236		1533
1237	=item $modifiermask = $term->ModMetaMask	1534	=item $modifiermask = $term->ModMetaMask
1238		1535
1239	=item $modifiermask = $term->ModNumLockMask	1536	=item $modifiermask = $term->ModNumLockMask
1240		1537
1241	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1538	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1242	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1539	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1540
		1541	=item $screen = $term->current_screen
		1542
		1543	Returns the currently displayed screen (0 primary, 1 secondary).
		1544
		1545	=item $cursor_is_hidden = $term->hidden_cursor
		1546
		1547	Returns whether the cursor is currently hidden or not.
1243		1548
1244	=item $view_start = $term->view_start ([$newvalue])	1549	=item $view_start = $term->view_start ([$newvalue])
1245		1550
1246	Returns the row number of the topmost displayed line. Maximum value is	1551	Returns the row number of the topmost displayed line. Maximum value is
1247	C<0>, which displays the normal terminal contents. Lower values scroll	1552	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1267	line, starting at column C<$start_col> (default C<0>), which is useful	1572	line, starting at column C<$start_col> (default C<0>), which is useful
1268	to replace only parts of a line. The font index in the rendition will	1573	to replace only parts of a line. The font index in the rendition will
1269	automatically be updated.	1574	automatically be updated.
1270		1575
1271	C<$text> is in a special encoding: tabs and wide characters that use more	1576	C<$text> is in a special encoding: tabs and wide characters that use more
1272	than one cell when displayed are padded with urxvt::NOCHAR characters	1577	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1273	(C<chr 65535>). Characters with combining characters and other characters	1578	characters. Characters with combining characters and other characters that
1274	that do not fit into the normal tetx encoding will be replaced with	1579	do not fit into the normal tetx encoding will be replaced with characters
1275	characters in the private use area.	1580	in the private use area.
1276		1581
1277	You have to obey this encoding when changing text. The advantage is	1582	You have to obey this encoding when changing text. The advantage is
1278	that C<substr> and similar functions work on screen cells and not on	1583	that C<substr> and similar functions work on screen cells and not on
1279	characters.	1584	characters.
1280		1585
…		…
1424	where one character corresponds to one screen cell. See	1729	where one character corresponds to one screen cell. See
1425	C<< $term->ROW_t >> for details.	1730	C<< $term->ROW_t >> for details.
1426		1731
1427	=item $string = $term->special_decode $text	1732	=item $string = $term->special_decode $text
1428		1733
1429	Converts rxvt-unicodes text reprsentation into a perl string. See	1734	Converts rxvt-unicodes text representation into a perl string. See
1430	C<< $term->ROW_t >> for details.	1735	C<< $term->ROW_t >> for details.
1431		1736
1432	=item $success = $term->grab_button ($button, $modifiermask)	1737	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1433		1738
		1739	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1740
1434	Registers a synchronous button grab. See the XGrabButton manpage.	1741	Register/unregister a synchronous button grab. See the XGrabButton
		1742	manpage.
1435		1743
1436	=item $success = $term->grab ($eventtime[, $sync])	1744	=item $success = $term->grab ($eventtime[, $sync])
1437		1745
1438	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1746	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1439	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1747	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1440		1748
1441	=item $term->allow_events_async	1749	=item $term->allow_events_async
1442		1750
1443	Calls XAllowEvents with AsyncBoth for the most recent grab.	1751	Calls XAllowEvents with AsyncBoth for the most recent grab.
1444		1752
…		…
1454	=item $term->ungrab	1762	=item $term->ungrab
1455		1763
1456	Calls XUngrab for the most recent grab. Is called automatically on	1764	Calls XUngrab for the most recent grab. Is called automatically on
1457	evaluation errors, as it is better to lose the grab in the error case as	1765	evaluation errors, as it is better to lose the grab in the error case as
1458	the session.	1766	the session.
		1767
		1768	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1769
		1770	=item $atom_name = $term->XGetAtomName ($atom)
		1771
		1772	=item @atoms = $term->XListProperties ($window)
		1773
		1774	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1775
		1776	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1777
		1778	=item $term->XDeleteProperty ($window, $property)
		1779
		1780	=item $window = $term->DefaultRootWindow
		1781
		1782	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1783
		1784	=item $term->XMapWindow ($window)
		1785
		1786	=item $term->XUnmapWindow ($window)
		1787
		1788	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1789
		1790	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1791
		1792	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1793
		1794	Various X or X-related functions. The C<$term> object only serves as
		1795	the source of the display, otherwise those functions map more-or-less
		1796	directory onto the X functions of the same name.
1459		1797
1460	=back	1798	=back
1461		1799
1462	=cut	1800	=cut
1463		1801
…		…
1527	my ($self, $text, $cb) = @_;	1865	my ($self, $text, $cb) = @_;
1528		1866
1529	$self->add_item ({ type => "button", text => $text, activate => $cb});	1867	$self->add_item ({ type => "button", text => $text, activate => $cb});
1530	}	1868	}
1531		1869
1532	=item $popup->add_toggle ($text, $cb, $initial_value)	1870	=item $popup->add_toggle ($text, $initial_value, $cb)
1533		1871
1534	Adds a toggle/checkbox item to the popup. Teh callback gets called	1872	Adds a toggle/checkbox item to the popup. The callback gets called
1535	whenever it gets toggled, with a boolean indicating its value as its first	1873	whenever it gets toggled, with a boolean indicating its new value as its
1536	argument.	1874	first argument.
1537		1875
1538	=cut	1876	=cut
1539		1877
1540	sub add_toggle {	1878	sub add_toggle {
1541	my ($self, $text, $cb, $value) = @_;	1879	my ($self, $text, $value, $cb) = @_;
1542		1880
1543	my $item; $item = {	1881	my $item; $item = {
1544	type => "button",	1882	type => "button",
1545	text => " $text",	1883	text => " $text",
1546	value => $value,	1884	value => $value,
…		…
1565	my $env = $self->{term}->env;	1903	my $env = $self->{term}->env;
1566	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1904	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1567	delete $env->{LC_ALL};	1905	delete $env->{LC_ALL};
1568	$env->{LC_CTYPE} = $self->{term}->locale;	1906	$env->{LC_CTYPE} = $self->{term}->locale;
1569		1907
1570	urxvt::term->new ($env, $self->{term}->resource ("name"),	1908	urxvt::term->new ($env, "popup",
1571	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1909	"--perl-lib" => "", "--perl-ext-common" => "",
		1910	"-pty-fd" => -1, "-sl" => 0,
		1911	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1572	"--transient-for" => $self->{term}->parent,	1912	"--transient-for" => $self->{term}->parent,
1573	"-display" => $self->{term}->display_id,	1913	"-display" => $self->{term}->display_id,
1574	"-pe" => "urxvt-popup")	1914	"-pe" => "urxvt-popup")
1575	or die "unable to create popup window\n";	1915	or die "unable to create popup window\n";
1576	}	1916	}
…		…
1581	delete $self->{term}{_destroy}{$self};	1921	delete $self->{term}{_destroy}{$self};
1582	$self->{term}->ungrab;	1922	$self->{term}->ungrab;
1583	}	1923	}
1584		1924
1585	=back	1925	=back
		1926
		1927	=cut
		1928
		1929	package urxvt::watcher;
		1930
		1931	@urxvt::timer::ISA = __PACKAGE__;
		1932	@urxvt::iow::ISA = __PACKAGE__;
		1933	@urxvt::pw::ISA = __PACKAGE__;
		1934	@urxvt::iw::ISA = __PACKAGE__;
1586		1935
1587	=head2 The C<urxvt::timer> Class	1936	=head2 The C<urxvt::timer> Class
1588		1937
1589	This class implements timer watchers/events. Time is represented as a	1938	This class implements timer watchers/events. Time is represented as a
1590	fractional number of seconds since the epoch. Example:	1939	fractional number of seconds since the epoch. Example:
…		…
1628	Start the timer.	1977	Start the timer.
1629		1978
1630	=item $timer = $timer->start ($tstamp)	1979	=item $timer = $timer->start ($tstamp)
1631		1980
1632	Set the event trigger time to C<$tstamp> and start the timer.	1981	Set the event trigger time to C<$tstamp> and start the timer.
		1982
		1983	=item $timer = $timer->after ($delay)
		1984
		1985	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1633		1986
1634	=item $timer = $timer->stop	1987	=item $timer = $timer->stop
1635		1988
1636	Stop the timer.	1989	Stop the timer.
1637		1990
…		…
1666	Set the callback to be called when io events are triggered. C<$reventmask>	2019	Set the callback to be called when io events are triggered. C<$reventmask>
1667	is a bitset as described in the C<events> method.	2020	is a bitset as described in the C<events> method.
1668		2021
1669	=item $iow = $iow->fd ($fd)	2022	=item $iow = $iow->fd ($fd)
1670		2023
1671	Set the filedescriptor (not handle) to watch.	2024	Set the file descriptor (not handle) to watch.
1672		2025
1673	=item $iow = $iow->events ($eventmask)	2026	=item $iow = $iow->events ($eventmask)
1674		2027
1675	Set the event mask to watch. The only allowed values are	2028	Set the event mask to watch. The only allowed values are
1676	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2029	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
…		…
1680		2033
1681	Start watching for requested events on the given handle.	2034	Start watching for requested events on the given handle.
1682		2035
1683	=item $iow = $iow->stop	2036	=item $iow = $iow->stop
1684		2037
1685	Stop watching for events on the given filehandle.	2038	Stop watching for events on the given file handle.
		2039
		2040	=back
		2041
		2042	=head2 The C<urxvt::iw> Class
		2043
		2044	This class implements idle watchers, that get called automatically when
		2045	the process is idle. They should return as fast as possible, after doing
		2046	some useful work.
		2047
		2048	=over 4
		2049
		2050	=item $iw = new urxvt::iw
		2051
		2052	Create a new idle watcher object in stopped state.
		2053
		2054	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2055
		2056	Set the callback to be called when the watcher triggers.
		2057
		2058	=item $timer = $timer->start
		2059
		2060	Start the watcher.
		2061
		2062	=item $timer = $timer->stop
		2063
		2064	Stop the watcher.
		2065
		2066	=back
		2067
		2068	=head2 The C<urxvt::pw> Class
		2069
		2070	This class implements process watchers. They create an event whenever a
		2071	process exits, after which they stop automatically.
		2072
		2073	my $pid = fork;
		2074	...
		2075	$term->{pw} = urxvt::pw
		2076	->new
		2077	->start ($pid)
		2078	->cb (sub {
		2079	my ($pw, $exit_status) = @_;
		2080	...
		2081	});
		2082
		2083	=over 4
		2084
		2085	=item $pw = new urxvt::pw
		2086
		2087	Create a new process watcher in stopped state.
		2088
		2089	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2090
		2091	Set the callback to be called when the timer triggers.
		2092
		2093	=item $pw = $timer->start ($pid)
		2094
		2095	Tells the watcher to start watching for process C<$pid>.
		2096
		2097	=item $pw = $pw->stop
		2098
		2099	Stop the watcher.
1686		2100
1687	=back	2101	=back
1688		2102
1689	=head1 ENVIRONMENT	2103	=head1 ENVIRONMENT
1690		2104
…		…
1699		2113
1700	=item >= 3 - script loading and management	2114	=item >= 3 - script loading and management
1701		2115
1702	=item >=10 - all called hooks	2116	=item >=10 - all called hooks
1703		2117
1704	=item >=11 - hook reutrn values	2118	=item >=11 - hook return values
1705		2119
1706	=back	2120	=back
1707		2121
1708	=head1 AUTHOR	2122	=head1 AUTHOR
1709		2123

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC vs. Revision 1.144 by root, Mon Aug 7 15:59:44 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC vs.
Revision 1.144 by root, Mon Aug 7 15:59:44 2006 UTC