[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.145 by root, Thu Aug 10 22:53:20 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 terminal has its own set of extenion objects,
238	hooks. So extensions can use their C<$self> object without having to think	401	which are passed as the first parameter to hooks. So extensions can use
239	about other extensions, with the exception of methods and members that	402	their C<$self> object without having to think about clashes with other
		403	extensions or other terminals, with the exception of methods and members
240	begin with an underscore character C<_>: these are reserved for internal	404	that begin with an underscore character C<_>: these are reserved for
241	use.	405	internal use.
242		406
243	Although it isn't a C<urxvt::term> object, you can call all methods of the	407	Although it isn't a C<urxvt::term> object, you can call all methods of the
244	C<urxvt::term> class on this object.	408	C<urxvt::term> class on this object.
245		409
246	It has the following methods and data members:	410	It has the following methods and data members:
…		…
267	=head2 Hooks	431	=head2 Hooks
268		432
269	The following subroutines can be declared in extension files, and will be	433	The following subroutines can be declared in extension files, and will be
270	called whenever the relevant event happens.	434	called whenever the relevant event happens.
271		435
272	The first argument passed to them is an extension oject as described in	436	The first argument passed to them is an extension object as described in
273	the in the C<Extension Objects> section.	437	the in the C<Extension Objects> section.
274		438
275	B<All> of these hooks must return a boolean value. If it is true, then the	439	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	440	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.	441	relevant action might not be carried out by the C++ code.
278		442
279	I<< When in doubt, return a false value (preferably C<()>). >>	443	I<< When in doubt, return a false value (preferably C<()>). >>
280		444
281	=over 4	445	=over 4
282		446
283	=item on_init $term	447	=item on_init $term
284		448
285	Called after a new terminal object has been initialized, but before	449	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	450	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	451	call or deliver senseless data, as terminal size and other characteristics
288	have not yet been determined. You can safely query and change resources,	452	have not yet been determined. You can safely query and change resources
289	though.	453	and options, though. For many purposes the C<on_start> hook is a better
		454	place.
		455
		456	=item on_start $term
		457
		458	Called at the very end of initialisation of a new terminal, just before
		459	trying to map (display) the toplevel and returning to the main loop.
		460
		461	=item on_destroy $term
		462
		463	Called whenever something tries to destroy terminal, when the terminal is
		464	still fully functional (not for long, though).
290		465
291	=item on_reset $term	466	=item on_reset $term
292		467
293	Called after the screen is "reset" for any reason, such as resizing or	468	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	469	control sequences. Here is where you can react on changes to size-related
295	variables.	470	variables.
296		471
297	=item on_start $term	472	=item on_child_start $term, $pid
298		473
299	Called at the very end of initialisation of a new terminal, just before	474	Called just after the child process has been C<fork>ed.
300	returning to the mainloop.	475
		476	=item on_child_exit $term, $status
		477
		478	Called just after the child process has exited. C<$status> is the status
		479	from C<waitpid>.
301		480
302	=item on_sel_make $term, $eventtime	481	=item on_sel_make $term, $eventtime
303		482
304	Called whenever a selection has been made by the user, but before the	483	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	484	selection text is copied, so changes to the beginning, end or type of the
…		…
312		491
313	Called whenever a selection has been copied, but before the selection is	492	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	493	requested from the server. The selection text can be queried and changed
315	by calling C<< $term->selection >>.	494	by calling C<< $term->selection >>.
316		495
317	Returning a true value aborts selection grabbing. It will still be hilighted.	496	Returning a true value aborts selection grabbing. It will still be highlighted.
318		497
319	=item on_sel_extend $term	498	=item on_sel_extend $term
320		499
321	Called whenever the user tries to extend the selection (e.g. with a double	500	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	501	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	502	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	503	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	504	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.	505	supposed to enlarge the selection more and more, if possible.
327		506
328	See the F<selection> example extension.	507	See the F<selection> example extension.
329		508
330	=item on_view_change $term, $offset	509	=item on_view_change $term, $offset
331		510
332	Called whenever the view offset changes, i..e the user or program	511	Called whenever the view offset changes, i.e. the user or program
333	scrolls. Offset C<0> means display the normal terminal, positive values	512	scrolls. Offset C<0> means display the normal terminal, positive values
334	show this many lines of scrollback.	513	show this many lines of scrollback.
335		514
336	=item on_scroll_back $term, $lines, $saved	515	=item on_scroll_back $term, $lines, $saved
337		516
…		…
341		520
342	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	521	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	522	$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.	523	number of lines that will be in the scrollback buffer.
345		524
		525	=item on_osc_seq $term, $op, $args
		526
		527	Called on every OSC sequence and can be used to suppress it or modify its
		528	behaviour. The default should be to return an empty list. A true value
		529	suppresses execution of the request completely. Make sure you don't get
		530	confused by recursive invocations when you output an osc sequence within
		531	this callback.
		532
		533	C<on_osc_seq_perl> should be used for new behaviour.
		534
346	=item on_osc_seq $term, $string	535	=item on_osc_seq_perl $term, $string
347		536
348	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	537	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
349	operating system command) is processed. Cursor position and other state	538	operating system command) is processed. Cursor position and other state
350	information is up-to-date when this happens. For interoperability, the	539	information is up-to-date when this happens. For interoperability, the
351	string should start with the extension name and a colon, to distinguish	540	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	541	it from commands for other extensions, and this might be enforced in the
353	future.	542	future.
354		543
355	Be careful not ever to trust (in a security sense) the data you receive,	544	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	545	as its source can not easily be controlled (e-mail content, messages from
357	other users on the same system etc.).	546	other users on the same system etc.).
358		547
359	=item on_add_lines $term, $string	548	=item on_add_lines $term, $string
360		549
361	Called whenever text is about to be output, with the text as argument. You	550	Called whenever text is about to be output, with the text as argument. You
…		…
392		581
393	=item on_refresh_end $term	582	=item on_refresh_end $term
394		583
395	Called just after the screen gets redrawn. See C<on_refresh_begin>.	584	Called just after the screen gets redrawn. See C<on_refresh_begin>.
396		585
397	=item on_keyboard_command $term, $string	586	=item on_user_command $term, $string
398		587
399	Called whenever the user presses a key combination that has a	588	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>	589	a C<perl:string> action bound to a key, see description of the B<keysym>
401	resource in the @@RXVT_NAME@@(1) manpage).	590	resource in the @@RXVT_NAME@@(1) manpage).
		591
		592	The event is simply the action string. This interface is assumed to change
		593	slightly in the future.
		594
		595	=item on_resize_all_windows $tern, $new_width, $new_height
		596
		597	Called just after the new window size has been calculated, but before
		598	windows are actually being resized or hints are being set. If this hook
		599	returns TRUE, setting of the window hints is being skipped.
402		600
403	=item on_x_event $term, $event	601	=item on_x_event $term, $event
404		602
405	Called on every X event received on the vt window (and possibly other	603	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	604	windows). Should only be used as a last resort. Most event structure
407	members are not passed.	605	members are not passed.
408		606
		607	=item on_root_event $term, $event
		608
		609	Like C<on_x_event>, but is called for events on the root window.
		610
409	=item on_focus_in $term	611	=item on_focus_in $term
410		612
411	Called whenever the window gets the keyboard focus, before rxvt-unicode	613	Called whenever the window gets the keyboard focus, before rxvt-unicode
412	does focus in processing.	614	does focus in processing.
413		615
414	=item on_focus_out $term	616	=item on_focus_out $term
415		617
416	Called wheneever the window loses keyboard focus, before rxvt-unicode does	618	Called whenever the window loses keyboard focus, before rxvt-unicode does
417	focus out processing.	619	focus out processing.
		620
		621	=item on_configure_notify $term, $event
		622
		623	=item on_property_notify $term, $event
418		624
419	=item on_key_press $term, $event, $keysym, $octets	625	=item on_key_press $term, $event, $keysym, $octets
420		626
421	=item on_key_release $term, $event, $keysym	627	=item on_key_release $term, $event, $keysym
422		628
…		…
432		638
433	Called whenever the corresponding X event is received for the terminal If	639	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.	640	the hook returns true, then the even will be ignored by rxvt-unicode.
435		641
436	The event is a hash with most values as named by Xlib (see the XEvent	642	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	643	manpage), with the additional members C<row> and C<col>, which are the
438	and column under the mouse cursor.	644	(real, not screen-based) row and column under the mouse cursor.
439		645
440	C<on_key_press> additionally receives the string rxvt-unicode would	646	C<on_key_press> additionally receives the string rxvt-unicode would
441	output, if any, in locale-specific encoding.	647	output, if any, in locale-specific encoding.
442		648
443	subwindow.	649	subwindow.
		650
		651	=item on_client_message $term, $event
		652
		653	=item on_wm_protocols $term, $event
		654
		655	=item on_wm_delete_window $term, $event
		656
		657	Called when various types of ClientMessage events are received (all with
		658	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
444		659
445	=back	660	=back
446		661
447	=cut	662	=cut
448		663
…		…
454	use Scalar::Util ();	669	use Scalar::Util ();
455	use List::Util ();	670	use List::Util ();
456		671
457	our $VERSION = 1;	672	our $VERSION = 1;
458	our $TERM;	673	our $TERM;
		674	our @TERM_INIT;
		675	our @TERM_EXT;
459	our @HOOKNAME;	676	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	677	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	678	our %OPTION;
462		679
463	our $LIBDIR;	680	our $LIBDIR;
464	our $RESNAME;	681	our $RESNAME;
465	our $RESCLASS;	682	our $RESCLASS;
466	our $RXVTNAME;	683	our $RXVTNAME;
467		684
		685	our $NOCHAR = chr 0xffff;
		686
468	=head2 Variables in the C<urxvt> Package	687	=head2 Variables in the C<urxvt> Package
469		688
470	=over 4	689	=over 4
471		690
472	=item $urxvt::LIBDIR	691	=item $urxvt::LIBDIR
…		…
484		703
485	=item $urxvt::TERM	704	=item $urxvt::TERM
486		705
487	The current terminal. This variable stores the current C<urxvt::term>	706	The current terminal. This variable stores the current C<urxvt::term>
488	object, whenever a callback/hook is executing.	707	object, whenever a callback/hook is executing.
		708
		709	=item @urxvt::TERM_INIT
		710
		711	All code references in this array will be called as methods of the next newly
		712	created C<urxvt::term> object (during the C<on_init> phase). The array
		713	gets cleared before the code references that were in it are being executed,
		714	so references can push themselves onto it again if they so desire.
		715
		716	This complements to the perl-eval command line option, but gets executed
		717	first.
		718
		719	=item @urxvt::TERM_EXT
		720
		721	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		722	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		723	but before other extensions. Gets cleared just like C<@TERM_INIT>.
489		724
490	=back	725	=back
491		726
492	=head2 Functions in the C<urxvt> Package	727	=head2 Functions in the C<urxvt> Package
493		728
…		…
507		742
508	Using this function has the advantage that its output ends up in the	743	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.	744	correct place, e.g. on stderr of the connecting urxvtc client.
510		745
511	Messages have a size limit of 1023 bytes currently.	746	Messages have a size limit of 1023 bytes currently.
		747
		748	=item @terms = urxvt::termlist
		749
		750	Returns all urxvt::term objects that exist in this process, regardless of
		751	whether they are started, being destroyed etc., so be careful. Only term
		752	objects that have perl extensions attached will be returned (because there
		753	is no urxvt::term objet associated with others).
512		754
513	=item $time = urxvt::NOW	755	=item $time = urxvt::NOW
514		756
515	Returns the "current time" (as per the event loop).	757	Returns the "current time" (as per the event loop).
516		758
…		…
575		817
576	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	818	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
577		819
578	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	820	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
579		821
		822	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		823
580	Replace the foreground/background colour in the rendition mask with the	824	Replace the foreground/background colour in the rendition mask with the
581	specified one.	825	specified one.
582		826
583	=item $value = urxvt::GET_CUSTOM $rend	827	=item $value = urxvt::GET_CUSTOM $rend
584		828
…		…
593	=back	837	=back
594		838
595	=cut	839	=cut
596		840
597	BEGIN {	841	BEGIN {
598	urxvt->bootstrap;
599
600	# overwrite perl's warn	842	# overwrite perl's warn
601	*CORE::GLOBAL::warn = sub {	843	*CORE::GLOBAL::warn = sub {
602	my $msg = join "", @_;	844	my $msg = join "", @_;
603	$msg .= "\n"	845	$msg .= "\n"
604	unless $msg =~ /\n$/;	846	unless $msg =~ /\n$/;
605	urxvt::warn ($msg);	847	urxvt::warn ($msg);
606	};	848	};
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	}	849	}
		850
		851	no warnings 'utf8';
614		852
615	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	853	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
616		854
617	sub verbose {	855	sub verbose {
618	my ($level, $msg) = @_;	856	my ($level, $msg) = @_;
619	warn "$msg\n" if $level <= $verbosity;	857	warn "$msg\n" if $level <= $verbosity;
620	}	858	}
621		859
622	my $extension_pkg = "extension0000";
623	my %extension_pkg;	860	my %extension_pkg;
624		861
625	# load a single script into its own package, once only	862	# load a single script into its own package, once only
626	sub extension_package($) {	863	sub extension_package($) {
627	my ($path) = @_;	864	my ($path) = @_;
628		865
629	$extension_pkg{$path} \|\|= do {	866	$extension_pkg{$path} \|\|= do {
630	my $pkg = "urxvt::" . ($extension_pkg++);	867	$path =~ /([^\/\\]+)$/;
		868	my $pkg = $1;
		869	$pkg =~ s/[^[:word:]]/_/g;
		870	$pkg = "urxvt::ext::$pkg";
631		871
632	verbose 3, "loading extension '$path' into package '$pkg'";	872	verbose 3, "loading extension '$path' into package '$pkg'";
633		873
634	open my $fh, "<:raw", $path	874	open my $fh, "<:raw", $path
635	or die "$path: $!";	875	or die "$path: $!";
636		876
637	my $source =	877	my $source =
638	"package $pkg; use strict; use utf8;\n"	878	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
639	. "use base urxvt::term::extension::;\n"
640	. "#line 1 \"$path\"\n{\n"	879	. "#line 1 \"$path\"\n{\n"
641	. (do { local $/; <$fh> })	880	. (do { local $/; <$fh> })
642	. "\n};\n1";	881	. "\n};\n1";
643		882
644	eval $source	883	eval $source
…		…
658	if ($htype == 0) { # INIT	897	if ($htype == 0) { # INIT
659	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	898	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
660		899
661	my %ext_arg;	900	my %ext_arg;
662		901
		902	{
		903	my @init = @TERM_INIT;
		904	@TERM_INIT = ();
		905	$_->($TERM) for @init;
		906	my @pkg = @TERM_EXT;
		907	@TERM_EXT = ();
		908	$TERM->register_package ($_) for @pkg;
		909	}
		910
663	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	911	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
664	if ($_ eq "default") {	912	if ($_ eq "default") {
665	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	913	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
666	} elsif (/^-(.*)$/) {	914	} elsif (/^-(.*)$/) {
667	delete $ext_arg{$1};	915	delete $ext_arg{$1};
668	} elsif (/^([^<]+)<(.*)>$/) {	916	} elsif (/^([^<]+)<(.*)>$/) {
669	push @{ $ext_arg{$1} }, $2;	917	push @{ $ext_arg{$1} }, $2;
670	} else {	918	} else {
671	$ext_arg{$_} \|\|= [];	919	$ext_arg{$_} \|\|= [];
672	}	920	}
673	}	921	}
674		922
675	while (my ($ext, $argv) = each %ext_arg) {	923	for my $ext (sort keys %ext_arg) {
676	my @files = grep -f $_, map "$_/$ext", @dirs;	924	my @files = grep -f $_, map "$_/$ext", @dirs;
677		925
678	if (@files) {	926	if (@files) {
679	$TERM->register_package (extension_package $files[0], $argv);	927	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
680	} else {	928	} else {
681	warn "perl extension '$ext' not found in perl library search path\n";	929	warn "perl extension '$ext' not found in perl library search path\n";
682	}	930	}
683	}	931	}
684		932
…		…
690		938
691	if (my $cb = $TERM->{_hook}[$htype]) {	939	if (my $cb = $TERM->{_hook}[$htype]) {
692	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	940	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
693	if $verbosity >= 10;	941	if $verbosity >= 10;
694		942
695	keys %$cb;	943	for my $pkg (keys %$cb) {
696
697	while (my ($pkg, $cb) = each %$cb) {
698	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	944	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
699	and last;	945	$retval \|\|= $retval_;
700		946
701	if ($@) {	947	if ($@) {
702	$TERM->ungrab; # better to lose the grab than the session	948	$TERM->ungrab; # better to lose the grab than the session
703	warn $@;	949	warn $@;
704	}	950	}
…		…
717	}	963	}
718		964
719	$retval	965	$retval
720	}	966	}
721		967
722	sub exec_async(@) {	968	sub SET_COLOR($$$) {
723	my $pid = fork;	969	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	}	970	}
733		971
734	# urxvt::term::extension	972	# urxvt::term::extension
735		973
736	package urxvt::term::extension;	974	package urxvt::term::extension;
…		…
875	# find on_xxx subs in the package and register them	1113	# find on_xxx subs in the package and register them
876	# as hooks	1114	# as hooks
877	sub register_package {	1115	sub register_package {
878	my ($self, $pkg, $argv) = @_;	1116	my ($self, $pkg, $argv) = @_;
879		1117
		1118	no strict 'refs';
		1119
		1120	urxvt::verbose 6, "register package $pkg to $self";
		1121
		1122	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1123
880	my $proxy = bless {	1124	my $proxy = bless {
881	_pkg => $pkg,	1125	_pkg => $pkg,
882	argv => $argv,	1126	argv => $argv,
883	}, $pkg;	1127	}, $pkg;
884	Scalar::Util::weaken ($proxy->{term} = $self);	1128	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
899	hash which defines the environment of the new terminal.	1143	hash which defines the environment of the new terminal.
900		1144
901	Croaks (and probably outputs an error message) if the new instance	1145	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	1146	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	1147	initialise perl, and the terminal object otherwise. The C<init> and
904	C<start> hooks will be called during this call.	1148	C<start> hooks will be called before this call returns, and are free to
		1149	refer to global data (which is race free).
905		1150
906	=cut	1151	=cut
907		1152
908	sub new {	1153	sub new {
909	my ($class, $env, @args) = @_;	1154	my ($class, $env, @args) = @_;
910		1155
		1156	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1157	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1158
911	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1159	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
912	}	1160	}
913		1161
914	=item $term->destroy	1162	=item $term->destroy
915		1163
916	Destroy the terminal object (close the window, free resources	1164	Destroy the terminal object (close the window, free resources
917	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1165	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
918	watchers (timers, io watchers) are still active.	1166	watchers (timers, io watchers) are still active.
919		1167
		1168	=item $term->exec_async ($cmd[, @args])
		1169
		1170	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1171	("starts") programs in the background. This function takes care of setting
		1172	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1173	be preferred over explicit calls to C<exec> or C<system>.
		1174
		1175	Returns the pid of the subprocess or C<undef> on error.
		1176
		1177	=cut
		1178
		1179	sub exec_async {
		1180	my $self = shift;
		1181
		1182	my $pid = fork;
		1183
		1184	return $pid
		1185	if !defined $pid or $pid;
		1186
		1187	%ENV = %{ $self->env };
		1188
		1189	exec @_;
		1190	urxvt::_exit 255;
		1191	}
		1192
920	=item $isset = $term->option ($optval[, $set])	1193	=item $isset = $term->option ($optval[, $set])
921		1194
922	Returns true if the option specified by C<$optval> is enabled, and	1195	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	1196	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.	1197	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
925		1198
926	Here is a a likely non-exhaustive list of option names, please see the	1199	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:	1200	source file F</src/optinc.h> to see the actual list:
928		1201
929	borderLess console cursorBlink cursorUnderline hold iconic insecure	1202	borderLess console cursorBlink cursorUnderline hold iconic insecure
930	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1203	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
931	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1204	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
932	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1205	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
933	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1206	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
934	tripleclickwords utmpInhibit visualBell	1207	transparent tripleclickwords utmpInhibit visualBell
935		1208
936	=item $value = $term->resource ($name[, $newval])	1209	=item $value = $term->resource ($name[, $newval])
937		1210
938	Returns the current resource value associated with a given name and	1211	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>	1212	optionally sets a new value. Setting values is most useful in the C<init>
…		…
948	likely change).	1221	likely change).
949		1222
950	Please note that resource strings will currently only be freed when the	1223	Please note that resource strings will currently only be freed when the
951	terminal is destroyed, so changing options frequently will eat memory.	1224	terminal is destroyed, so changing options frequently will eat memory.
952		1225
953	Here is a a likely non-exhaustive list of resource names, not all of which	1226	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>	1227	are supported in every build, please see the source file F</src/rsinc.h>
955	to see the actual list:	1228	to see the actual list:
956		1229
957	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1230	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
958	borderLess color cursorBlink cursorUnderline cutchars delete_key	1231	borderLess color cursorBlink cursorUnderline cutchars delete_key
959	display_name embed ext_bwidth fade font geometry hold iconName	1232	display_name embed ext_bwidth fade font geometry hold iconName
960	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1233	imFont imLocale inputMethod insecure int_bwidth intensityStyles
961	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1234	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
962	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1235	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
963	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1236	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
964	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1237	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
965	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1238	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
966	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1239	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
967	shade term_name title transparent transparent_all tripleclickwords	1240	secondaryScreen secondaryScroll selectstyle shade term_name title
968	utmpInhibit visualBell	1241	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1242	visualBell
969		1243
970	=cut	1244	=cut
971		1245
972	sub resource($$;$) {	1246	sub resource($$;$) {
973	my ($self, $name) = (shift, shift);	1247	my ($self, $name) = (shift, shift);
…		…
1147		1421
1148	Normally its not a good idea to use this function, as programs might be	1422	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	1423	confused by changes in cursor position or scrolling. Its useful inside a
1150	C<on_add_lines> hook, though.	1424	C<on_add_lines> hook, though.
1151		1425
		1426	=item $term->scr_change_screen ($screen)
		1427
		1428	Switch to given screen - 0 primary, 1 secondary.
		1429
1152	=item $term->cmd_parse ($octets)	1430	=item $term->cmd_parse ($octets)
1153		1431
1154	Similar to C<scr_add_lines>, but the argument must be in the	1432	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	1433	locale-specific encoding of the terminal and can contain command sequences
1156	(escape codes) that will be interpreted.	1434	(escape codes) that will be interpreted.
…		…
1166	Replaces the event mask of the pty watcher by the given event mask. Can	1444	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	1445	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	1446	description of C<< urxvt::timer->events >>. Make sure to always restore
1169	the previous value.	1447	the previous value.
1170		1448
		1449	=item $fd = $term->pty_fd
		1450
		1451	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1452	is used.
		1453
1171	=item $windowid = $term->parent	1454	=item $windowid = $term->parent
1172		1455
1173	Return the window id of the toplevel window.	1456	Return the window id of the toplevel window.
1174		1457
1175	=item $windowid = $term->vt	1458	=item $windowid = $term->vt
…		…
1181	Adds the specified events to the vt event mask. Useful e.g. when you want	1464	Adds the specified events to the vt event mask. Useful e.g. when you want
1182	to receive pointer events all the times:	1465	to receive pointer events all the times:
1183		1466
1184	$term->vt_emask_add (urxvt::PointerMotionMask);	1467	$term->vt_emask_add (urxvt::PointerMotionMask);
1185		1468
		1469	=item $term->focus_in
		1470
		1471	=item $term->focus_out
		1472
		1473	=item $term->key_press ($state, $keycode[, $time])
		1474
		1475	=item $term->key_release ($state, $keycode[, $time])
		1476
		1477	Deliver various fake events to to terminal.
		1478
1186	=item $window_width = $term->width	1479	=item $window_width = $term->width
1187		1480
1188	=item $window_height = $term->height	1481	=item $window_height = $term->height
1189		1482
1190	=item $font_width = $term->fwidth	1483	=item $font_width = $term->fwidth
…		…
1220	=item $env = $term->env	1513	=item $env = $term->env
1221		1514
1222	Returns a copy of the environment in effect for the terminal as a hashref	1515	Returns a copy of the environment in effect for the terminal as a hashref
1223	similar to C<\%ENV>.	1516	similar to C<\%ENV>.
1224		1517
		1518	=item @envv = $term->envv
		1519
		1520	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1521
		1522	=item @argv = $term->argv
		1523
		1524	Return the argument vector as this terminal, similar to @ARGV, but
		1525	includes the program name as first element.
		1526
1225	=cut	1527	=cut
1226		1528
1227	sub env {	1529	sub env {
1228	if (my $env = $_[0]->_env) {
1229	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1530	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1230	} else {
1231	+{ %ENV }
1232	}
1233	}	1531	}
1234		1532
1235	=item $modifiermask = $term->ModLevel3Mask	1533	=item $modifiermask = $term->ModLevel3Mask
1236		1534
1237	=item $modifiermask = $term->ModMetaMask	1535	=item $modifiermask = $term->ModMetaMask
1238		1536
1239	=item $modifiermask = $term->ModNumLockMask	1537	=item $modifiermask = $term->ModNumLockMask
1240		1538
1241	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1539	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.	1540	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1541
		1542	=item $screen = $term->current_screen
		1543
		1544	Returns the currently displayed screen (0 primary, 1 secondary).
		1545
		1546	=item $cursor_is_hidden = $term->hidden_cursor
		1547
		1548	Returns whether the cursor is currently hidden or not.
1243		1549
1244	=item $view_start = $term->view_start ([$newvalue])	1550	=item $view_start = $term->view_start ([$newvalue])
1245		1551
1246	Returns the row number of the topmost displayed line. Maximum value is	1552	Returns the row number of the topmost displayed line. Maximum value is
1247	C<0>, which displays the normal terminal contents. Lower values scroll	1553	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	1573	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	1574	to replace only parts of a line. The font index in the rendition will
1269	automatically be updated.	1575	automatically be updated.
1270		1576
1271	C<$text> is in a special encoding: tabs and wide characters that use more	1577	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	1578	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1273	(C<chr 65535>). Characters with combining characters and other characters	1579	characters. Characters with combining characters and other characters that
1274	that do not fit into the normal tetx encoding will be replaced with	1580	do not fit into the normal tetx encoding will be replaced with characters
1275	characters in the private use area.	1581	in the private use area.
1276		1582
1277	You have to obey this encoding when changing text. The advantage is	1583	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	1584	that C<substr> and similar functions work on screen cells and not on
1279	characters.	1585	characters.
1280		1586
…		…
1424	where one character corresponds to one screen cell. See	1730	where one character corresponds to one screen cell. See
1425	C<< $term->ROW_t >> for details.	1731	C<< $term->ROW_t >> for details.
1426		1732
1427	=item $string = $term->special_decode $text	1733	=item $string = $term->special_decode $text
1428		1734
1429	Converts rxvt-unicodes text reprsentation into a perl string. See	1735	Converts rxvt-unicodes text representation into a perl string. See
1430	C<< $term->ROW_t >> for details.	1736	C<< $term->ROW_t >> for details.
1431		1737
1432	=item $success = $term->grab_button ($button, $modifiermask)	1738	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1433		1739
		1740	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1741
1434	Registers a synchronous button grab. See the XGrabButton manpage.	1742	Register/unregister a synchronous button grab. See the XGrabButton
		1743	manpage.
1435		1744
1436	=item $success = $term->grab ($eventtime[, $sync])	1745	=item $success = $term->grab ($eventtime[, $sync])
1437		1746
1438	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1747	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1439	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1748	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1440		1749
1441	=item $term->allow_events_async	1750	=item $term->allow_events_async
1442		1751
1443	Calls XAllowEvents with AsyncBoth for the most recent grab.	1752	Calls XAllowEvents with AsyncBoth for the most recent grab.
1444		1753
…		…
1454	=item $term->ungrab	1763	=item $term->ungrab
1455		1764
1456	Calls XUngrab for the most recent grab. Is called automatically on	1765	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	1766	evaluation errors, as it is better to lose the grab in the error case as
1458	the session.	1767	the session.
		1768
		1769	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1770
		1771	=item $atom_name = $term->XGetAtomName ($atom)
		1772
		1773	=item @atoms = $term->XListProperties ($window)
		1774
		1775	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1776
		1777	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1778
		1779	=item $term->XDeleteProperty ($window, $property)
		1780
		1781	=item $window = $term->DefaultRootWindow
		1782
		1783	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1784
		1785	=item $term->XMapWindow ($window)
		1786
		1787	=item $term->XUnmapWindow ($window)
		1788
		1789	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1790
		1791	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1792
		1793	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1794
		1795	Various X or X-related functions. The C<$term> object only serves as
		1796	the source of the display, otherwise those functions map more-or-less
		1797	directory onto the X functions of the same name.
1459		1798
1460	=back	1799	=back
1461		1800
1462	=cut	1801	=cut
1463		1802
…		…
1527	my ($self, $text, $cb) = @_;	1866	my ($self, $text, $cb) = @_;
1528		1867
1529	$self->add_item ({ type => "button", text => $text, activate => $cb});	1868	$self->add_item ({ type => "button", text => $text, activate => $cb});
1530	}	1869	}
1531		1870
1532	=item $popup->add_toggle ($text, $cb, $initial_value)	1871	=item $popup->add_toggle ($text, $initial_value, $cb)
1533		1872
1534	Adds a toggle/checkbox item to the popup. Teh callback gets called	1873	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	1874	whenever it gets toggled, with a boolean indicating its new value as its
1536	argument.	1875	first argument.
1537		1876
1538	=cut	1877	=cut
1539		1878
1540	sub add_toggle {	1879	sub add_toggle {
1541	my ($self, $text, $cb, $value) = @_;	1880	my ($self, $text, $value, $cb) = @_;
1542		1881
1543	my $item; $item = {	1882	my $item; $item = {
1544	type => "button",	1883	type => "button",
1545	text => " $text",	1884	text => " $text",
1546	value => $value,	1885	value => $value,
…		…
1565	my $env = $self->{term}->env;	1904	my $env = $self->{term}->env;
1566	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1905	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1567	delete $env->{LC_ALL};	1906	delete $env->{LC_ALL};
1568	$env->{LC_CTYPE} = $self->{term}->locale;	1907	$env->{LC_CTYPE} = $self->{term}->locale;
1569		1908
1570	urxvt::term->new ($env, $self->{term}->resource ("name"),	1909	urxvt::term->new ($env, "popup",
1571	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1910	"--perl-lib" => "", "--perl-ext-common" => "",
		1911	"-pty-fd" => -1, "-sl" => 0,
		1912	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1572	"--transient-for" => $self->{term}->parent,	1913	"--transient-for" => $self->{term}->parent,
1573	"-display" => $self->{term}->display_id,	1914	"-display" => $self->{term}->display_id,
1574	"-pe" => "urxvt-popup")	1915	"-pe" => "urxvt-popup")
1575	or die "unable to create popup window\n";	1916	or die "unable to create popup window\n";
1576	}	1917	}
…		…
1581	delete $self->{term}{_destroy}{$self};	1922	delete $self->{term}{_destroy}{$self};
1582	$self->{term}->ungrab;	1923	$self->{term}->ungrab;
1583	}	1924	}
1584		1925
1585	=back	1926	=back
		1927
		1928	=cut
		1929
		1930	package urxvt::watcher;
		1931
		1932	@urxvt::timer::ISA = __PACKAGE__;
		1933	@urxvt::iow::ISA = __PACKAGE__;
		1934	@urxvt::pw::ISA = __PACKAGE__;
		1935	@urxvt::iw::ISA = __PACKAGE__;
1586		1936
1587	=head2 The C<urxvt::timer> Class	1937	=head2 The C<urxvt::timer> Class
1588		1938
1589	This class implements timer watchers/events. Time is represented as a	1939	This class implements timer watchers/events. Time is represented as a
1590	fractional number of seconds since the epoch. Example:	1940	fractional number of seconds since the epoch. Example:
…		…
1628	Start the timer.	1978	Start the timer.
1629		1979
1630	=item $timer = $timer->start ($tstamp)	1980	=item $timer = $timer->start ($tstamp)
1631		1981
1632	Set the event trigger time to C<$tstamp> and start the timer.	1982	Set the event trigger time to C<$tstamp> and start the timer.
		1983
		1984	=item $timer = $timer->after ($delay)
		1985
		1986	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1633		1987
1634	=item $timer = $timer->stop	1988	=item $timer = $timer->stop
1635		1989
1636	Stop the timer.	1990	Stop the timer.
1637		1991
…		…
1666	Set the callback to be called when io events are triggered. C<$reventmask>	2020	Set the callback to be called when io events are triggered. C<$reventmask>
1667	is a bitset as described in the C<events> method.	2021	is a bitset as described in the C<events> method.
1668		2022
1669	=item $iow = $iow->fd ($fd)	2023	=item $iow = $iow->fd ($fd)
1670		2024
1671	Set the filedescriptor (not handle) to watch.	2025	Set the file descriptor (not handle) to watch.
1672		2026
1673	=item $iow = $iow->events ($eventmask)	2027	=item $iow = $iow->events ($eventmask)
1674		2028
1675	Set the event mask to watch. The only allowed values are	2029	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	2030	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
…		…
1680		2034
1681	Start watching for requested events on the given handle.	2035	Start watching for requested events on the given handle.
1682		2036
1683	=item $iow = $iow->stop	2037	=item $iow = $iow->stop
1684		2038
1685	Stop watching for events on the given filehandle.	2039	Stop watching for events on the given file handle.
		2040
		2041	=back
		2042
		2043	=head2 The C<urxvt::iw> Class
		2044
		2045	This class implements idle watchers, that get called automatically when
		2046	the process is idle. They should return as fast as possible, after doing
		2047	some useful work.
		2048
		2049	=over 4
		2050
		2051	=item $iw = new urxvt::iw
		2052
		2053	Create a new idle watcher object in stopped state.
		2054
		2055	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2056
		2057	Set the callback to be called when the watcher triggers.
		2058
		2059	=item $timer = $timer->start
		2060
		2061	Start the watcher.
		2062
		2063	=item $timer = $timer->stop
		2064
		2065	Stop the watcher.
		2066
		2067	=back
		2068
		2069	=head2 The C<urxvt::pw> Class
		2070
		2071	This class implements process watchers. They create an event whenever a
		2072	process exits, after which they stop automatically.
		2073
		2074	my $pid = fork;
		2075	...
		2076	$term->{pw} = urxvt::pw
		2077	->new
		2078	->start ($pid)
		2079	->cb (sub {
		2080	my ($pw, $exit_status) = @_;
		2081	...
		2082	});
		2083
		2084	=over 4
		2085
		2086	=item $pw = new urxvt::pw
		2087
		2088	Create a new process watcher in stopped state.
		2089
		2090	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2091
		2092	Set the callback to be called when the timer triggers.
		2093
		2094	=item $pw = $timer->start ($pid)
		2095
		2096	Tells the watcher to start watching for process C<$pid>.
		2097
		2098	=item $pw = $pw->stop
		2099
		2100	Stop the watcher.
1686		2101
1687	=back	2102	=back
1688		2103
1689	=head1 ENVIRONMENT	2104	=head1 ENVIRONMENT
1690		2105
…		…
1699		2114
1700	=item >= 3 - script loading and management	2115	=item >= 3 - script loading and management
1701		2116
1702	=item >=10 - all called hooks	2117	=item >=10 - all called hooks
1703		2118
1704	=item >=11 - hook reutrn values	2119	=item >=11 - hook return values
1705		2120
1706	=back	2121	=back
1707		2122
1708	=head1 AUTHOR	2123	=head1 AUTHOR
1709		2124

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.145 by root, Thu Aug 10 22:53:20 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.145 by root, Thu Aug 10 22:53:20 2006 UTC