ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC vs.
Revision 1.214 by root, Wed Jun 6 15:26:32 2012 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	71	between two vertical bars:
65		72
66	URxvt.selection.pattern-0: \\|([^|]+)\\|	73	URxvt.selection.pattern-0: \\|([^|]+)\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
67		81
68	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
83	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
84		98
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.	100	runtime.
87		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
88	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
89		120
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
93		124
94	Other extensions can extend this popup menu by pushing a code reference onto	125	Other extensions can extend this popup menu by pushing a code reference
95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
96		128
97	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
98	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
99	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
100	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
101	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
102		134
103	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
104	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	137	C<a>s:
106		138
107	push urxvt::ext::selection_popup::hook, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
109	: ()	141	: ()
110	};	142	};
111		143
112	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
113		145
…		…
120	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
121	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
122	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
123	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
124	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
125	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
126		189
127	=item selection-autotransform	190	=item selection-autotransform
128		191
129	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
130	whenever a selection is made.	193	whenever a selection is made.
…		…
143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144		207
145	And this example matches the same,but replaces it with vi-commands you can	208	And this example matches the same,but replaces it with vi-commands you can
146	paste directly into your (vi :) editor:	209	paste directly into your (vi :) editor:
147		210
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149		212
150	Of course, this can be modified to suit your needs and your editor :)	213	Of course, this can be modified to suit your needs and your editor :)
151		214
152	To expand the example above to typical perl error messages ("XXX at	215	To expand the example above to typical perl error messages ("XXX at
153	FILENAME line YYY."), you need a slightly more elaborate solution:	216	FILENAME line YYY."), you need a slightly more elaborate solution:
154		217
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157		220
158	The first line tells the selection code to treat the unchanging part of	221	The first line tells the selection code to treat the unchanging part of
159	every error message as a selection pattern, and the second line transforms	222	every error message as a selection pattern, and the second line transforms
160	the message into vi commands to load the file.	223	the message into vi commands to load the file.
161		224
162	=item mark-urls	225	=item tabbed
163		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
164	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
165	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
166	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
167	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
		266	"perl:matcher:list" as seen in the example below.
		267
		268	Example configuration:
		269
		270	URxvt.perl-ext: default,matcher
		271	URxvt.urlLauncher: sensible-browser
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
		274	URxvt.matcher.button: 1
		275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		277	URxvt.matcher.launcher.2: gvim +$2 $1
		278
		279	=item xim-onthespot
		280
		281	This (experimental) perl extension implements OnTheSpot editing. It does
		282	not work perfectly, and some input methods don't seem to work well with
		283	OnTheSpot editing in general, but it seems to work at least for SCIM and
		284	kinput2.
		285
		286	You enable it by specifying this extension and a preedit style of
		287	C<OnTheSpot>, i.e.:
		288
		289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		290
		291	=item kuake<hotkey>
		292
		293	A very primitive quake-console-like extension. It was inspired by a
		294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		295	user presses a global accelerator key (by default C<F10>), the terminal
		296	will show or hide itself. Another press of the accelerator key will hide
		297	or show it again.
		298
		299	Initially, the window will not be shown when using this extension.
		300
		301	This is useful if you need a single terminal that is not using any desktop
		302	space most of the time but is quickly available at the press of a key.
		303
		304	The accelerator key is grabbed regardless of any modifiers, so this
		305	extension will actually grab a physical key just for this function.
		306
		307	If you want a quake-like animation, tell your window manager to do so
		308	(fvwm can do it).
		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
168		315
169	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
170		317
171	A not very useful example of filtering all text output to the terminal,	318	A not very useful example of filtering all text output to the terminal
172	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
173	similar-looking ascii character.	320	similar-looking ascii character.
174		321
175	=item digital-clock	322	=item digital-clock
176		323
177	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
		325
		326	=item remote-clipboard
		327
		328	Somewhat of a misnomer, this extension adds two menu entries to the
		329	selection popup that allows one to run external commands to store the
		330	selection somewhere and fetch it again.
		331
		332	We use it to implement a "distributed selection mechanism", which just
		333	means that one command uploads the file to a remote server, and another
		334	reads it.
		335
		336	The commands can be set using the C<URxvt.remote-selection.store> and
		337	C<URxvt.remote-selection.fetch> resources. The first should read the
		338	selection to store from STDIN (always in UTF-8), the second should provide
		339	the selection data on STDOUT (also in UTF-8).
		340
		341	The defaults (which are likely useless to you) use rsh and cat:
		342
		343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		345
		346	=item selection-pastebin
		347
		348	This is a little rarely useful extension that uploads the selection as
		349	textfile to a remote site (or does other things). (The implementation is
		350	not currently secure for use in a multiuser environment as it writes to
		351	F</tmp> directly.).
		352
		353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		354	i.e.
		355
		356	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		357
		358	Pressing this combination runs a command with C<%> replaced by the name of
		359	the textfile. This command can be set via a resource:
		360
		361	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		362
		363	And the default is likely not useful to anybody but the few people around
		364	here :)
		365
		366	The name of the textfile is the hex encoded md5 sum of the selection, so
		367	the same content should lead to the same filename.
		368
		369	After a successful upload the selection will be replaced by the text given
		370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		371	for the filename):
		372
		373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		374
		375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		376	the double C</> characters as comment start. Use C<\057\057> instead,
		377	which works regardless of whether xrdb is used to parse the resource file
		378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
178		393
179	=item example-refresh-hooks	394	=item example-refresh-hooks
180		395
181	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
182	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
183	overlays or changes.	398	overlays or changes.
184		399
185	=item selection-pastebin	400	=item confirm-paste
186		401
187	This is a little rarely useful extension that Uploads the selection as	402	Displays a confirmation dialog when a paste containing at least a full
188	textfile to a remote site (or does other things). (The implementation is	403	line is detected.
189	not currently secure for use in a multiuser environment as it writes to
190	F</tmp> directly.).
191		404
192	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	405	=item bell-command
193	i.e.
194		406
195	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin	407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
196		410
197	Pressing this combination runs a command with C<%> replaced by the name of	411	URxvt.bell-command: notify-send "Beep, Beep"
198	the textfile. This command can be set via a resource:
199
200	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
201
202	And the default is likely not useful to anybody but the few people around
203	here :)
204
205	The name of the textfile is the hex encoded md5 sum of the selection, so
206	the same content should lead to the same filename.
207
208	After a successful upload the selection will be replaced by the text given
209	in the C<selection-pastebin-url> resource (again, the % is the placeholder
210	for the filename):
211
212	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
213		412
214	=back	413	=back
215		414
216	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
217		416
…		…
233		432
234	=over 4	433	=over 4
235		434
236	=item $text	435	=item $text
237		436
238	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
239	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
240		439
241	=item $string	440	=item $string
242		441
243	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
247	=item $octets	446	=item $octets
248		447
249	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
250	locale-specific way.	449	locale-specific way.
251		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
252	=back	457	=back
253		458
254	=head2 Extension Objects	459	=head2 Extension Objects
255		460
256	Very perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
257	for each terminal and each extension and passed as the first parameter to	462	for each terminal, and each terminal has its own set of extension objects,
258	hooks. So extensions can use their C<$self> object without having to think	463	which are passed as the first parameter to hooks. So extensions can use
259	about other extensions, with the exception of methods and members that	464	their C<$self> object without having to think about clashes with other
		465	extensions or other terminals, with the exception of methods and members
260	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
261	use.	467	internal use.
262		468
263	Although it isn't a C<urxvt::term> object, you can call all methods of the	469	Although it isn't a C<urxvt::term> object, you can call all methods of the
264	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
265		471
266	It has the following methods and data members:	472	It has the following methods and data members:
…		…
287	=head2 Hooks	493	=head2 Hooks
288		494
289	The following subroutines can be declared in extension files, and will be	495	The following subroutines can be declared in extension files, and will be
290	called whenever the relevant event happens.	496	called whenever the relevant event happens.
291		497
292	The first argument passed to them is an extension oject as described in	498	The first argument passed to them is an extension object as described in
293	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
294		500
295	B<All> of these hooks must return a boolean value. If it is true, then the	501	B<All> of these hooks must return a boolean value. If any of the called
296	event counts as being I<consumed>, and the invocation of other hooks is	502	hooks returns true, then the event counts as being I<consumed>, and the
297	skipped, and the relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
298		504
299	I<< When in doubt, return a false value (preferably C<()>). >>	505	I<< When in doubt, return a false value (preferably C<()>). >>
300		506
301	=over 4	507	=over 4
302		508
303	=item on_init $term	509	=item on_init $term
304		510
305	Called after a new terminal object has been initialized, but before	511	Called after a new terminal object has been initialized, but before
306	windows are created or the command gets run. Most methods are unsafe to	512	windows are created or the command gets run. Most methods are unsafe to
307	call or deliver senseless data, as terminal size and other characteristics	513	call or deliver senseless data, as terminal size and other characteristics
308	have not yet been determined. You can safely query and change resources,	514	have not yet been determined. You can safely query and change resources
309	though.	515	and options, though. For many purposes the C<on_start> hook is a better
		516	place.
		517
		518	=item on_start $term
		519
		520	Called at the very end of initialisation of a new terminal, just before
		521	trying to map (display) the toplevel and returning to the main loop.
		522
		523	=item on_destroy $term
		524
		525	Called whenever something tries to destroy terminal, when the terminal is
		526	still fully functional (not for long, though).
310		527
311	=item on_reset $term	528	=item on_reset $term
312		529
313	Called after the screen is "reset" for any reason, such as resizing or	530	Called after the screen is "reset" for any reason, such as resizing or
314	control sequences. Here is where you can react on changes to size-related	531	control sequences. Here is where you can react on changes to size-related
315	variables.	532	variables.
316		533
317	=item on_start $term	534	=item on_child_start $term, $pid
318		535
319	Called at the very end of initialisation of a new terminal, just before	536	Called just after the child process has been C<fork>ed.
320	returning to the mainloop.	537
		538	=item on_child_exit $term, $status
		539
		540	Called just after the child process has exited. C<$status> is the status
		541	from C<waitpid>.
321		542
322	=item on_sel_make $term, $eventtime	543	=item on_sel_make $term, $eventtime
323		544
324	Called whenever a selection has been made by the user, but before the	545	Called whenever a selection has been made by the user, but before the
325	selection text is copied, so changes to the beginning, end or type of the	546	selection text is copied, so changes to the beginning, end or type of the
…		…
332		553
333	Called whenever a selection has been copied, but before the selection is	554	Called whenever a selection has been copied, but before the selection is
334	requested from the server. The selection text can be queried and changed	555	requested from the server. The selection text can be queried and changed
335	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
336		557
337	Returning a true value aborts selection grabbing. It will still be hilighted.	558	Returning a true value aborts selection grabbing. It will still be highlighted.
338		559
339	=item on_sel_extend $term	560	=item on_sel_extend $term
340		561
341	Called whenever the user tries to extend the selection (e.g. with a double	562	Called whenever the user tries to extend the selection (e.g. with a double
342	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
343	should extend the selection itelf and return true to suppress the built-in	564	should extend the selection itself and return true to suppress the built-in
344	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
345	returns true, it will be called on every further click by the user and is	566	returns true, it will be called on every further click by the user and is
346	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
347		568
348	See the F<selection> example extension.	569	See the F<selection> example extension.
349		570
350	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
351		572
352	Called whenever the view offset changes, i..e the user or program	573	Called whenever the view offset changes, i.e. the user or program
353	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
354	show this many lines of scrollback.	575	show this many lines of scrollback.
355		576
356	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
357		578
…		…
361		582
362	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	583	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
363	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	584	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
364	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
365		586
366	=item on_osc_seq $term, $string	587	=item on_osc_seq $term, $op, $args, $resp
		588
		589	Called on every OSC sequence and can be used to suppress it or modify its
		590	behaviour. The default should be to return an empty list. A true value
		591	suppresses execution of the request completely. Make sure you don't get
		592	confused by recursive invocations when you output an OSC sequence within
		593	this callback.
		594
		595	C<on_osc_seq_perl> should be used for new behaviour.
		596
		597	=item on_osc_seq_perl $term, $args, $resp
367		598
368	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
369	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
370	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
371	string should start with the extension name and a colon, to distinguish	602	string should start with the extension name (sans -osc) and a semicolon,
372	it from commands for other extensions, and this might be enforced in the	603	to distinguish it from commands for other extensions, and this might be
373	future.	604	enforced in the future.
		605
		606	For example, C<overlay-osc> uses this:
		607
		608	sub on_osc_seq_perl {
		609	my ($self, $osc, $resp) = @_;
		610
		611	return unless $osc =~ s/^overlay;//;
		612
		613	... process remaining $osc string
		614	}
374		615
375	Be careful not ever to trust (in a security sense) the data you receive,	616	Be careful not ever to trust (in a security sense) the data you receive,
376	as its source can not easily be controleld (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
377	other users on the same system etc.).	618	other users on the same system etc.).
		619
		620	For responses, C<$resp> contains the end-of-args separator used by the
		621	sender.
378		622
379	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
380		624
381	Called whenever text is about to be output, with the text as argument. You	625	Called whenever text is about to be output, with the text as argument. You
382	can filter/change and output the text yourself by returning a true value	626	can filter/change and output the text yourself by returning a true value
…		…
387	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
388		632
389	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
390	suppress or filter tty input.	634	suppress or filter tty input.
391		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
392	=item on_line_update $term, $row	643	=item on_line_update $term, $row
393		644
394	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
395	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
396	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
403	later with the already-modified line (e.g. if unrelated parts change), so	654	later with the already-modified line (e.g. if unrelated parts change), so
404	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
405		656
406	=item on_refresh_begin $term	657	=item on_refresh_begin $term
407		658
408	Called just before the screen gets redrawn. Can be used for overlay	659	Called just before the screen gets redrawn. Can be used for overlay or
409	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
410	restoring them in refresh_end. The built-in overlay and selection display	661	restoring them in refresh_end. The built-in overlay and selection display
411	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
412		663
413	=item on_refresh_end $term	664	=item on_refresh_end $term
414		665
415	Called just after the screen gets redrawn. See C<on_refresh_begin>.	666	Called just after the screen gets redrawn. See C<on_refresh_begin>.
416		667
417	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
418		669
419	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
420	C<perl:string> action bound to it (see description of the B<keysym>	671	a C<perl:string> action bound to a key, see description of the B<keysym>
421	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
		673
		674	The event is simply the action string. This interface is assumed to change
		675	slightly in the future.
		676
		677	=item on_register_command $term, $keysym, $modifiermask, $string
		678
		679	Called after parsing a keysym resource but before registering the
		680	associated binding. If this hook returns TRUE the binding is not
		681	registered. It can be used to modify a binding by calling
		682	C<register_command>.
		683
		684	=item on_resize_all_windows $term, $new_width, $new_height
		685
		686	Called just after the new window size has been calculated, but before
		687	windows are actually being resized or hints are being set. If this hook
		688	returns TRUE, setting of the window hints is being skipped.
422		689
423	=item on_x_event $term, $event	690	=item on_x_event $term, $event
424		691
425	Called on every X event received on the vt window (and possibly other	692	Called on every X event received on the vt window (and possibly other
426	windows). Should only be used as a last resort. Most event structure	693	windows). Should only be used as a last resort. Most event structure
427	members are not passed.	694	members are not passed.
428		695
		696	=item on_root_event $term, $event
		697
		698	Like C<on_x_event>, but is called for events on the root window.
		699
429	=item on_focus_in $term	700	=item on_focus_in $term
430		701
431	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
432	does focus in processing.	703	does focus in processing.
433		704
434	=item on_focus_out $term	705	=item on_focus_out $term
435		706
436	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
437	focus out processing.	708	focus out processing.
438		709
		710	=item on_configure_notify $term, $event
		711
		712	=item on_property_notify $term, $event
		713
439	=item on_key_press $term, $event, $keysym, $octets	714	=item on_key_press $term, $event, $keysym, $octets
440		715
441	=item on_key_release $term, $event, $keysym	716	=item on_key_release $term, $event, $keysym
442		717
443	=item on_button_press $term, $event	718	=item on_button_press $term, $event
…		…
448		723
449	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
450		725
451	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
452		727
453	Called whenever the corresponding X event is received for the terminal If	728	Called whenever the corresponding X event is received for the terminal. If
454	the hook returns true, then the even will be ignored by rxvt-unicode.	729	the hook returns true, then the event will be ignored by rxvt-unicode.
455		730
456	The event is a hash with most values as named by Xlib (see the XEvent	731	The event is a hash with most values as named by Xlib (see the XEvent
457	manpage), with the additional members C<row> and C<col>, which are the row	732	manpage), with the additional members C<row> and C<col>, which are the
458	and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
459		734
460	C<on_key_press> additionally receives the string rxvt-unicode would	735	C<on_key_press> additionally receives the string rxvt-unicode would
461	output, if any, in locale-specific encoding.	736	output, if any, in locale-specific encoding.
462		737
463	subwindow.	738	subwindow.
		739
		740	=item on_client_message $term, $event
		741
		742	=item on_wm_protocols $term, $event
		743
		744	=item on_wm_delete_window $term, $event
		745
		746	Called when various types of ClientMessage events are received (all with
		747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
464		752
465	=back	753	=back
466		754
467	=cut	755	=cut
468		756
…		…
474	use Scalar::Util ();	762	use Scalar::Util ();
475	use List::Util ();	763	use List::Util ();
476		764
477	our $VERSION = 1;	765	our $VERSION = 1;
478	our $TERM;	766	our $TERM;
		767	our @TERM_INIT; # should go, prevents async I/O etc.
		768	our @TERM_EXT; # should go, prevents async I/O etc.
479	our @HOOKNAME;	769	our @HOOKNAME;
480	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
481	our %OPTION;	771	our %OPTION;
482		772
483	our $LIBDIR;	773	our $LIBDIR;
484	our $RESNAME;	774	our $RESNAME;
485	our $RESCLASS;	775	our $RESCLASS;
486	our $RXVTNAME;	776	our $RXVTNAME;
487		777
		778	our $NOCHAR = chr 0xffff;
		779
488	=head2 Variables in the C<urxvt> Package	780	=head2 Variables in the C<urxvt> Package
489		781
490	=over 4	782	=over 4
491		783
492	=item $urxvt::LIBDIR	784	=item $urxvt::LIBDIR
…		…
505	=item $urxvt::TERM	797	=item $urxvt::TERM
506		798
507	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
508	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
509		801
		802	=item @urxvt::TERM_INIT
		803
		804	All code references in this array will be called as methods of the next newly
		805	created C<urxvt::term> object (during the C<on_init> phase). The array
		806	gets cleared before the code references that were in it are being executed,
		807	so references can push themselves onto it again if they so desire.
		808
		809	This complements to the perl-eval command line option, but gets executed
		810	first.
		811
		812	=item @urxvt::TERM_EXT
		813
		814	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		815	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		816	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		817
510	=back	818	=back
511		819
512	=head2 Functions in the C<urxvt> Package	820	=head2 Functions in the C<urxvt> Package
513		821
514	=over 4	822	=over 4
515		823
516	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
517		825
518	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
519	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
520	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
521		830
522	=item urxvt::warn $string	831	=item urxvt::warn $string
523		832
524	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
525	newline. The module also overwrites the C<warn> builtin with a function	834	newline. The module also overwrites the C<warn> builtin with a function
526	that calls this function.	835	that calls this function.
527		836
528	Using this function has the advantage that its output ends up in the	837	Using this function has the advantage that its output ends up in the
529	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
530		839
531	Messages have a size limit of 1023 bytes currently.	840	Messages have a size limit of 1023 bytes currently.
		841
		842	=item @terms = urxvt::termlist
		843
		844	Returns all urxvt::term objects that exist in this process, regardless of
		845	whether they are started, being destroyed etc., so be careful. Only term
		846	objects that have perl extensions attached will be returned (because there
		847	is no urxvt::term object associated with others).
532		848
533	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
534		850
535	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
536		852
…		…
579		895
580	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
581		897
582	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
583		899
584	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
585		902
586	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
587	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
588	the bitset.	905	the bitset.
589		906
…		…
594	Return the foreground/background colour index, respectively.	911	Return the foreground/background colour index, respectively.
595		912
596	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
597		914
598	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	915	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		916
		917	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
599		918
600	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
601	specified one.	920	specified one.
602		921
603	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
…		…
620	my $msg = join "", @_;	939	my $msg = join "", @_;
621	$msg .= "\n"	940	$msg .= "\n"
622	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
623	urxvt::warn ($msg);	942	urxvt::warn ($msg);
624	};	943	};
		944	}
625		945
626	# %ENV is the original startup environment	946	no warnings 'utf8';
627	delete $ENV{IFS};	947
628	delete $ENV{CDPATH};	948	sub parse_resource {
629	delete $ENV{BASH_ENV};	949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
630	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	950
		951	$term->scan_meta;
		952
		953	my $r = $term->{meta}{resource};
		954	while (my ($pattern, $v) = each %$r) {
		955	$name =~ y/-/./ if $isarg;
		956
		957	if (
		958	$pattern =~ /\.$/
		959	? $pattern eq substr $name, 0, length $pattern
		960	: $pattern eq $name
		961	) {
		962	$name = "$urxvt::RESCLASS.$name";
		963
		964	push @TERM_EXT, $v->[0];
		965
		966	if ($v->[1] eq "boolean") {
		967	$term->put_option_db ($name, $flag ? "true" : "false");
		968	return 1;
		969	} else {
		970	$term->put_option_db ($name, $value);
		971	return 1 + 2;
		972	}
		973	}
		974	}
		975
		976	0
		977	}
		978
		979	sub usage {
		980	my ($term, $usage_type) = @_;
		981
		982	$term->scan_meta;
		983
		984	my $r = $term->{meta}{resource};
		985
		986	for my $pattern (sort keys %$r) {
		987	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		988
		989	$desc .= " (-pe $ext)";
		990
		991	if ($usage_type == 1) {
		992	$pattern =~ y/./-/;
		993	$pattern =~ s/-$/-.../g;
		994
		995	if ($type eq "boolean") {
		996	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		997	} else {
		998	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		999	}
		1000	} else {
		1001	$pattern =~ s/\.$/.*/g;
		1002	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1003	}
		1004	}
631	}	1005	}
632		1006
633	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1007	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
634		1008
635	sub verbose {	1009	sub verbose {
…		…
640	my %extension_pkg;	1014	my %extension_pkg;
641		1015
642	# load a single script into its own package, once only	1016	# load a single script into its own package, once only
643	sub extension_package($) {	1017	sub extension_package($) {
644	my ($path) = @_;	1018	my ($path) = @_;
645
646	no strict 'refs';
647		1019
648	$extension_pkg{$path} ||= do {	1020	$extension_pkg{$path} ||= do {
649	$path =~ /([^\/\\]+)$/;	1021	$path =~ /([^\/\\]+)$/;
650	my $pkg = $1;	1022	my $pkg = $1;
651	$pkg =~ s/[^[:word:]]/_/g;	1023	$pkg =~ s/[^[:word:]]/_/g;
…		…
654	verbose 3, "loading extension '$path' into package '$pkg'";	1026	verbose 3, "loading extension '$path' into package '$pkg'";
655		1027
656	open my $fh, "<:raw", $path	1028	open my $fh, "<:raw", $path
657	or die "$path: $!";	1029	or die "$path: $!";
658		1030
659	@{"$pkg\::ISA"} = urxvt::term::extension::;
660
661	my $source =	1031	my $source =
662	"package $pkg; use strict; use utf8;\n"	1032	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
663	. "#line 1 \"$path\"\n{\n"	1033	. "#line 1 \"$path\"\n{\n"
664	. (do { local $/; <$fh> })	1034	. (do { local $/; <$fh> })
665	. "\n};\n1";	1035	. "\n};\n1";
666		1036
667	eval $source	1037	eval $source
…		…
677	sub invoke {	1047	sub invoke {
678	local $TERM = shift;	1048	local $TERM = shift;
679	my $htype = shift;	1049	my $htype = shift;
680		1050
681	if ($htype == 0) { # INIT	1051	if ($htype == 0) { # INIT
682	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1052	my @dirs = $TERM->perl_libdirs;
683		1053
684	my %ext_arg;	1054	my %ext_arg;
685		1055
		1056	{
		1057	my @init = @TERM_INIT;
		1058	@TERM_INIT = ();
		1059	$_->($TERM) for @init;
		1060	my @pkg = @TERM_EXT;
		1061	@TERM_EXT = ();
		1062	$TERM->register_package ($_) for @pkg;
		1063	}
		1064
686	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1065	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
687	if ($_ eq "default") {	1066	if ($_ eq "default") {
688	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	1067	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
689	} elsif (/^-(.*)$/) {	1068	} elsif (/^-(.*)$/) {
690	delete $ext_arg{$1};	1069	delete $ext_arg{$1};
691	} elsif (/^([^<]+)<(.*)>$/) {	1070	} elsif (/^([^<]+)<(.*)>$/) {
692	push @{ $ext_arg{$1} }, $2;	1071	push @{ $ext_arg{$1} }, $2;
693	} else {	1072	} else {
694	$ext_arg{$_} ||= [];	1073	$ext_arg{$_} ||= [];
695	}	1074	}
696	}	1075	}
697		1076
698	while (my ($ext, $argv) = each %ext_arg) {	1077	for my $ext (sort keys %ext_arg) {
699	my @files = grep -f $_, map "$_/$ext", @dirs;	1078	my @files = grep -f $_, map "$_/$ext", @dirs;
700		1079
701	if (@files) {	1080	if (@files) {
702	$TERM->register_package (extension_package $files[0], $argv);	1081	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
703	} else {	1082	} else {
704	warn "perl extension '$ext' not found in perl library search path\n";	1083	warn "perl extension '$ext' not found in perl library search path\n";
705	}	1084	}
706	}	1085	}
707		1086
…		…
713		1092
714	if (my $cb = $TERM->{_hook}[$htype]) {	1093	if (my $cb = $TERM->{_hook}[$htype]) {
715	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1094	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
716	if $verbosity >= 10;	1095	if $verbosity >= 10;
717		1096
718	keys %$cb;	1097	for my $pkg (keys %$cb) {
719
720	while (my ($pkg, $cb) = each %$cb) {
721	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1098	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
722	and last;	1099	$retval ||= $retval_;
723		1100
724	if ($@) {	1101	if ($@) {
725	$TERM->ungrab; # better to lose the grab than the session	1102	$TERM->ungrab; # better to lose the grab than the session
726	warn $@;	1103	warn $@;
727	}	1104	}
…		…
740	}	1117	}
741		1118
742	$retval	1119	$retval
743	}	1120	}
744		1121
745	sub exec_async(@) {	1122	sub SET_COLOR($$$) {
746	my $pid = fork;	1123	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1124	}
747		1125
748	return	1126	sub rend2mask {
749	if !defined $pid or $pid;	1127	no strict 'refs';
750		1128	my ($str, $mask) = (@_, 0);
751	%ENV = %{ $TERM->env };	1129	my %color = ( fg => undef, bg => undef );
752		1130	my @failed;
753	exec @_;	1131	for my $spec ( split /\s+/, $str ) {
754	_exit 255;	1132	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1133	$color{lc($1)} = $2;
		1134	} else {
		1135	my $neg = $spec =~ s/^[-^]//;
		1136	unless ( exists &{"RS_$spec"} ) {
		1137	push @failed, $spec;
		1138	next;
		1139	}
		1140	my $cur = &{"RS_$spec"};
		1141	if ( $neg ) {
		1142	$mask &= ~$cur;
		1143	} else {
		1144	$mask |= $cur;
		1145	}
		1146	}
		1147	}
		1148	($mask, @color{qw(fg bg)}, \@failed)
755	}	1149	}
756		1150
757	# urxvt::term::extension	1151	# urxvt::term::extension
758		1152
759	package urxvt::term::extension;	1153	package urxvt::term::extension;
…		…
824	=head2 The C<urxvt::anyevent> Class	1218	=head2 The C<urxvt::anyevent> Class
825		1219
826	The sole purpose of this class is to deliver an interface to the	1220	The sole purpose of this class is to deliver an interface to the
827	C<AnyEvent> module - any module using it will work inside urxvt without	1221	C<AnyEvent> module - any module using it will work inside urxvt without
828	further programming. The only exception is that you cannot wait on	1222	further programming. The only exception is that you cannot wait on
829	condition variables, but non-blocking condvar use is ok. What this means	1223	condition variables, but non-blocking condvar use is ok.
830	is that you cannot use blocking APIs, but the non-blocking variant should	1224
831	work.	1225	In practical terms this means is that you cannot use blocking APIs, but
		1226	the non-blocking variant should work.
832		1227
833	=cut	1228	=cut
834		1229
835	our $VERSION = 1;	1230	our $VERSION = '5.23';
836		1231
837	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1232	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
838	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1233	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
839		1234
840	sub timer {	1235	sub timer {
…		…
842		1237
843	my $cb = $arg{cb};	1238	my $cb = $arg{cb};
844		1239
845	urxvt::timer	1240	urxvt::timer
846	->new	1241	->new
847	->start (urxvt::NOW + $arg{after})	1242	->after ($arg{after}, $arg{interval})
848	->cb (sub {	1243	->cb ($arg{interval} ? $cb : sub {
849	$_[0]->stop; # need to cancel manually	1244	$_[0]->stop; # need to cancel manually
850	$cb->();	1245	$cb->();
851	})	1246	})
852	}	1247	}
853		1248
854	sub io {	1249	sub io {
855	my ($class, %arg) = @_;	1250	my ($class, %arg) = @_;
856		1251
857	my $cb = $arg{cb};	1252	my $cb = $arg{cb};
		1253	my $fd = fileno $arg{fh};
		1254	defined $fd or $fd = $arg{fh};
858		1255
859	bless [$arg{fh}, urxvt::iow	1256	bless [$arg{fh}, urxvt::iow
860	->new	1257	->new
861	->fd (fileno $arg{fh})	1258	->fd ($fd)
862	->events (($arg{poll} =~ /r/ ? 1 : 0)	1259	->events (($arg{poll} =~ /r/ ? 1 : 0)
863	| ($arg{poll} =~ /w/ ? 2 : 0))	1260	| ($arg{poll} =~ /w/ ? 2 : 0))
864	->start	1261	->start
865	->cb (sub {	1262	->cb ($cb)
866	$cb->(($_[1] & 1 ? 'r' : '')
867	. ($_[1] & 2 ? 'w' : ''));
868	})],
869	urxvt::anyevent::	1263	], urxvt::anyevent::
		1264	}
		1265
		1266	sub idle {
		1267	my ($class, %arg) = @_;
		1268
		1269	my $cb = $arg{cb};
		1270
		1271	urxvt::iw
		1272	->new
		1273	->start
		1274	->cb ($cb)
		1275	}
		1276
		1277	sub child {
		1278	my ($class, %arg) = @_;
		1279
		1280	my $cb = $arg{cb};
		1281
		1282	urxvt::pw
		1283	->new
		1284	->start ($arg{pid})
		1285	->cb (sub {
		1286	$_[0]->stop; # need to cancel manually
		1287	$cb->($_[0]->rpid, $_[0]->rstatus);
		1288	})
870	}	1289	}
871		1290
872	sub DESTROY {	1291	sub DESTROY {
873	$_[0][1]->stop;	1292	$_[0][1]->stop;
874	}	1293	}
875		1294
876	sub condvar {	1295	# only needed for AnyEvent < 6 compatibility
877	bless \my $flag, urxvt::anyevent::condvar::	1296	sub one_event {
878	}
879
880	sub urxvt::anyevent::condvar::broadcast {
881	${$_[0]}++;
882	}
883
884	sub urxvt::anyevent::condvar::wait {
885	unless (${$_[0]}) {
886	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1297	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
887	}
888	}	1298	}
889		1299
890	package urxvt::term;	1300	package urxvt::term;
891		1301
892	=head2 The C<urxvt::term> Class	1302	=head2 The C<urxvt::term> Class
…		…
897		1307
898	# find on_xxx subs in the package and register them	1308	# find on_xxx subs in the package and register them
899	# as hooks	1309	# as hooks
900	sub register_package {	1310	sub register_package {
901	my ($self, $pkg, $argv) = @_;	1311	my ($self, $pkg, $argv) = @_;
		1312
		1313	no strict 'refs';
		1314
		1315	urxvt::verbose 6, "register package $pkg to $self";
		1316
		1317	@{"$pkg\::ISA"} = urxvt::term::extension::;
902		1318
903	my $proxy = bless {	1319	my $proxy = bless {
904	_pkg => $pkg,	1320	_pkg => $pkg,
905	argv => $argv,	1321	argv => $argv,
906	}, $pkg;	1322	}, $pkg;
…		…
913	$proxy->enable ($name => $ref);	1329	$proxy->enable ($name => $ref);
914	}	1330	}
915	}	1331	}
916	}	1332	}
917		1333
		1334	sub perl_libdirs {
		1335	map { split /:/ }
		1336	$_[0]->resource ("perl_lib"),
		1337	$ENV{URXVT_PERL_LIB},
		1338	"$ENV{HOME}/.urxvt/ext",
		1339	"$LIBDIR/perl"
		1340	}
		1341
		1342	sub scan_meta {
		1343	my ($self) = @_;
		1344	my @libdirs = perl_libdirs $self;
		1345
		1346	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1347
		1348	my %meta;
		1349
		1350	$self->{meta_libdirs} = join "\x00", @libdirs;
		1351	$self->{meta} = \%meta;
		1352
		1353	for my $dir (reverse @libdirs) {
		1354	opendir my $fh, $dir
		1355	or next;
		1356	for my $ext (readdir $fh) {
		1357	$ext ne "."
		1358	and $ext ne ".."
		1359	and open my $fh, "<", "$dir/$ext"
		1360	or next;
		1361
		1362	while (<$fh>) {
		1363	if (/^#:META:X_RESOURCE:(.*)/) {
		1364	my ($pattern, $type, $desc) = split /:/, $1;
		1365	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1366	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1367	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1368	} else {
		1369	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1370	}
		1371	} elsif (/^\s*(?:#|$)/) {
		1372	# skip other comments and empty lines
		1373	} else {
		1374	last; # stop parsing on first non-empty non-comment line
		1375	}
		1376	}
		1377	}
		1378	}
		1379	}
		1380
918	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1381	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
919		1382
920	Creates a new terminal, very similar as if you had started it with system	1383	Creates a new terminal, very similar as if you had started it with system
921	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1384	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
922	hash which defines the environment of the new terminal.	1385	hash which defines the environment of the new terminal.
923		1386
924	Croaks (and probably outputs an error message) if the new instance	1387	Croaks (and probably outputs an error message) if the new instance
925	couldn't be created. Returns C<undef> if the new instance didn't	1388	couldn't be created. Returns C<undef> if the new instance didn't
926	initialise perl, and the terminal object otherwise. The C<init> and	1389	initialise perl, and the terminal object otherwise. The C<init> and
927	C<start> hooks will be called during this call.	1390	C<start> hooks will be called before this call returns, and are free to
		1391	refer to global data (which is race free).
928		1392
929	=cut	1393	=cut
930		1394
931	sub new {	1395	sub new {
932	my ($class, $env, @args) = @_;	1396	my ($class, $env, @args) = @_;
933		1397
		1398	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1399	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1400
934	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1401	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
935	}	1402	}
936		1403
937	=item $term->destroy	1404	=item $term->destroy
938		1405
939	Destroy the terminal object (close the window, free resources	1406	Destroy the terminal object (close the window, free resources
940	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1407	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
941	watchers (timers, io watchers) are still active.	1408	watchers (timers, io watchers) are still active.
942		1409
		1410	=item $term->exec_async ($cmd[, @args])
		1411
		1412	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1413	("starts") programs in the background. This function takes care of setting
		1414	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1415	be preferred over explicit calls to C<exec> or C<system>.
		1416
		1417	Returns the pid of the subprocess or C<undef> on error.
		1418
		1419	=cut
		1420
		1421	sub exec_async {
		1422	my $self = shift;
		1423
		1424	my $pid = fork;
		1425
		1426	return $pid
		1427	if !defined $pid or $pid;
		1428
		1429	%ENV = %{ $self->env };
		1430
		1431	exec @_;
		1432	urxvt::_exit 255;
		1433	}
		1434
943	=item $isset = $term->option ($optval[, $set])	1435	=item $isset = $term->option ($optval[, $set])
944		1436
945	Returns true if the option specified by C<$optval> is enabled, and	1437	Returns true if the option specified by C<$optval> is enabled, and
946	optionally change it. All option values are stored by name in the hash	1438	optionally change it. All option values are stored by name in the hash
947	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1439	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
948		1440
949	Here is a a likely non-exhaustive list of option names, please see the	1441	Here is a likely non-exhaustive list of option names, please see the
950	source file F</src/optinc.h> to see the actual list:	1442	source file F</src/optinc.h> to see the actual list:
951		1443
952	borderLess console cursorBlink cursorUnderline hold iconic insecure	1444	borderLess buffered console cursorBlink cursorUnderline hold iconic
953	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1445	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1446	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
954	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1447	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
955	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1448	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
956	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1449	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
957	tripleclickwords utmpInhibit visualBell	1450	urgentOnBell utmpInhibit visualBell
958		1451
959	=item $value = $term->resource ($name[, $newval])	1452	=item $value = $term->resource ($name[, $newval])
960		1453
961	Returns the current resource value associated with a given name and	1454	Returns the current resource value associated with a given name and
962	optionally sets a new value. Setting values is most useful in the C<init>	1455	optionally sets a new value. Setting values is most useful in the C<init>
…		…
971	likely change).	1464	likely change).
972		1465
973	Please note that resource strings will currently only be freed when the	1466	Please note that resource strings will currently only be freed when the
974	terminal is destroyed, so changing options frequently will eat memory.	1467	terminal is destroyed, so changing options frequently will eat memory.
975		1468
976	Here is a a likely non-exhaustive list of resource names, not all of which	1469	Here is a likely non-exhaustive list of resource names, not all of which
977	are supported in every build, please see the source file F</src/rsinc.h>	1470	are supported in every build, please see the source file F</src/rsinc.h>
978	to see the actual list:	1471	to see the actual list:
979		1472
980	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1473	answerbackstring backgroundPixmap backspace_key blendtype blurradius
981	borderLess color cursorBlink cursorUnderline cutchars delete_key	1474	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
982	display_name embed ext_bwidth fade font geometry hold iconName	1475	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
983	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1476	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1477	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
984	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1478	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
985	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1479	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
986	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1480	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
987	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1481	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
988	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1482	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
989	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1483	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
990	shade term_name title transparent transparent_all tripleclickwords	1484	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1485	term_name title transient_for transparent tripleclickwords urgentOnBell
991	utmpInhibit visualBell	1486	utmpInhibit visualBell
992		1487
993	=cut	1488	=cut
994		1489
995	sub resource($$;$) {	1490	sub resource($$;$) {
996	my ($self, $name) = (shift, shift);	1491	my ($self, $name) = (shift, shift);
997	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1492	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
998	&urxvt::term::_resource	1493	goto &urxvt::term::_resource
999	}	1494	}
1000		1495
1001	=item $value = $term->x_resource ($pattern)	1496	=item $value = $term->x_resource ($pattern)
1002		1497
1003	Returns the X-Resource for the given pattern, excluding the program or	1498	Returns the X-Resource for the given pattern, excluding the program or
…		…
1007		1502
1008	This method should only be called during the C<on_start> hook, as there is	1503	This method should only be called during the C<on_start> hook, as there is
1009	only one resource database per display, and later invocations might return	1504	only one resource database per display, and later invocations might return
1010	the wrong resources.	1505	the wrong resources.
1011		1506
1012	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1507	=item $value = $term->x_resource_boolean ($pattern)
1013		1508
		1509	Like C<x_resource>, above, but interprets the string value as a boolean
		1510	and returns C<1> for true values, C<0> for false values and C<undef> if
		1511	the resource or option isn't specified.
		1512
		1513	You should always use this method to parse boolean resources.
		1514
		1515	=cut
		1516
		1517	sub x_resource_boolean {
		1518	my $res = &x_resource;
		1519
		1520	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1521	}
		1522
		1523	=item $success = $term->parse_keysym ($key, $octets)
		1524
1014	Adds a keymap translation exactly as specified via a resource. See the	1525	Adds a key binding exactly as specified via a resource. See the
1015	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1526	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1527
		1528	=item $term->register_command ($keysym, $modifiermask, $string)
		1529
		1530	Adds a key binding. This is a lower level api compared to
		1531	C<parse_keysym>, as it expects a parsed key description, and can be
		1532	used only inside either the C<on_init> hook, to add a binding, or the
		1533	C<on_register_command> hook, to modify a parsed binding.
1016		1534
1017	=item $rend = $term->rstyle ([$new_rstyle])	1535	=item $rend = $term->rstyle ([$new_rstyle])
1018		1536
1019	Return and optionally change the current rendition. Text that is output by	1537	Return and optionally change the current rendition. Text that is output by
1020	the terminal application will use this style.	1538	the terminal application will use this style.
…		…
1028		1546
1029	=item ($row, $col) = $term->selection_beg ([$row, $col])	1547	=item ($row, $col) = $term->selection_beg ([$row, $col])
1030		1548
1031	=item ($row, $col) = $term->selection_end ([$row, $col])	1549	=item ($row, $col) = $term->selection_end ([$row, $col])
1032		1550
1033	Return the current values of the selection mark, begin or end positions,	1551	Return the current values of the selection mark, begin or end positions.
1034	and optionally set them to new values.	1552
		1553	When arguments are given, then the selection coordinates are set to
		1554	C<$row> and C<$col>, and the selection screen is set to the current
		1555	screen.
		1556
		1557	=item $screen = $term->selection_screen ([$screen])
		1558
		1559	Returns the current selection screen, and then optionally sets it.
1035		1560
1036	=item $term->selection_make ($eventtime[, $rectangular])	1561	=item $term->selection_make ($eventtime[, $rectangular])
1037		1562
1038	Tries to make a selection as set by C<selection_beg> and	1563	Tries to make a selection as set by C<selection_beg> and
1039	C<selection_end>. If C<$rectangular> is true (default: false), a	1564	C<selection_end>. If C<$rectangular> is true (default: false), a
1040	rectangular selection will be made. This is the prefered function to make	1565	rectangular selection will be made. This is the preferred function to make
1041	a selection.	1566	a selection.
1042		1567
1043	=item $success = $term->selection_grab ($eventtime)	1568	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1044		1569
1045	Try to request the primary selection text from the server (for example, as	1570	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1571	true) selection from the server. The corresponding text can be set
1046	set by the next method). No visual feedback will be given. This function	1572	with the next method. No visual feedback will be given. This function
1047	is mostly useful from within C<on_sel_grab> hooks.	1573	is mostly useful from within C<on_sel_grab> hooks.
1048		1574
1049	=item $oldtext = $term->selection ([$newtext])	1575	=item $oldtext = $term->selection ([$newtext, $clipboard])
1050		1576
1051	Return the current selection text and optionally replace it by C<$newtext>.	1577	Return the current selection (clipboard if C<$clipboard> is true) text
		1578	and optionally replace it by C<$newtext>.
		1579
		1580	=item $term->selection_clear ([$clipboard])
		1581
		1582	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1052		1583
1053	=item $term->overlay_simple ($x, $y, $text)	1584	=item $term->overlay_simple ($x, $y, $text)
1054		1585
1055	Create a simple multi-line overlay box. See the next method for details.	1586	Create a simple multi-line overlay box. See the next method for details.
1056		1587
…		…
1086		1617
1087	The methods currently supported on C<urxvt::overlay> objects are:	1618	The methods currently supported on C<urxvt::overlay> objects are:
1088		1619
1089	=over 4	1620	=over 4
1090		1621
1091	=item $overlay->set ($x, $y, $text, $rend)	1622	=item $overlay->set ($x, $y, $text[, $rend])
1092		1623
1093	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1624	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1094	text in rxvt-unicode's special encoding and an array of rendition values	1625	text in rxvt-unicode's special encoding and an array of rendition values
1095	at a specific position inside the overlay.	1626	at a specific position inside the overlay.
		1627
		1628	If C<$rend> is missing, then the rendition will not be changed.
1096		1629
1097	=item $overlay->hide	1630	=item $overlay->hide
1098		1631
1099	If visible, hide the overlay, but do not destroy it.	1632	If visible, hide the overlay, but do not destroy it.
1100		1633
…		…
1170		1703
1171	Normally its not a good idea to use this function, as programs might be	1704	Normally its not a good idea to use this function, as programs might be
1172	confused by changes in cursor position or scrolling. Its useful inside a	1705	confused by changes in cursor position or scrolling. Its useful inside a
1173	C<on_add_lines> hook, though.	1706	C<on_add_lines> hook, though.
1174		1707
		1708	=item $term->scr_change_screen ($screen)
		1709
		1710	Switch to given screen - 0 primary, 1 secondary.
		1711
1175	=item $term->cmd_parse ($octets)	1712	=item $term->cmd_parse ($octets)
1176		1713
1177	Similar to C<scr_add_lines>, but the argument must be in the	1714	Similar to C<scr_add_lines>, but the argument must be in the
1178	locale-specific encoding of the terminal and can contain command sequences	1715	locale-specific encoding of the terminal and can contain command sequences
1179	(escape codes) that will be interpreted.	1716	(escape codes) that will be interpreted.
1180		1717
1181	=item $term->tt_write ($octets)	1718	=item $term->tt_write ($octets)
1182		1719
1183	Write the octets given in C<$data> to the tty (i.e. as program input). To	1720	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1184	pass characters instead of octets, you should convert your strings first	1721	pass characters instead of octets, you should convert your strings first
1185	to the locale-specific encoding using C<< $term->locale_encode >>.	1722	to the locale-specific encoding using C<< $term->locale_encode >>.
		1723
		1724	=item $term->tt_paste ($octets)
		1725
		1726	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1727	CR and bracketing the data with control sequences if bracketed paste mode
		1728	is set.
1186		1729
1187	=item $old_events = $term->pty_ev_events ([$new_events])	1730	=item $old_events = $term->pty_ev_events ([$new_events])
1188		1731
1189	Replaces the event mask of the pty watcher by the given event mask. Can	1732	Replaces the event mask of the pty watcher by the given event mask. Can
1190	be used to suppress input and output handling to the pty/tty. See the	1733	be used to suppress input and output handling to the pty/tty. See the
1191	description of C<< urxvt::timer->events >>. Make sure to always restore	1734	description of C<< urxvt::timer->events >>. Make sure to always restore
1192	the previous value.	1735	the previous value.
1193		1736
		1737	=item $fd = $term->pty_fd
		1738
		1739	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1740	is used.
		1741
1194	=item $windowid = $term->parent	1742	=item $windowid = $term->parent
1195		1743
1196	Return the window id of the toplevel window.	1744	Return the window id of the toplevel window.
1197		1745
1198	=item $windowid = $term->vt	1746	=item $windowid = $term->vt
…		…
1204	Adds the specified events to the vt event mask. Useful e.g. when you want	1752	Adds the specified events to the vt event mask. Useful e.g. when you want
1205	to receive pointer events all the times:	1753	to receive pointer events all the times:
1206		1754
1207	$term->vt_emask_add (urxvt::PointerMotionMask);	1755	$term->vt_emask_add (urxvt::PointerMotionMask);
1208		1756
		1757	=item $term->set_urgency ($set)
		1758
		1759	Enable/disable the urgency hint on the toplevel window.
		1760
		1761	=item $term->focus_in
		1762
		1763	=item $term->focus_out
		1764
		1765	=item $term->key_press ($state, $keycode[, $time])
		1766
		1767	=item $term->key_release ($state, $keycode[, $time])
		1768
		1769	Deliver various fake events to to terminal.
		1770
1209	=item $window_width = $term->width	1771	=item $window_width = $term->width
1210		1772
1211	=item $window_height = $term->height	1773	=item $window_height = $term->height
1212		1774
1213	=item $font_width = $term->fwidth	1775	=item $font_width = $term->fwidth
…		…
1243	=item $env = $term->env	1805	=item $env = $term->env
1244		1806
1245	Returns a copy of the environment in effect for the terminal as a hashref	1807	Returns a copy of the environment in effect for the terminal as a hashref
1246	similar to C<\%ENV>.	1808	similar to C<\%ENV>.
1247		1809
		1810	=item @envv = $term->envv
		1811
		1812	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1813
		1814	=item @argv = $term->argv
		1815
		1816	Return the argument vector as this terminal, similar to @ARGV, but
		1817	includes the program name as first element.
		1818
1248	=cut	1819	=cut
1249		1820
1250	sub env {	1821	sub env {
1251	if (my $env = $_[0]->_env) {
1252	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1822	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1253	} else {
1254	+{ %ENV }
1255	}
1256	}	1823	}
1257		1824
1258	=item $modifiermask = $term->ModLevel3Mask	1825	=item $modifiermask = $term->ModLevel3Mask
1259		1826
1260	=item $modifiermask = $term->ModMetaMask	1827	=item $modifiermask = $term->ModMetaMask
1261		1828
1262	=item $modifiermask = $term->ModNumLockMask	1829	=item $modifiermask = $term->ModNumLockMask
1263		1830
1264	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1831	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1265	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1832	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1833
		1834	=item $screen = $term->current_screen
		1835
		1836	Returns the currently displayed screen (0 primary, 1 secondary).
		1837
		1838	=item $cursor_is_hidden = $term->hidden_cursor
		1839
		1840	Returns whether the cursor is currently hidden or not.
1266		1841
1267	=item $view_start = $term->view_start ([$newvalue])	1842	=item $view_start = $term->view_start ([$newvalue])
1268		1843
1269	Returns the row number of the topmost displayed line. Maximum value is	1844	Returns the row number of the topmost displayed line. Maximum value is
1270	C<0>, which displays the normal terminal contents. Lower values scroll	1845	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1278		1853
1279	Used after changing terminal contents to display them.	1854	Used after changing terminal contents to display them.
1280		1855
1281	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1856	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1282		1857
1283	Returns the text of the entire row with number C<$row_number>. Row C<0>	1858	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1284	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1859	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1285	terminal line. The scrollback buffer starts at line C<-1> and extends to
1286	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1860	terminal line. Nothing will be returned if a nonexistent line
1287	is requested.	1861	is requested.
1288		1862
1289	If C<$new_text> is specified, it will replace characters in the current	1863	If C<$new_text> is specified, it will replace characters in the current
1290	line, starting at column C<$start_col> (default C<0>), which is useful	1864	line, starting at column C<$start_col> (default C<0>), which is useful
1291	to replace only parts of a line. The font index in the rendition will	1865	to replace only parts of a line. The font index in the rendition will
1292	automatically be updated.	1866	automatically be updated.
1293		1867
1294	C<$text> is in a special encoding: tabs and wide characters that use more	1868	C<$text> is in a special encoding: tabs and wide characters that use more
1295	than one cell when displayed are padded with urxvt::NOCHAR characters	1869	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1296	(C<chr 65535>). Characters with combining characters and other characters	1870	characters. Characters with combining characters and other characters that
1297	that do not fit into the normal tetx encoding will be replaced with	1871	do not fit into the normal text encoding will be replaced with characters
1298	characters in the private use area.	1872	in the private use area.
1299		1873
1300	You have to obey this encoding when changing text. The advantage is	1874	You have to obey this encoding when changing text. The advantage is
1301	that C<substr> and similar functions work on screen cells and not on	1875	that C<substr> and similar functions work on screen cells and not on
1302	characters.	1876	characters.
1303		1877
…		…
1447	where one character corresponds to one screen cell. See	2021	where one character corresponds to one screen cell. See
1448	C<< $term->ROW_t >> for details.	2022	C<< $term->ROW_t >> for details.
1449		2023
1450	=item $string = $term->special_decode $text	2024	=item $string = $term->special_decode $text
1451		2025
1452	Converts rxvt-unicodes text reprsentation into a perl string. See	2026	Converts rxvt-unicodes text representation into a perl string. See
1453	C<< $term->ROW_t >> for details.	2027	C<< $term->ROW_t >> for details.
1454		2028
1455	=item $success = $term->grab_button ($button, $modifiermask)	2029	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1456		2030
		2031	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2032
1457	Registers a synchronous button grab. See the XGrabButton manpage.	2033	Register/unregister a synchronous button grab. See the XGrabButton
		2034	manpage.
1458		2035
1459	=item $success = $term->grab ($eventtime[, $sync])	2036	=item $success = $term->grab ($eventtime[, $sync])
1460		2037
1461	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2038	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1462	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2039	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1463		2040
1464	=item $term->allow_events_async	2041	=item $term->allow_events_async
1465		2042
1466	Calls XAllowEvents with AsyncBoth for the most recent grab.	2043	Calls XAllowEvents with AsyncBoth for the most recent grab.
1467		2044
…		…
1474	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2051	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1475	recent grab.	2052	recent grab.
1476		2053
1477	=item $term->ungrab	2054	=item $term->ungrab
1478		2055
1479	Calls XUngrab for the most recent grab. Is called automatically on	2056	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1480	evaluation errors, as it is better to lose the grab in the error case as	2057	evaluation errors, as it is better to lose the grab in the error case as
1481	the session.	2058	the session.
		2059
		2060	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		2061
		2062	=item $atom_name = $term->XGetAtomName ($atom)
		2063
		2064	=item @atoms = $term->XListProperties ($window)
		2065
		2066	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		2067
		2068	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		2069
		2070	=item $term->XDeleteProperty ($window, $property)
		2071
		2072	=item $window = $term->DefaultRootWindow
		2073
		2074	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		2075
		2076	=item $term->XMapWindow ($window)
		2077
		2078	=item $term->XUnmapWindow ($window)
		2079
		2080	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		2081
		2082	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		2083
		2084	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2085
		2086	=item $keysym = $term->XStringToKeysym ($string)
		2087
		2088	=item $string = $term->XKeysymToString ($keysym)
		2089
		2090	Various X or X-related functions. The C<$term> object only serves as
		2091	the source of the display, otherwise those functions map more-or-less
		2092	directly onto the X functions of the same name.
1482		2093
1483	=back	2094	=back
1484		2095
1485	=cut	2096	=cut
1486		2097
…		…
1550	my ($self, $text, $cb) = @_;	2161	my ($self, $text, $cb) = @_;
1551		2162
1552	$self->add_item ({ type => "button", text => $text, activate => $cb});	2163	$self->add_item ({ type => "button", text => $text, activate => $cb});
1553	}	2164	}
1554		2165
1555	=item $popup->add_toggle ($text, $cb, $initial_value)	2166	=item $popup->add_toggle ($text, $initial_value, $cb)
1556		2167
1557	Adds a toggle/checkbox item to the popup. Teh callback gets called	2168	Adds a toggle/checkbox item to the popup. The callback gets called
1558	whenever it gets toggled, with a boolean indicating its value as its first	2169	whenever it gets toggled, with a boolean indicating its new value as its
1559	argument.	2170	first argument.
1560		2171
1561	=cut	2172	=cut
1562		2173
1563	sub add_toggle {	2174	sub add_toggle {
1564	my ($self, $text, $cb, $value) = @_;	2175	my ($self, $text, $value, $cb) = @_;
1565		2176
1566	my $item; $item = {	2177	my $item; $item = {
1567	type => "button",	2178	type => "button",
1568	text => " $text",	2179	text => " $text",
1569	value => $value,	2180	value => $value,
…		…
1588	my $env = $self->{term}->env;	2199	my $env = $self->{term}->env;
1589	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2200	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1590	delete $env->{LC_ALL};	2201	delete $env->{LC_ALL};
1591	$env->{LC_CTYPE} = $self->{term}->locale;	2202	$env->{LC_CTYPE} = $self->{term}->locale;
1592		2203
1593	urxvt::term->new ($env, $self->{term}->resource ("name"),	2204	my $term = urxvt::term->new (
1594	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2205	$env, "popup",
		2206	"--perl-lib" => "", "--perl-ext-common" => "",
		2207	"-pty-fd" => -1, "-sl" => 0,
		2208	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1595	"--transient-for" => $self->{term}->parent,	2209	"--transient-for" => $self->{term}->parent,
1596	"-display" => $self->{term}->display_id,	2210	"-display" => $self->{term}->display_id,
1597	"-pe" => "urxvt-popup")	2211	"-pe" => "urxvt-popup",
1598	or die "unable to create popup window\n";	2212	) or die "unable to create popup window\n";
		2213
		2214	unless (delete $term->{urxvt_popup_init_done}) {
		2215	$term->ungrab;
		2216	$term->destroy;
		2217	die "unable to initialise popup window\n";
		2218	}
1599	}	2219	}
1600		2220
1601	sub DESTROY {	2221	sub DESTROY {
1602	my ($self) = @_;	2222	my ($self) = @_;
1603		2223
1604	delete $self->{term}{_destroy}{$self};	2224	delete $self->{term}{_destroy}{$self};
1605	$self->{term}->ungrab;	2225	$self->{term}->ungrab;
1606	}	2226	}
1607		2227
1608	=back	2228	=back
		2229
		2230	=cut
		2231
		2232	package urxvt::watcher;
1609		2233
1610	=head2 The C<urxvt::timer> Class	2234	=head2 The C<urxvt::timer> Class
1611		2235
1612	This class implements timer watchers/events. Time is represented as a	2236	This class implements timer watchers/events. Time is represented as a
1613	fractional number of seconds since the epoch. Example:	2237	fractional number of seconds since the epoch. Example:
…		…
1617	->new	2241	->new
1618	->interval (1)	2242	->interval (1)
1619	->cb (sub {	2243	->cb (sub {
1620	$term->{overlay}->set (0, 0,	2244	$term->{overlay}->set (0, 0,
1621	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2245	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1622	});	2246	});
1623		2247
1624	=over 4	2248	=over 4
1625		2249
1626	=item $timer = new urxvt::timer	2250	=item $timer = new urxvt::timer
1627		2251
…		…
1630		2254
1631	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2255	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1632		2256
1633	Set the callback to be called when the timer triggers.	2257	Set the callback to be called when the timer triggers.
1634		2258
1635	=item $tstamp = $timer->at
1636
1637	Return the time this watcher will fire next.
1638
1639	=item $timer = $timer->set ($tstamp)	2259	=item $timer = $timer->set ($tstamp[, $interval])
1640		2260
1641	Set the time the event is generated to $tstamp.	2261	Set the time the event is generated to $tstamp (and optionally specifies a
		2262	new $interval).
1642		2263
1643	=item $timer = $timer->interval ($interval)	2264	=item $timer = $timer->interval ($interval)
1644		2265
1645	Normally (and when C<$interval> is C<0>), the timer will automatically	2266	By default (and when C<$interval> is C<0>), the timer will automatically
1646	stop after it has fired once. If C<$interval> is non-zero, then the timer	2267	stop after it has fired once. If C<$interval> is non-zero, then the timer
1647	is automatically rescheduled at the given intervals.	2268	is automatically rescheduled at the given intervals.
1648		2269
1649	=item $timer = $timer->start	2270	=item $timer = $timer->start
1650		2271
1651	Start the timer.	2272	Start the timer.
1652		2273
1653	=item $timer = $timer->start ($tstamp)	2274	=item $timer = $timer->start ($tstamp[, $interval])
1654		2275
1655	Set the event trigger time to C<$tstamp> and start the timer.	2276	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2277	also replaces the interval.
		2278
		2279	=item $timer = $timer->after ($delay[, $interval])
		2280
		2281	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1656		2282
1657	=item $timer = $timer->stop	2283	=item $timer = $timer->stop
1658		2284
1659	Stop the timer.	2285	Stop the timer.
1660		2286
…		…
1666		2292
1667	$term->{socket} = ...	2293	$term->{socket} = ...
1668	$term->{iow} = urxvt::iow	2294	$term->{iow} = urxvt::iow
1669	->new	2295	->new
1670	->fd (fileno $term->{socket})	2296	->fd (fileno $term->{socket})
1671	->events (urxvt::EVENT_READ)	2297	->events (urxvt::EV_READ)
1672	->start	2298	->start
1673	->cb (sub {	2299	->cb (sub {
1674	my ($iow, $revents) = @_;	2300	my ($iow, $revents) = @_;
1675	# $revents must be 1 here, no need to check	2301	# $revents must be 1 here, no need to check
1676	sysread $term->{socket}, my $buf, 8192	2302	sysread $term->{socket}, my $buf, 8192
…		…
1689	Set the callback to be called when io events are triggered. C<$reventmask>	2315	Set the callback to be called when io events are triggered. C<$reventmask>
1690	is a bitset as described in the C<events> method.	2316	is a bitset as described in the C<events> method.
1691		2317
1692	=item $iow = $iow->fd ($fd)	2318	=item $iow = $iow->fd ($fd)
1693		2319
1694	Set the filedescriptor (not handle) to watch.	2320	Set the file descriptor (not handle) to watch.
1695		2321
1696	=item $iow = $iow->events ($eventmask)	2322	=item $iow = $iow->events ($eventmask)
1697		2323
1698	Set the event mask to watch. The only allowed values are	2324	Set the event mask to watch. The only allowed values are
1699	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2325	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1700	together, or C<urxvt::EVENT_NONE>.	2326	together, or C<urxvt::EV_NONE>.
1701		2327
1702	=item $iow = $iow->start	2328	=item $iow = $iow->start
1703		2329
1704	Start watching for requested events on the given handle.	2330	Start watching for requested events on the given handle.
1705		2331
1706	=item $iow = $iow->stop	2332	=item $iow = $iow->stop
1707		2333
1708	Stop watching for events on the given filehandle.	2334	Stop watching for events on the given file handle.
		2335
		2336	=back
		2337
		2338	=head2 The C<urxvt::iw> Class
		2339
		2340	This class implements idle watchers, that get called automatically when
		2341	the process is idle. They should return as fast as possible, after doing
		2342	some useful work.
		2343
		2344	=over 4
		2345
		2346	=item $iw = new urxvt::iw
		2347
		2348	Create a new idle watcher object in stopped state.
		2349
		2350	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2351
		2352	Set the callback to be called when the watcher triggers.
		2353
		2354	=item $timer = $timer->start
		2355
		2356	Start the watcher.
		2357
		2358	=item $timer = $timer->stop
		2359
		2360	Stop the watcher.
		2361
		2362	=back
		2363
		2364	=head2 The C<urxvt::pw> Class
		2365
		2366	This class implements process watchers. They create an event whenever a
		2367	process exits, after which they stop automatically.
		2368
		2369	my $pid = fork;
		2370	...
		2371	$term->{pw} = urxvt::pw
		2372	->new
		2373	->start ($pid)
		2374	->cb (sub {
		2375	my ($pw, $exit_status) = @_;
		2376	...
		2377	});
		2378
		2379	=over 4
		2380
		2381	=item $pw = new urxvt::pw
		2382
		2383	Create a new process watcher in stopped state.
		2384
		2385	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2386
		2387	Set the callback to be called when the timer triggers.
		2388
		2389	=item $pw = $timer->start ($pid)
		2390
		2391	Tells the watcher to start watching for process C<$pid>.
		2392
		2393	=item $pw = $pw->stop
		2394
		2395	Stop the watcher.
1709		2396
1710	=back	2397	=back
1711		2398
1712	=head1 ENVIRONMENT	2399	=head1 ENVIRONMENT
1713		2400
…		…
1722		2409
1723	=item >= 3 - script loading and management	2410	=item >= 3 - script loading and management
1724		2411
1725	=item >=10 - all called hooks	2412	=item >=10 - all called hooks
1726		2413
1727	=item >=11 - hook reutrn values	2414	=item >=11 - hook return values
1728		2415
1729	=back	2416	=back
1730		2417
1731	=head1 AUTHOR	2418	=head1 AUTHOR
1732		2419
1733	Marc Lehmann <pcg@goof.com>	2420	Marc Lehmann <schmorp@schmorp.de>
1734	http://software.schmorp.de/pkg/rxvt-unicode	2421	http://software.schmorp.de/pkg/rxvt-unicode
1735		2422
1736	=cut	2423	=cut
1737		2424
1738	1	2425	1
		2426
		2427	# vim: sw=3:

Diff Legend

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