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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.154 by root, Sat Jun 2 06:43:02 2007 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,automove-background,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
48	C<--quoting-style=shell>.	55	C<--quoting-style=shell>.
49		56
50	A double-click usually selects the word under the cursor, further clicks	57	A double-click usually selects the word under the cursor, further clicks
51	will enlarge the selection.	58	will enlarge the selection.
52		59
		60	The selection works by trying to match a number of regexes and displaying
		61	them in increasing order of length. You can add your own regexes by
		62	specifying resources of the form:
		63
		64	URxvt.selection.pattern-0: perl-regex
		65	URxvt.selection.pattern-1: perl-regex
		66	...
		67
		68	The index number (0, 1...) must not have any holes, and each regex must
		69	contain at least one pair of capturing parentheses, which will be used for
		70	the match. For example, the following adds a regex that matches everything
		71	between two vertical bars:
		72
		73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
		81
		82	You can look at the source of the selection extension to see more
		83	interesting uses, such as parsing a line from beginning to end.
		84
53	It also offers the following bindable keyboard command:	85	This extension also offers following bindable keyboard commands:
54		86
55	=over 4	87	=over 4
56		88
57	=item rot13	89	=item rot13
58		90
…		…
65	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
66		98
67	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
68	runtime.	100	runtime.
69		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	It's sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<$self->{myoption}>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
70	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
71		120
72	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
73	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
74	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
		124
		125	Other extensions can extend this popup menu by pushing a code reference
		126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
		128
		129	It's sole argument is the popup menu, which can be modified. The selection
		130	is in C<$_>, which can be used to decide whether to add something or not.
		131	It should either return nothing or a string and a code reference. The
		132	string will be used as button text and the code reference will be called
		133	when the button gets activated and should transform C<$_>.
		134
		135	The following will add an entry C<a to b> that transforms all C<a>s in
		136	the selection to C<b>s, but only if the selection currently contains any
		137	C<a>s:
		138
		139	push @{ $self->{term}{selection_popup_hook} }, sub {
		140	/a/ ? ("a to be" => sub { s/a/b/g }
		141	: ()
		142	};
75		143
76	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
77		145
78	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
79	by a hotkey (default: C<M-s>). While in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
86	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
87	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
88	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
89	selection.	157	selection.
90		158
91	=item digital-clock	159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
92		162
93	Displays a digital clock using the built-in overlay.	163	See L<perlre> for more info about perl regular expression syntax.
94		164
95	=item mark-urls	165	=item readline (enabled by default)
96		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (the this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
		189
		190	=item selection-autotransform
		191
		192	This selection allows you to do automatic transforms on a selection
		193	whenever a selection is made.
		194
		195	It works by specifying perl snippets (most useful is a single C<s///>
		196	operator) that modify C<$_> as resources:
		197
		198	URxvt.selection-autotransform.0: transform
		199	URxvt.selection-autotransform.1: transform
		200	...
		201
		202	For example, the following will transform selections of the form
		203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		204	$word>:
		205
		206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		207
		208	And this example matches the same,but replaces it with vi-commands you can
		209	paste directly into your (vi :) editor:
		210
		211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		212
		213	Of course, this can be modified to suit your needs and your editor :)
		214
		215	To expand the example above to typical perl error messages ("XXX at
		216	FILENAME line YYY."), you need a slightly more elaborate solution:
		217
		218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		220
		221	The first line tells the selection code to treat the unchanging part of
		222	every error message as a selection pattern, and the second line transforms
		223	the message into vi commands to load the file.
		224
		225	=item tabbed
		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
97	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
98	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
99	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
100	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	Example configuration:
		265
		266	URxvt.perl-ext: default,matcher
		267	URxvt.urlLauncher: sensible-browser
		268	URxvt.keysym.C-Delete: perl:matcher
		269	URxvt.matcher.button: 1
		270	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		271	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		272	URxvt.matcher.launcher.2: gvim +$2 $1
		273
		274	=item xim-onthespot
		275
		276	This (experimental) perl extension implements OnTheSpot editing. It does
		277	not work perfectly, and some input methods don't seem to work well with
		278	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		279	kinput2.
		280
		281	You enable it by specifying this extension and a preedit style of
		282	C<OnTheSpot>, i.e.:
		283
		284	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		285
		286	=item kuake<hotkey>
		287
		288	A very primitive quake-console-like extension. It was inspired by a
		289	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		290	user presses a global accelerator key (by default C<F10>), the terminal
		291	will show or hide itself. Another press of the accelerator key will hide
		292	or show it again.
		293
		294	Initially, the window will not be shown when using this extension.
		295
		296	This is useful if you need a single terminal thats not using any desktop
		297	space most of the time but is quickly available at the press of a key.
		298
		299	The accelerator key is grabbed regardless of any modifiers, so this
		300	extension will actually grab a physical key just for this function.
		301
		302	If you want a quake-like animation, tell your window manager to do so
		303	(fvwm can do it).
		304
		305	=item automove-background
		306
		307	This is basically a very small extension that dynamically changes the
		308	background pixmap offset to the window position, in effect creating the
		309	same effect as pseudo transparency with a custom pixmap. No scaling is
		310	supported in this mode. Example:
		311
		312	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		313
		314	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
		315	shows how this extension can be used to implement an automatically blurred
		316	transparent background.
101		317
102	=item block-graphics-to-ascii	318	=item block-graphics-to-ascii
103		319
104	A not very useful example of filtering all text output to the terminal,	320	A not very useful example of filtering all text output to the terminal
105	by replacing all line-drawing characters (U+2500 .. U+259F) by a	321	by replacing all line-drawing characters (U+2500 .. U+259F) by a
106	similar-looking ascii character.	322	similar-looking ascii character.
		323
		324	=item digital-clock
		325
		326	Displays a digital clock using the built-in overlay.
		327
		328	=item remote-clipboard
		329
		330	Somewhat of a misnomer, this extension adds two menu entries to the
		331	selection popup that allows one ti run external commands to store the
		332	selection somewhere and fetch it again.
		333
		334	We use it to implement a "distributed selection mechanism", which just
		335	means that one command uploads the file to a remote server, and another
		336	reads it.
		337
		338	The commands can be set using the C<URxvt.remote-selection.store> and
		339	C<URxvt.remote-selection.fetch> resources. The first should read the
		340	selection to store from STDIN (always in UTF-8), the second should provide
		341	the selection data on STDOUT (also in UTF-8).
		342
		343	The defaults (which are likely useless to you) use rsh and cat:
		344
		345	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		346	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		347
		348	=item selection-pastebin
		349
		350	This is a little rarely useful extension that Uploads the selection as
		351	textfile to a remote site (or does other things). (The implementation is
		352	not currently secure for use in a multiuser environment as it writes to
		353	F</tmp> directly.).
		354
		355	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		356	i.e.
		357
		358	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		359
		360	Pressing this combination runs a command with C<%> replaced by the name of
		361	the textfile. This command can be set via a resource:
		362
		363	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		364
		365	And the default is likely not useful to anybody but the few people around
		366	here :)
		367
		368	The name of the textfile is the hex encoded md5 sum of the selection, so
		369	the same content should lead to the same filename.
		370
		371	After a successful upload the selection will be replaced by the text given
		372	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		373	for the filename):
		374
		375	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		376
		377	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		378	the double C</> characters as comment start. Use C<\057\057> instead,
		379	which works regardless of wether xrdb is used to parse the resource file
		380	or not.
107		381
108	=item example-refresh-hooks	382	=item example-refresh-hooks
109		383
110	Displays a very simple digital clock in the upper right corner of the	384	Displays a very simple digital clock in the upper right corner of the
111	window. Illustrates overwriting the refresh callbacks to create your own	385	window. Illustrates overwriting the refresh callbacks to create your own
…		…
151		425
152	=back	426	=back
153		427
154	=head2 Extension Objects	428	=head2 Extension Objects
155		429
156	Very perl extension is a perl class. A separate perl object is created	430	Every perl extension is a perl class. A separate perl object is created
157	for each terminal and each extension and passed as the first parameter to	431	for each terminal, and each terminal has its own set of extenion objects,
158	hooks. So extensions can use their C<$self> object without having to think	432	which are passed as the first parameter to hooks. So extensions can use
159	about other extensions, with the exception of methods and members that	433	their C<$self> object without having to think about clashes with other
		434	extensions or other terminals, with the exception of methods and members
160	begin with an underscore character C<_>: these are reserved for internal	435	that begin with an underscore character C<_>: these are reserved for
161	use.	436	internal use.
162		437
163	Although it isn't a C<urxvt::term> object, you can call all methods of the	438	Although it isn't a C<urxvt::term> object, you can call all methods of the
164	C<urxvt::term> class on this object.	439	C<urxvt::term> class on this object.
165		440
166	It has the following methods and data members:	441	It has the following methods and data members:
…		…
187	=head2 Hooks	462	=head2 Hooks
188		463
189	The following subroutines can be declared in extension files, and will be	464	The following subroutines can be declared in extension files, and will be
190	called whenever the relevant event happens.	465	called whenever the relevant event happens.
191		466
192	The first argument passed to them is an extension oject as described in	467	The first argument passed to them is an extension object as described in
193	the in the C<Extension Objects> section.	468	the in the C<Extension Objects> section.
194		469
195	B<All> of these hooks must return a boolean value. If it is true, then the	470	B<All> of these hooks must return a boolean value. If any of the called
196	event counts as being I<consumed>, and the invocation of other hooks is	471	hooks returns true, then the event counts as being I<consumed>, and the
197	skipped, and the relevant action might not be carried out by the C++ code.	472	relevant action might not be carried out by the C++ code.
198		473
199	I<< When in doubt, return a false value (preferably C<()>). >>	474	I<< When in doubt, return a false value (preferably C<()>). >>
200		475
201	=over 4	476	=over 4
202		477
203	=item on_init $term	478	=item on_init $term
204		479
205	Called after a new terminal object has been initialized, but before	480	Called after a new terminal object has been initialized, but before
206	windows are created or the command gets run. Most methods are unsafe to	481	windows are created or the command gets run. Most methods are unsafe to
207	call or deliver senseless data, as terminal size and other characteristics	482	call or deliver senseless data, as terminal size and other characteristics
208	have not yet been determined. You can safely query and change resources,	483	have not yet been determined. You can safely query and change resources
209	though.	484	and options, though. For many purposes the C<on_start> hook is a better
		485	place.
		486
		487	=item on_start $term
		488
		489	Called at the very end of initialisation of a new terminal, just before
		490	trying to map (display) the toplevel and returning to the main loop.
		491
		492	=item on_destroy $term
		493
		494	Called whenever something tries to destroy terminal, when the terminal is
		495	still fully functional (not for long, though).
210		496
211	=item on_reset $term	497	=item on_reset $term
212		498
213	Called after the screen is "reset" for any reason, such as resizing or	499	Called after the screen is "reset" for any reason, such as resizing or
214	control sequences. Here is where you can react on changes to size-related	500	control sequences. Here is where you can react on changes to size-related
215	variables.	501	variables.
216		502
217	=item on_start $term	503	=item on_child_start $term, $pid
218		504
219	Called at the very end of initialisation of a new terminal, just before	505	Called just after the child process has been C<fork>ed.
220	returning to the mainloop.	506
		507	=item on_child_exit $term, $status
		508
		509	Called just after the child process has exited. C<$status> is the status
		510	from C<waitpid>.
221		511
222	=item on_sel_make $term, $eventtime	512	=item on_sel_make $term, $eventtime
223		513
224	Called whenever a selection has been made by the user, but before the	514	Called whenever a selection has been made by the user, but before the
225	selection text is copied, so changes to the beginning, end or type of the	515	selection text is copied, so changes to the beginning, end or type of the
…		…
232		522
233	Called whenever a selection has been copied, but before the selection is	523	Called whenever a selection has been copied, but before the selection is
234	requested from the server. The selection text can be queried and changed	524	requested from the server. The selection text can be queried and changed
235	by calling C<< $term->selection >>.	525	by calling C<< $term->selection >>.
236		526
237	Returning a true value aborts selection grabbing. It will still be hilighted.	527	Returning a true value aborts selection grabbing. It will still be highlighted.
238		528
239	=item on_sel_extend $term	529	=item on_sel_extend $term
240		530
241	Called whenever the user tries to extend the selection (e.g. with a double	531	Called whenever the user tries to extend the selection (e.g. with a double
242	click) and is either supposed to return false (normal operation), or	532	click) and is either supposed to return false (normal operation), or
243	should extend the selection itelf and return true to suppress the built-in	533	should extend the selection itself and return true to suppress the built-in
244	processing. This can happen multiple times, as long as the callback	534	processing. This can happen multiple times, as long as the callback
245	returns true, it will be called on every further click by the user and is	535	returns true, it will be called on every further click by the user and is
246	supposed to enlarge the selection more and more, if possible.	536	supposed to enlarge the selection more and more, if possible.
247		537
248	See the F<selection> example extension.	538	See the F<selection> example extension.
249		539
250	=item on_view_change $term, $offset	540	=item on_view_change $term, $offset
251		541
252	Called whenever the view offset changes, i..e the user or program	542	Called whenever the view offset changes, i.e. the user or program
253	scrolls. Offset C<0> means display the normal terminal, positive values	543	scrolls. Offset C<0> means display the normal terminal, positive values
254	show this many lines of scrollback.	544	show this many lines of scrollback.
255		545
256	=item on_scroll_back $term, $lines, $saved	546	=item on_scroll_back $term, $lines, $saved
257		547
…		…
261		551
262	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	552	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
263	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	553	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
264	number of lines that will be in the scrollback buffer.	554	number of lines that will be in the scrollback buffer.
265		555
		556	=item on_osc_seq $term, $op, $args
		557
		558	Called on every OSC sequence and can be used to suppress it or modify its
		559	behaviour. The default should be to return an empty list. A true value
		560	suppresses execution of the request completely. Make sure you don't get
		561	confused by recursive invocations when you output an osc sequence within
		562	this callback.
		563
		564	C<on_osc_seq_perl> should be used for new behaviour.
		565
266	=item on_osc_seq $term, $string	566	=item on_osc_seq_perl $term, $string
267		567
268	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	568	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
269	operating system command) is processed. Cursor position and other state	569	operating system command) is processed. Cursor position and other state
270	information is up-to-date when this happens. For interoperability, the	570	information is up-to-date when this happens. For interoperability, the
271	string should start with the extension name and a colon, to distinguish	571	string should start with the extension name and a colon, to distinguish
272	it from commands for other extensions, and this might be enforced in the	572	it from commands for other extensions, and this might be enforced in the
273	future.	573	future.
274		574
275	Be careful not ever to trust (in a security sense) the data you receive,	575	Be careful not ever to trust (in a security sense) the data you receive,
276	as its source can not easily be controleld (e-mail content, messages from	576	as its source can not easily be controlled (e-mail content, messages from
277	other users on the same system etc.).	577	other users on the same system etc.).
278		578
279	=item on_add_lines $term, $string	579	=item on_add_lines $term, $string
280		580
281	Called whenever text is about to be output, with the text as argument. You	581	Called whenever text is about to be output, with the text as argument. You
…		…
312		612
313	=item on_refresh_end $term	613	=item on_refresh_end $term
314		614
315	Called just after the screen gets redrawn. See C<on_refresh_begin>.	615	Called just after the screen gets redrawn. See C<on_refresh_begin>.
316		616
317	=item on_keyboard_command $term, $string	617	=item on_user_command $term, $string
318		618
319	Called whenever the user presses a key combination that has a	619	Called whenever a user-configured event is being activated (e.g. via
320	C<perl:string> action bound to it (see description of the B<keysym>	620	a C<perl:string> action bound to a key, see description of the B<keysym>
321	resource in the @@RXVT_NAME@@(1) manpage).	621	resource in the @@RXVT_NAME@@(1) manpage).
		622
		623	The event is simply the action string. This interface is assumed to change
		624	slightly in the future.
		625
		626	=item on_resize_all_windows $tern, $new_width, $new_height
		627
		628	Called just after the new window size has been calculated, but before
		629	windows are actually being resized or hints are being set. If this hook
		630	returns TRUE, setting of the window hints is being skipped.
		631
		632	=item on_x_event $term, $event
		633
		634	Called on every X event received on the vt window (and possibly other
		635	windows). Should only be used as a last resort. Most event structure
		636	members are not passed.
		637
		638	=item on_root_event $term, $event
		639
		640	Like C<on_x_event>, but is called for events on the root window.
322		641
323	=item on_focus_in $term	642	=item on_focus_in $term
324		643
325	Called whenever the window gets the keyboard focus, before rxvt-unicode	644	Called whenever the window gets the keyboard focus, before rxvt-unicode
326	does focus in processing.	645	does focus in processing.
327		646
328	=item on_focus_out $term	647	=item on_focus_out $term
329		648
330	Called wheneever the window loses keyboard focus, before rxvt-unicode does	649	Called whenever the window loses keyboard focus, before rxvt-unicode does
331	focus out processing.	650	focus out processing.
		651
		652	=item on_configure_notify $term, $event
		653
		654	=item on_property_notify $term, $event
332		655
333	=item on_key_press $term, $event, $keysym, $octets	656	=item on_key_press $term, $event, $keysym, $octets
334		657
335	=item on_key_release $term, $event, $keysym	658	=item on_key_release $term, $event, $keysym
336		659
…		…
346		669
347	Called whenever the corresponding X event is received for the terminal If	670	Called whenever the corresponding X event is received for the terminal If
348	the hook returns true, then the even will be ignored by rxvt-unicode.	671	the hook returns true, then the even will be ignored by rxvt-unicode.
349		672
350	The event is a hash with most values as named by Xlib (see the XEvent	673	The event is a hash with most values as named by Xlib (see the XEvent
351	manpage), with the additional members C<row> and C<col>, which are the row	674	manpage), with the additional members C<row> and C<col>, which are the
352	and column under the mouse cursor.	675	(real, not screen-based) row and column under the mouse cursor.
353		676
354	C<on_key_press> additionally receives the string rxvt-unicode would	677	C<on_key_press> additionally receives the string rxvt-unicode would
355	output, if any, in locale-specific encoding.	678	output, if any, in locale-specific encoding.
356		679
357	subwindow.	680	subwindow.
		681
		682	=item on_client_message $term, $event
		683
		684	=item on_wm_protocols $term, $event
		685
		686	=item on_wm_delete_window $term, $event
		687
		688	Called when various types of ClientMessage events are received (all with
		689	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
358		690
359	=back	691	=back
360		692
361	=cut	693	=cut
362		694
…		…
368	use Scalar::Util ();	700	use Scalar::Util ();
369	use List::Util ();	701	use List::Util ();
370		702
371	our $VERSION = 1;	703	our $VERSION = 1;
372	our $TERM;	704	our $TERM;
		705	our @TERM_INIT;
		706	our @TERM_EXT;
373	our @HOOKNAME;	707	our @HOOKNAME;
374	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	708	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
375	our %OPTION;	709	our %OPTION;
376		710
377	our $LIBDIR;	711	our $LIBDIR;
378	our $RESNAME;	712	our $RESNAME;
379	our $RESCLASS;	713	our $RESCLASS;
380	our $RXVTNAME;	714	our $RXVTNAME;
381		715
		716	our $NOCHAR = chr 0xffff;
		717
382	=head2 Variables in the C<urxvt> Package	718	=head2 Variables in the C<urxvt> Package
383		719
384	=over 4	720	=over 4
385		721
386	=item $urxvt::LIBDIR	722	=item $urxvt::LIBDIR
…		…
398		734
399	=item $urxvt::TERM	735	=item $urxvt::TERM
400		736
401	The current terminal. This variable stores the current C<urxvt::term>	737	The current terminal. This variable stores the current C<urxvt::term>
402	object, whenever a callback/hook is executing.	738	object, whenever a callback/hook is executing.
		739
		740	=item @urxvt::TERM_INIT
		741
		742	All code references in this array will be called as methods of the next newly
		743	created C<urxvt::term> object (during the C<on_init> phase). The array
		744	gets cleared before the code references that were in it are being executed,
		745	so references can push themselves onto it again if they so desire.
		746
		747	This complements to the perl-eval command line option, but gets executed
		748	first.
		749
		750	=item @urxvt::TERM_EXT
		751
		752	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		753	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		754	but before other extensions. Gets cleared just like C<@TERM_INIT>.
403		755
404	=back	756	=back
405		757
406	=head2 Functions in the C<urxvt> Package	758	=head2 Functions in the C<urxvt> Package
407		759
…		…
422	Using this function has the advantage that its output ends up in the	774	Using this function has the advantage that its output ends up in the
423	correct place, e.g. on stderr of the connecting urxvtc client.	775	correct place, e.g. on stderr of the connecting urxvtc client.
424		776
425	Messages have a size limit of 1023 bytes currently.	777	Messages have a size limit of 1023 bytes currently.
426		778
427	=item $is_safe = urxvt::safe	779	=item @terms = urxvt::termlist
428		780
429	Returns true when it is safe to do potentially unsafe things, such as	781	Returns all urxvt::term objects that exist in this process, regardless of
430	evaluating perl code specified by the user. This is true when urxvt was	782	whether they are started, being destroyed etc., so be careful. Only term
431	started setuid or setgid.	783	objects that have perl extensions attached will be returned (because there
		784	is no urxvt::term objet associated with others).
432		785
433	=item $time = urxvt::NOW	786	=item $time = urxvt::NOW
434		787
435	Returns the "current time" (as per the event loop).	788	Returns the "current time" (as per the event loop).
436		789
437	=item urxvt::CurrentTime	790	=item urxvt::CurrentTime
438		791
439	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	792	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	793	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441	Button4Mask, Button5Mask, AnyModifier	794	Button4Mask, Button5Mask, AnyModifier
		795
		796	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		797	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		798	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		799	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		800	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		801	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		802	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		803
		804	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		805	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		806	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		807	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		808	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		809	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		810	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
442		811
443	Various constants for use in X calls and event processing.	812	Various constants for use in X calls and event processing.
444		813
445	=back	814	=back
446		815
…		…
479		848
480	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	849	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
481		850
482	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	851	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
483		852
		853	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		854
484	Replace the foreground/background colour in the rendition mask with the	855	Replace the foreground/background colour in the rendition mask with the
485	specified one.	856	specified one.
486		857
487	=item $value = urxvt::GET_CUSTOM $rend	858	=item $value = urxvt::GET_CUSTOM $rend
488		859
…		…
497	=back	868	=back
498		869
499	=cut	870	=cut
500		871
501	BEGIN {	872	BEGIN {
502	urxvt->bootstrap;
503
504	# overwrite perl's warn	873	# overwrite perl's warn
505	*CORE::GLOBAL::warn = sub {	874	*CORE::GLOBAL::warn = sub {
506	my $msg = join "", @_;	875	my $msg = join "", @_;
507	$msg .= "\n"	876	$msg .= "\n"
508	unless $msg =~ /\n$/;	877	unless $msg =~ /\n$/;
509	urxvt::warn ($msg);	878	urxvt::warn ($msg);
510	};	879	};
511
512	# %ENV is the original startup environment
513	delete $ENV{IFS};
514	delete $ENV{CDPATH};
515	delete $ENV{BASH_ENV};
516	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
517	}	880	}
518		881
519	my @hook_count;	882	no warnings 'utf8';
		883
520	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	884	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521		885
522	sub verbose {	886	sub verbose {
523	my ($level, $msg) = @_;	887	my ($level, $msg) = @_;
524	warn "$msg\n" if $level <= $verbosity;	888	warn "$msg\n" if $level <= $verbosity;
525	}	889	}
526		890
527	my $extension_pkg = "extension0000";
528	my %extension_pkg;	891	my %extension_pkg;
529		892
530	# load a single script into its own package, once only	893	# load a single script into its own package, once only
531	sub extension_package($) {	894	sub extension_package($) {
532	my ($path) = @_;	895	my ($path) = @_;
533		896
534	$extension_pkg{$path} \|\|= do {	897	$extension_pkg{$path} \|\|= do {
535	my $pkg = "urxvt::" . ($extension_pkg++);	898	$path =~ /([^\/\\]+)$/;
		899	my $pkg = $1;
		900	$pkg =~ s/[^[:word:]]/_/g;
		901	$pkg = "urxvt::ext::$pkg";
536		902
537	verbose 3, "loading extension '$path' into package '$pkg'";	903	verbose 3, "loading extension '$path' into package '$pkg'";
538		904
539	open my $fh, "<:raw", $path	905	open my $fh, "<:raw", $path
540	or die "$path: $!";	906	or die "$path: $!";
541		907
542	my $source = untaint	908	my $source =
543	"package $pkg; use strict; use utf8;\n"	909	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
544	. "use base urxvt::term::extension::;\n"
545	. "#line 1 \"$path\"\n{\n"	910	. "#line 1 \"$path\"\n{\n"
546	. (do { local $/; <$fh> })	911	. (do { local $/; <$fh> })
547	. "\n};\n1";	912	. "\n};\n1";
548		913
549	eval $source	914	eval $source
…		…
563	if ($htype == 0) { # INIT	928	if ($htype == 0) { # INIT
564	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	929	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
565		930
566	my %ext_arg;	931	my %ext_arg;
567		932
		933	{
		934	my @init = @TERM_INIT;
		935	@TERM_INIT = ();
		936	$_->($TERM) for @init;
		937	my @pkg = @TERM_EXT;
		938	@TERM_EXT = ();
		939	$TERM->register_package ($_) for @pkg;
		940	}
		941
568	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	942	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
569	if ($_ eq "default") {	943	if ($_ eq "default") {
570	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	944	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
571	} elsif (/^-(.*)$/) {	945	} elsif (/^-(.*)$/) {
572	delete $ext_arg{$1};	946	delete $ext_arg{$1};
573	} elsif (/^([^<]+)<(.*)>$/) {	947	} elsif (/^([^<]+)<(.*)>$/) {
574	push @{ $ext_arg{$1} }, $2;	948	push @{ $ext_arg{$1} }, $2;
575	} else {	949	} else {
576	$ext_arg{$_} \|\|= [];	950	$ext_arg{$_} \|\|= [];
577	}	951	}
578	}	952	}
579		953
580	while (my ($ext, $argv) = each %ext_arg) {	954	for my $ext (sort keys %ext_arg) {
581	my @files = grep -f $_, map "$_/$ext", @dirs;	955	my @files = grep -f $_, map "$_/$ext", @dirs;
582		956
583	if (@files) {	957	if (@files) {
584	$TERM->register_package (extension_package $files[0], $argv);	958	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
585	} else {	959	} else {
586	warn "perl extension '$ext' not found in perl library search path\n";	960	warn "perl extension '$ext' not found in perl library search path\n";
587	}	961	}
588	}	962	}
589		963
…		…
595		969
596	if (my $cb = $TERM->{_hook}[$htype]) {	970	if (my $cb = $TERM->{_hook}[$htype]) {
597	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	971	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
598	if $verbosity >= 10;	972	if $verbosity >= 10;
599		973
600	keys %$cb;	974	for my $pkg (keys %$cb) {
601
602	while (my ($pkg, $cb) = each %$cb) {
603	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	975	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
604	and last;	976	$retval \|\|= $retval_;
605		977
606	if ($@) {	978	if ($@) {
607	$TERM->ungrab; # better to lose the grab than the session	979	$TERM->ungrab; # better to lose the grab than the session
608	warn $@;	980	warn $@;
609	}	981	}
…		…
612	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	984	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613	if $verbosity >= 11;	985	if $verbosity >= 11;
614	}	986	}
615		987
616	if ($htype == 1) { # DESTROY	988	if ($htype == 1) { # DESTROY
617	if (my $hook = delete $TERM->{_hook}) {
618	for my $htype (0..$#$hook) {
619	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
620	or set_should_invoke $htype, 0;
621	}
622	}
623
624	# clear package objects	989	# clear package objects
625	%$_ = () for values %{ $TERM->{_pkg} };	990	%$_ = () for values %{ $TERM->{_pkg} };
626		991
627	# clear package	992	# clear package
628	%$TERM = ();	993	%$TERM = ();
629	}	994	}
630		995
631	$retval	996	$retval
632	}	997	}
633		998
634	sub exec_async(@) {	999	sub SET_COLOR($$$) {
635	my $pid = fork;	1000	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1001	}
636		1002
637	return	1003	sub rend2mask {
638	if !defined $pid or $pid;	1004	no strict 'refs';
639		1005	my ($str, $mask) = (@_, 0);
640	%ENV = %{ $TERM->env };	1006	my %color = ( fg => undef, bg => undef );
641		1007	my @failed;
642	exec @_;	1008	for my $spec ( split /\s+/, $str ) {
643	_exit 255;	1009	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1010	$color{lc($1)} = $2;
		1011	} else {
		1012	my $neg = $spec =~ s/^[-^]//;
		1013	unless ( exists &{"RS_$spec"} ) {
		1014	push @failed, $spec;
		1015	next;
		1016	}
		1017	my $cur = &{"RS_$spec"};
		1018	if ( $neg ) {
		1019	$mask &= ~$cur;
		1020	} else {
		1021	$mask \|= $cur;
		1022	}
		1023	}
		1024	}
		1025	($mask, @color{qw(fg bg)}, \@failed)
644	}	1026	}
645		1027
646	# urxvt::term::extension	1028	# urxvt::term::extension
647		1029
648	package urxvt::term::extension;	1030	package urxvt::term::extension;
…		…
654	while (my ($name, $cb) = each %hook) {	1036	while (my ($name, $cb) = each %hook) {
655	my $htype = $HOOKTYPE{uc $name};	1037	my $htype = $HOOKTYPE{uc $name};
656	defined $htype	1038	defined $htype
657	or Carp::croak "unsupported hook type '$name'";	1039	or Carp::croak "unsupported hook type '$name'";
658		1040
		1041	$self->set_should_invoke ($htype, +1)
659	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1042	unless exists $self->{term}{_hook}[$htype]{$pkg};
660	$hook_count[$htype]++
661	or urxvt::set_should_invoke $htype, 1;
662	}
663		1043
664	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1044	$self->{term}{_hook}[$htype]{$pkg} = $cb;
665	}	1045	}
666	}	1046	}
667		1047
…		…
672	for my $name (@hook) {	1052	for my $name (@hook) {
673	my $htype = $HOOKTYPE{uc $name};	1053	my $htype = $HOOKTYPE{uc $name};
674	defined $htype	1054	defined $htype
675	or Carp::croak "unsupported hook type '$name'";	1055	or Carp::croak "unsupported hook type '$name'";
676		1056
		1057	$self->set_should_invoke ($htype, -1)
677	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1058	if delete $self->{term}{_hook}[$htype]{$pkg};
678	--$hook_count[$htype]
679	or urxvt::set_should_invoke $htype, 0;
680	}
681	}	1059	}
682	}	1060	}
683		1061
684	our $AUTOLOAD;	1062	our $AUTOLOAD;
685		1063
…		…
765	sub DESTROY {	1143	sub DESTROY {
766	$_[0][1]->stop;	1144	$_[0][1]->stop;
767	}	1145	}
768		1146
769	sub condvar {	1147	sub condvar {
770	bless \my $flag, urxvt::anyevent::condvar::	1148	bless \my $flag, urxvt::anyevent::
771	}	1149	}
772		1150
773	sub urxvt::anyevent::condvar::broadcast {	1151	sub broadcast {
774	${$_[0]}++;	1152	${$_[0]}++;
775	}	1153	}
776		1154
777	sub urxvt::anyevent::condvar::wait {	1155	sub wait {
778	unless (${$_[0]}) {	1156	unless (${$_[0]}) {
779	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1157	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
780	}	1158	}
		1159	}
		1160
		1161	sub one_event {
		1162	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
781	}	1163	}
782		1164
783	package urxvt::term;	1165	package urxvt::term;
784		1166
785	=head2 The C<urxvt::term> Class	1167	=head2 The C<urxvt::term> Class
…		…
790		1172
791	# find on_xxx subs in the package and register them	1173	# find on_xxx subs in the package and register them
792	# as hooks	1174	# as hooks
793	sub register_package {	1175	sub register_package {
794	my ($self, $pkg, $argv) = @_;	1176	my ($self, $pkg, $argv) = @_;
		1177
		1178	no strict 'refs';
		1179
		1180	urxvt::verbose 6, "register package $pkg to $self";
		1181
		1182	@{"$pkg\::ISA"} = urxvt::term::extension::;
795		1183
796	my $proxy = bless {	1184	my $proxy = bless {
797	_pkg => $pkg,	1185	_pkg => $pkg,
798	argv => $argv,	1186	argv => $argv,
799	}, $pkg;	1187	}, $pkg;
…		…
815	hash which defines the environment of the new terminal.	1203	hash which defines the environment of the new terminal.
816		1204
817	Croaks (and probably outputs an error message) if the new instance	1205	Croaks (and probably outputs an error message) if the new instance
818	couldn't be created. Returns C<undef> if the new instance didn't	1206	couldn't be created. Returns C<undef> if the new instance didn't
819	initialise perl, and the terminal object otherwise. The C<init> and	1207	initialise perl, and the terminal object otherwise. The C<init> and
820	C<start> hooks will be called during this call.	1208	C<start> hooks will be called before this call returns, and are free to
		1209	refer to global data (which is race free).
821		1210
822	=cut	1211	=cut
823		1212
824	sub new {	1213	sub new {
825	my ($class, $env, @args) = @_;	1214	my ($class, $env, @args) = @_;
826		1215
		1216	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1217	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1218
827	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1219	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
828	}	1220	}
829		1221
830	=item $term->destroy	1222	=item $term->destroy
831		1223
832	Destroy the terminal object (close the window, free resources	1224	Destroy the terminal object (close the window, free resources
833	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1225	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
834	watchers (timers, io watchers) are still active.	1226	watchers (timers, io watchers) are still active.
835		1227
		1228	=item $term->exec_async ($cmd[, @args])
		1229
		1230	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1231	("starts") programs in the background. This function takes care of setting
		1232	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1233	be preferred over explicit calls to C<exec> or C<system>.
		1234
		1235	Returns the pid of the subprocess or C<undef> on error.
		1236
		1237	=cut
		1238
		1239	sub exec_async {
		1240	my $self = shift;
		1241
		1242	my $pid = fork;
		1243
		1244	return $pid
		1245	if !defined $pid or $pid;
		1246
		1247	%ENV = %{ $self->env };
		1248
		1249	exec @_;
		1250	urxvt::_exit 255;
		1251	}
		1252
836	=item $isset = $term->option ($optval[, $set])	1253	=item $isset = $term->option ($optval[, $set])
837		1254
838	Returns true if the option specified by C<$optval> is enabled, and	1255	Returns true if the option specified by C<$optval> is enabled, and
839	optionally change it. All option values are stored by name in the hash	1256	optionally change it. All option values are stored by name in the hash
840	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1257	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
841		1258
842	Here is a a likely non-exhaustive list of option names, please see the	1259	Here is a likely non-exhaustive list of option names, please see the
843	source file F</src/optinc.h> to see the actual list:	1260	source file F</src/optinc.h> to see the actual list:
844		1261
845	borderLess console cursorBlink cursorUnderline hold iconic insecure	1262	borderLess console cursorBlink cursorUnderline hold iconic insecure
846	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1263	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
847	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1264	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
848	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1265	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
849	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1266	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
850	tripleclickwords utmpInhibit visualBell	1267	transparent tripleclickwords utmpInhibit visualBell
851		1268
852	=item $value = $term->resource ($name[, $newval])	1269	=item $value = $term->resource ($name[, $newval])
853		1270
854	Returns the current resource value associated with a given name and	1271	Returns the current resource value associated with a given name and
855	optionally sets a new value. Setting values is most useful in the C<init>	1272	optionally sets a new value. Setting values is most useful in the C<init>
…		…
864	likely change).	1281	likely change).
865		1282
866	Please note that resource strings will currently only be freed when the	1283	Please note that resource strings will currently only be freed when the
867	terminal is destroyed, so changing options frequently will eat memory.	1284	terminal is destroyed, so changing options frequently will eat memory.
868		1285
869	Here is a a likely non-exhaustive list of resource names, not all of which	1286	Here is a likely non-exhaustive list of resource names, not all of which
870	are supported in every build, please see the source file F</src/rsinc.h>	1287	are supported in every build, please see the source file F</src/rsinc.h>
871	to see the actual list:	1288	to see the actual list:
872		1289
873	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1290	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
874	borderLess color cursorBlink cursorUnderline cutchars delete_key	1291	borderLess color cursorBlink cursorUnderline cutchars delete_key
875	display_name embed ext_bwidth fade font geometry hold iconName	1292	display_name embed ext_bwidth fade font geometry hold iconName
876	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1293	imFont imLocale inputMethod insecure int_bwidth intensityStyles
877	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1294	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
878	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1295	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
879	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1296	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
880	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1297	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
881	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1298	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
882	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1299	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
883	shade term_name title transparent transparent_all tripleclickwords	1300	secondaryScreen secondaryScroll selectstyle shade term_name title
884	utmpInhibit visualBell	1301	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1302	visualBell
885		1303
886	=cut	1304	=cut
887		1305
888	sub resource($$;$) {	1306	sub resource($$;$) {
889	my ($self, $name) = (shift, shift);	1307	my ($self, $name) = (shift, shift);
…		…
1063		1481
1064	Normally its not a good idea to use this function, as programs might be	1482	Normally its not a good idea to use this function, as programs might be
1065	confused by changes in cursor position or scrolling. Its useful inside a	1483	confused by changes in cursor position or scrolling. Its useful inside a
1066	C<on_add_lines> hook, though.	1484	C<on_add_lines> hook, though.
1067		1485
		1486	=item $term->scr_change_screen ($screen)
		1487
		1488	Switch to given screen - 0 primary, 1 secondary.
		1489
1068	=item $term->cmd_parse ($octets)	1490	=item $term->cmd_parse ($octets)
1069		1491
1070	Similar to C<scr_add_lines>, but the argument must be in the	1492	Similar to C<scr_add_lines>, but the argument must be in the
1071	locale-specific encoding of the terminal and can contain command sequences	1493	locale-specific encoding of the terminal and can contain command sequences
1072	(escape codes) that will be interpreted.	1494	(escape codes) that will be interpreted.
…		…
1082	Replaces the event mask of the pty watcher by the given event mask. Can	1504	Replaces the event mask of the pty watcher by the given event mask. Can
1083	be used to suppress input and output handling to the pty/tty. See the	1505	be used to suppress input and output handling to the pty/tty. See the
1084	description of C<< urxvt::timer->events >>. Make sure to always restore	1506	description of C<< urxvt::timer->events >>. Make sure to always restore
1085	the previous value.	1507	the previous value.
1086		1508
		1509	=item $fd = $term->pty_fd
		1510
		1511	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1512	is used.
		1513
1087	=item $windowid = $term->parent	1514	=item $windowid = $term->parent
1088		1515
1089	Return the window id of the toplevel window.	1516	Return the window id of the toplevel window.
1090		1517
1091	=item $windowid = $term->vt	1518	=item $windowid = $term->vt
1092		1519
1093	Return the window id of the terminal window.	1520	Return the window id of the terminal window.
1094		1521
		1522	=item $term->vt_emask_add ($x_event_mask)
		1523
		1524	Adds the specified events to the vt event mask. Useful e.g. when you want
		1525	to receive pointer events all the times:
		1526
		1527	$term->vt_emask_add (urxvt::PointerMotionMask);
		1528
		1529	=item $term->focus_in
		1530
		1531	=item $term->focus_out
		1532
		1533	=item $term->key_press ($state, $keycode[, $time])
		1534
		1535	=item $term->key_release ($state, $keycode[, $time])
		1536
		1537	Deliver various fake events to to terminal.
		1538
1095	=item $window_width = $term->width	1539	=item $window_width = $term->width
1096		1540
1097	=item $window_height = $term->height	1541	=item $window_height = $term->height
1098		1542
1099	=item $font_width = $term->fwidth	1543	=item $font_width = $term->fwidth
…		…
1112		1556
1113	=item $max_scrollback = $term->saveLines	1557	=item $max_scrollback = $term->saveLines
1114		1558
1115	=item $nrow_plus_saveLines = $term->total_rows	1559	=item $nrow_plus_saveLines = $term->total_rows
1116		1560
1117	=item $lines_in_scrollback = $term->nsaved	1561	=item $topmost_scrollback_row = $term->top_row
1118		1562
1119	Return various integers describing terminal characteristics.	1563	Return various integers describing terminal characteristics.
1120		1564
1121	=item $x_display = $term->display_id	1565	=item $x_display = $term->display_id
1122		1566
…		…
1129	=item $env = $term->env	1573	=item $env = $term->env
1130		1574
1131	Returns a copy of the environment in effect for the terminal as a hashref	1575	Returns a copy of the environment in effect for the terminal as a hashref
1132	similar to C<\%ENV>.	1576	similar to C<\%ENV>.
1133		1577
		1578	=item @envv = $term->envv
		1579
		1580	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1581
		1582	=item @argv = $term->argv
		1583
		1584	Return the argument vector as this terminal, similar to @ARGV, but
		1585	includes the program name as first element.
		1586
1134	=cut	1587	=cut
1135		1588
1136	sub env {	1589	sub env {
1137	if (my $env = $_[0]->_env) {
1138	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1590	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1139	} else {
1140	+{ %ENV }
1141	}
1142	}	1591	}
1143		1592
1144	=item $modifiermask = $term->ModLevel3Mask	1593	=item $modifiermask = $term->ModLevel3Mask
1145		1594
1146	=item $modifiermask = $term->ModMetaMask	1595	=item $modifiermask = $term->ModMetaMask
…		…
1148	=item $modifiermask = $term->ModNumLockMask	1597	=item $modifiermask = $term->ModNumLockMask
1149		1598
1150	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1599	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1151	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1600	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1152		1601
		1602	=item $screen = $term->current_screen
		1603
		1604	Returns the currently displayed screen (0 primary, 1 secondary).
		1605
		1606	=item $cursor_is_hidden = $term->hidden_cursor
		1607
		1608	Returns whether the cursor is currently hidden or not.
		1609
1153	=item $view_start = $term->view_start ([$newvalue])	1610	=item $view_start = $term->view_start ([$newvalue])
1154		1611
1155	Returns the negative row number of the topmost line. Minimum value is	1612	Returns the row number of the topmost displayed line. Maximum value is
1156	C<0>, which displays the normal terminal contents. Larger values scroll	1613	C<0>, which displays the normal terminal contents. Lower values scroll
1157	this many lines into the scrollback buffer.	1614	this many lines into the scrollback buffer.
1158		1615
1159	=item $term->want_refresh	1616	=item $term->want_refresh
1160		1617
1161	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1618	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1176	line, starting at column C<$start_col> (default C<0>), which is useful	1633	line, starting at column C<$start_col> (default C<0>), which is useful
1177	to replace only parts of a line. The font index in the rendition will	1634	to replace only parts of a line. The font index in the rendition will
1178	automatically be updated.	1635	automatically be updated.
1179		1636
1180	C<$text> is in a special encoding: tabs and wide characters that use more	1637	C<$text> is in a special encoding: tabs and wide characters that use more
1181	than one cell when displayed are padded with urxvt::NOCHAR characters	1638	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1182	(C<chr 65535>). Characters with combining characters and other characters	1639	characters. Characters with combining characters and other characters that
1183	that do not fit into the normal tetx encoding will be replaced with	1640	do not fit into the normal tetx encoding will be replaced with characters
1184	characters in the private use area.	1641	in the private use area.
1185		1642
1186	You have to obey this encoding when changing text. The advantage is	1643	You have to obey this encoding when changing text. The advantage is
1187	that C<substr> and similar functions work on screen cells and not on	1644	that C<substr> and similar functions work on screen cells and not on
1188	characters.	1645	characters.
1189		1646
…		…
1333	where one character corresponds to one screen cell. See	1790	where one character corresponds to one screen cell. See
1334	C<< $term->ROW_t >> for details.	1791	C<< $term->ROW_t >> for details.
1335		1792
1336	=item $string = $term->special_decode $text	1793	=item $string = $term->special_decode $text
1337		1794
1338	Converts rxvt-unicodes text reprsentation into a perl string. See	1795	Converts rxvt-unicodes text representation into a perl string. See
1339	C<< $term->ROW_t >> for details.	1796	C<< $term->ROW_t >> for details.
1340		1797
1341	=item $success = $term->grab_button ($button, $modifiermask)	1798	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1342		1799
		1800	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1801
1343	Registers a synchronous button grab. See the XGrabButton manpage.	1802	Register/unregister a synchronous button grab. See the XGrabButton
		1803	manpage.
1344		1804
1345	=item $success = $term->grab ($eventtime[, $sync])	1805	=item $success = $term->grab ($eventtime[, $sync])
1346		1806
1347	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1807	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1348	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1808	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1349		1809
1350	=item $term->allow_events_async	1810	=item $term->allow_events_async
1351		1811
1352	Calls XAllowEvents with AsyncBoth for the most recent grab.	1812	Calls XAllowEvents with AsyncBoth for the most recent grab.
1353		1813
…		…
1363	=item $term->ungrab	1823	=item $term->ungrab
1364		1824
1365	Calls XUngrab for the most recent grab. Is called automatically on	1825	Calls XUngrab for the most recent grab. Is called automatically on
1366	evaluation errors, as it is better to lose the grab in the error case as	1826	evaluation errors, as it is better to lose the grab in the error case as
1367	the session.	1827	the session.
		1828
		1829	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1830
		1831	=item $atom_name = $term->XGetAtomName ($atom)
		1832
		1833	=item @atoms = $term->XListProperties ($window)
		1834
		1835	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1836
		1837	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1838
		1839	=item $term->XDeleteProperty ($window, $property)
		1840
		1841	=item $window = $term->DefaultRootWindow
		1842
		1843	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1844
		1845	=item $term->XMapWindow ($window)
		1846
		1847	=item $term->XUnmapWindow ($window)
		1848
		1849	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1850
		1851	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1852
		1853	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1854
		1855	Various X or X-related functions. The C<$term> object only serves as
		1856	the source of the display, otherwise those functions map more-or-less
		1857	directory onto the X functions of the same name.
1368		1858
1369	=back	1859	=back
1370		1860
1371	=cut	1861	=cut
1372		1862
…		…
1436	my ($self, $text, $cb) = @_;	1926	my ($self, $text, $cb) = @_;
1437		1927
1438	$self->add_item ({ type => "button", text => $text, activate => $cb});	1928	$self->add_item ({ type => "button", text => $text, activate => $cb});
1439	}	1929	}
1440		1930
1441	=item $popup->add_toggle ($text, $cb, $initial_value)	1931	=item $popup->add_toggle ($text, $initial_value, $cb)
1442		1932
1443	Adds a toggle/checkbox item to the popup. Teh callback gets called	1933	Adds a toggle/checkbox item to the popup. The callback gets called
1444	whenever it gets toggled, with a boolean indicating its value as its first	1934	whenever it gets toggled, with a boolean indicating its new value as its
1445	argument.	1935	first argument.
1446		1936
1447	=cut	1937	=cut
1448		1938
1449	sub add_toggle {	1939	sub add_toggle {
1450	my ($self, $text, $cb, $value) = @_;	1940	my ($self, $text, $value, $cb) = @_;
1451		1941
1452	my $item; $item = {	1942	my $item; $item = {
1453	type => "button",	1943	type => "button",
1454	text => " $text",	1944	text => " $text",
1455	value => $value,	1945	value => $value,
…		…
1474	my $env = $self->{term}->env;	1964	my $env = $self->{term}->env;
1475	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1965	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1476	delete $env->{LC_ALL};	1966	delete $env->{LC_ALL};
1477	$env->{LC_CTYPE} = $self->{term}->locale;	1967	$env->{LC_CTYPE} = $self->{term}->locale;
1478		1968
1479	urxvt::term->new ($env, $self->{term}->resource ("name"),	1969	urxvt::term->new ($env, "popup",
1480	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1970	"--perl-lib" => "", "--perl-ext-common" => "",
		1971	"-pty-fd" => -1, "-sl" => 0,
		1972	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1481	"--transient-for" => $self->{term}->parent,	1973	"--transient-for" => $self->{term}->parent,
1482	"-display" => $self->{term}->display_id,	1974	"-display" => $self->{term}->display_id,
1483	"-pe" => "urxvt-popup")	1975	"-pe" => "urxvt-popup")
1484	or die "unable to create popup window\n";	1976	or die "unable to create popup window\n";
1485	}	1977	}
…		…
1490	delete $self->{term}{_destroy}{$self};	1982	delete $self->{term}{_destroy}{$self};
1491	$self->{term}->ungrab;	1983	$self->{term}->ungrab;
1492	}	1984	}
1493		1985
1494	=back	1986	=back
		1987
		1988	=cut
		1989
		1990	package urxvt::watcher;
1495		1991
1496	=head2 The C<urxvt::timer> Class	1992	=head2 The C<urxvt::timer> Class
1497		1993
1498	This class implements timer watchers/events. Time is represented as a	1994	This class implements timer watchers/events. Time is represented as a
1499	fractional number of seconds since the epoch. Example:	1995	fractional number of seconds since the epoch. Example:
…		…
1537	Start the timer.	2033	Start the timer.
1538		2034
1539	=item $timer = $timer->start ($tstamp)	2035	=item $timer = $timer->start ($tstamp)
1540		2036
1541	Set the event trigger time to C<$tstamp> and start the timer.	2037	Set the event trigger time to C<$tstamp> and start the timer.
		2038
		2039	=item $timer = $timer->after ($delay)
		2040
		2041	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1542		2042
1543	=item $timer = $timer->stop	2043	=item $timer = $timer->stop
1544		2044
1545	Stop the timer.	2045	Stop the timer.
1546		2046
…		…
1575	Set the callback to be called when io events are triggered. C<$reventmask>	2075	Set the callback to be called when io events are triggered. C<$reventmask>
1576	is a bitset as described in the C<events> method.	2076	is a bitset as described in the C<events> method.
1577		2077
1578	=item $iow = $iow->fd ($fd)	2078	=item $iow = $iow->fd ($fd)
1579		2079
1580	Set the filedescriptor (not handle) to watch.	2080	Set the file descriptor (not handle) to watch.
1581		2081
1582	=item $iow = $iow->events ($eventmask)	2082	=item $iow = $iow->events ($eventmask)
1583		2083
1584	Set the event mask to watch. The only allowed values are	2084	Set the event mask to watch. The only allowed values are
1585	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2085	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
…		…
1589		2089
1590	Start watching for requested events on the given handle.	2090	Start watching for requested events on the given handle.
1591		2091
1592	=item $iow = $iow->stop	2092	=item $iow = $iow->stop
1593		2093
1594	Stop watching for events on the given filehandle.	2094	Stop watching for events on the given file handle.
		2095
		2096	=back
		2097
		2098	=head2 The C<urxvt::iw> Class
		2099
		2100	This class implements idle watchers, that get called automatically when
		2101	the process is idle. They should return as fast as possible, after doing
		2102	some useful work.
		2103
		2104	=over 4
		2105
		2106	=item $iw = new urxvt::iw
		2107
		2108	Create a new idle watcher object in stopped state.
		2109
		2110	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2111
		2112	Set the callback to be called when the watcher triggers.
		2113
		2114	=item $timer = $timer->start
		2115
		2116	Start the watcher.
		2117
		2118	=item $timer = $timer->stop
		2119
		2120	Stop the watcher.
		2121
		2122	=back
		2123
		2124	=head2 The C<urxvt::pw> Class
		2125
		2126	This class implements process watchers. They create an event whenever a
		2127	process exits, after which they stop automatically.
		2128
		2129	my $pid = fork;
		2130	...
		2131	$term->{pw} = urxvt::pw
		2132	->new
		2133	->start ($pid)
		2134	->cb (sub {
		2135	my ($pw, $exit_status) = @_;
		2136	...
		2137	});
		2138
		2139	=over 4
		2140
		2141	=item $pw = new urxvt::pw
		2142
		2143	Create a new process watcher in stopped state.
		2144
		2145	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2146
		2147	Set the callback to be called when the timer triggers.
		2148
		2149	=item $pw = $timer->start ($pid)
		2150
		2151	Tells the watcher to start watching for process C<$pid>.
		2152
		2153	=item $pw = $pw->stop
		2154
		2155	Stop the watcher.
1595		2156
1596	=back	2157	=back
1597		2158
1598	=head1 ENVIRONMENT	2159	=head1 ENVIRONMENT
1599		2160
…		…
1608		2169
1609	=item >= 3 - script loading and management	2170	=item >= 3 - script loading and management
1610		2171
1611	=item >=10 - all called hooks	2172	=item >=10 - all called hooks
1612		2173
1613	=item >=11 - hook reutrn values	2174	=item >=11 - hook return values
1614		2175
1615	=back	2176	=back
1616		2177
1617	=head1 AUTHOR	2178	=head1 AUTHOR
1618		2179
…		…
1620	http://software.schmorp.de/pkg/rxvt-unicode	2181	http://software.schmorp.de/pkg/rxvt-unicode
1621		2182
1622	=cut	2183	=cut
1623		2184
1624	1	2185	1
		2186
		2187	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC vs. Revision 1.154 by root, Sat Jun 2 06:43:02 2007 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.154 by root, Sat Jun 2 06:43:02 2007 UTC