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.108 by root, Thu Jan 19 09:47:15 2006 UTC vs.
Revision 1.216 by root, Sun Jun 10 13:32:55 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 "vars"' 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.
…		…
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.
168		258
169	=item automove-background	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.
170		263
171	This is basically a one-line extension that dynamically changes the background pixmap offset	264	It is possible to activate the most recently seen match or a list of matches
172	to the window position, in effect creating the same effect as pseudo transparency with	265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
173	a custom pixmap. No scaling is supported in this mode. Exmaple:	266	"perl:matcher:list" as seen in the example below.
174		267
175	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	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.
176		315
177	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
178		317
179	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
180	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
181	similar-looking ascii character.	320	similar-looking ascii character.
182		321
183	=item digital-clock	322	=item digital-clock
184		323
185	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.
186		393
187	=item example-refresh-hooks	394	=item example-refresh-hooks
188		395
189	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
190	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
191	overlays or changes.	398	overlays or changes.
192		399
193	=item selection-pastebin	400	=item confirm-paste
194		401
195	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
196	textfile to a remote site (or does other things). (The implementation is	403	line is detected.
197	not currently secure for use in a multiuser environment as it writes to
198	F</tmp> directly.).
199		404
200	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	405	=item bell-command
201	i.e.
202		406
203	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:
204		410
205	Pressing this combination runs a command with C<%> replaced by the name of	411	URxvt.bell-command: notify-send "Beep, Beep"
206	the textfile. This command can be set via a resource:
207
208	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
209
210	And the default is likely not useful to anybody but the few people around
211	here :)
212
213	The name of the textfile is the hex encoded md5 sum of the selection, so
214	the same content should lead to the same filename.
215
216	After a successful upload the selection will be replaced by the text given
217	in the C<selection-pastebin-url> resource (again, the % is the placeholder
218	for the filename):
219
220	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
221		412
222	=back	413	=back
223		414
224	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
225		416
…		…
241		432
242	=over 4	433	=over 4
243		434
244	=item $text	435	=item $text
245		436
246	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
247	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.
248		439
249	=item $string	440	=item $string
250		441
251	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
…		…
255	=item $octets	446	=item $octets
256		447
257	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
258	locale-specific way.	449	locale-specific way.
259		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
260	=back	457	=back
261		458
262	=head2 Extension Objects	459	=head2 Extension Objects
263		460
264	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
265	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,
266	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
267	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
268	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
269	use.	467	internal use.
270		468
271	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
272	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
273		471
274	It has the following methods and data members:	472	It has the following methods and data members:
…		…
295	=head2 Hooks	493	=head2 Hooks
296		494
297	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
298	called whenever the relevant event happens.	496	called whenever the relevant event happens.
299		497
300	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
301	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
302		500
303	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
304	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
305	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.
306		504
307	I<< When in doubt, return a false value (preferably C<()>). >>	505	I<< When in doubt, return a false value (preferably C<()>). >>
308		506
309	=over 4	507	=over 4
310		508
311	=item on_init $term	509	=item on_init $term
312		510
313	Called after a new terminal object has been initialized, but before	511	Called after a new terminal object has been initialized, but before
314	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
315	call or deliver senseless data, as terminal size and other characteristics	513	call or deliver senseless data, as terminal size and other characteristics
316	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
317	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).
318		527
319	=item on_reset $term	528	=item on_reset $term
320		529
321	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
322	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
323	variables.	532	variables.
324		533
325	=item on_start $term
326
327	Called at the very end of initialisation of a new terminal, just before
328	returning to the mainloop.
329
330	=item on_child_start $term, $pid	534	=item on_child_start $term, $pid
331		535
332	Called just after the child process has been C<fork>ed.	536	Called just after the child process has been C<fork>ed.
333		537
334	=item on_child_exit $term, $status	538	=item on_child_exit $term, $status
…		…
349		553
350	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
351	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
352	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
353		557
354	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.
355		559
356	=item on_sel_extend $term	560	=item on_sel_extend $term
357		561
358	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
359	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
360	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
361	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
362	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
363	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
364		568
365	See the F<selection> example extension.	569	See the F<selection> example extension.
366		570
367	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
368		572
369	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
370	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
371	show this many lines of scrollback.	575	show this many lines of scrollback.
372		576
373	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
374		578
…		…
378		582
379	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,
380	$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
381	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
382		586
383	=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
384		598
385	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
386	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
387	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
388	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,
389	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
390	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	}
391		615
392	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,
393	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
394	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.
395		622
396	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
397		624
398	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
399	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
…		…
404	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
405		632
406	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
407	suppress or filter tty input.	634	suppress or filter tty input.
408		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
409	=item on_line_update $term, $row	643	=item on_line_update $term, $row
410		644
411	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
412	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
413	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,
…		…
420	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
421	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
422		656
423	=item on_refresh_begin $term	657	=item on_refresh_begin $term
424		658
425	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
426	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
427	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
428	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
429		663
430	=item on_refresh_end $term	664	=item on_refresh_end $term
431		665
432	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>.
433		667
434	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
435		669
436	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
437	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>
438	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.
439		689
440	=item on_x_event $term, $event	690	=item on_x_event $term, $event
441		691
442	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
443	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
444	members are not passed.	694	members are not passed.
445		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
446	=item on_focus_in $term	700	=item on_focus_in $term
447		701
448	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
449	does focus in processing.	703	does focus in processing.
450		704
451	=item on_focus_out $term	705	=item on_focus_out $term
452		706
453	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
454	focus out processing.	708	focus out processing.
455		709
456	=item on_configure_notify $term, $event	710	=item on_configure_notify $term, $event
457		711
		712	=item on_property_notify $term, $event
		713
458	=item on_key_press $term, $event, $keysym, $octets	714	=item on_key_press $term, $event, $keysym, $octets
459		715
460	=item on_key_release $term, $event, $keysym	716	=item on_key_release $term, $event, $keysym
461		717
462	=item on_button_press $term, $event	718	=item on_button_press $term, $event
…		…
467		723
468	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
469		725
470	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
471		727
472	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
473	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.
474		730
475	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
476	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
477	and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
478		734
479	C<on_key_press> additionally receives the string rxvt-unicode would	735	C<on_key_press> additionally receives the string rxvt-unicode would
480	output, if any, in locale-specific encoding.	736	output, if any, in locale-specific encoding.
481		737
482	subwindow.	738	subwindow.
483		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.
		752
484	=back	753	=back
485		754
486	=cut	755	=cut
487		756
488	package urxvt;	757	package urxvt;
489		758
490	use utf8;	759	use utf8;
491	use strict;	760	use strict 'vars';
492	use Carp ();	761	use Carp ();
493	use Scalar::Util ();	762	use Scalar::Util ();
494	use List::Util ();	763	use List::Util ();
495		764
496	our $VERSION = 1;	765	our $VERSION = 1;
497	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.
498	our @HOOKNAME;	769	our @HOOKNAME;
499	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
500	our %OPTION;	771	our %OPTION;
501		772
502	our $LIBDIR;	773	our $LIBDIR;
503	our $RESNAME;	774	our $RESNAME;
504	our $RESCLASS;	775	our $RESCLASS;
505	our $RXVTNAME;	776	our $RXVTNAME;
506		777
		778	our $NOCHAR = chr 0xffff;
		779
507	=head2 Variables in the C<urxvt> Package	780	=head2 Variables in the C<urxvt> Package
508		781
509	=over 4	782	=over 4
510		783
511	=item $urxvt::LIBDIR	784	=item $urxvt::LIBDIR
…		…
524	=item $urxvt::TERM	797	=item $urxvt::TERM
525		798
526	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
527	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
528		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
529	=back	818	=back
530		819
531	=head2 Functions in the C<urxvt> Package	820	=head2 Functions in the C<urxvt> Package
532		821
533	=over 4	822	=over 4
534		823
535	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
536		825
537	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
538	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
539	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
540		830
541	=item urxvt::warn $string	831	=item urxvt::warn $string
542		832
543	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
544	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
545	that calls this function.	835	that calls this function.
546		836
547	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
548	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
549		839
550	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).
551		848
552	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
553		850
554	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
555		852
…		…
598		895
599	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
600		897
601	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
602		899
603	=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
604		902
605	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
606	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
607	the bitset.	905	the bitset.
608		906
…		…
613	Return the foreground/background colour index, respectively.	911	Return the foreground/background colour index, respectively.
614		912
615	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
616		914
617	=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
618		918
619	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
620	specified one.	920	specified one.
621		921
622	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
…		…
641	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
642	urxvt::warn ($msg);	942	urxvt::warn ($msg);
643	};	943	};
644	}	944	}
645		945
		946	no warnings 'utf8';
		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$name =~ y/-/./ if $isarg;
		952
		953	$term->scan_meta;
		954
		955	my $r = $term->{meta}{resource};
		956	keys %$r; # reste iterator
		957	while (my ($pattern, $v) = each %$r) {
		958	if (
		959	$pattern =~ /\.$/
		960	? $pattern eq substr $name, 0, length $pattern
		961	: $pattern eq $name
		962	) {
		963	$name = "$urxvt::RESCLASS.$name";
		964
		965	push @{ $term->{perl_ext_3} }, $v->[0];
		966
		967	if ($v->[1] eq "boolean") {
		968	$term->put_option_db ($name, $flag ? "true" : "false");
		969	return 1;
		970	} else {
		971	$term->put_option_db ($name, $value);
		972	return 1 + 2;
		973	}
		974	}
		975	}
		976
		977	0
		978	}
		979
		980	sub usage {
		981	my ($term, $usage_type) = @_;
		982
		983	$term->scan_meta;
		984
		985	my $r = $term->{meta}{resource};
		986
		987	for my $pattern (sort keys %$r) {
		988	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		989
		990	$desc .= " (-pe $ext)";
		991
		992	if ($usage_type == 1) {
		993	$pattern =~ y/./-/;
		994	$pattern =~ s/-$/-.../g;
		995
		996	if ($type eq "boolean") {
		997	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		998	} else {
		999	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		1000	}
		1001	} else {
		1002	$pattern =~ s/\.$/.*/g;
		1003	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1004	}
		1005	}
		1006	}
		1007
646	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1008	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
647		1009
648	sub verbose {	1010	sub verbose {
649	my ($level, $msg) = @_;	1011	my ($level, $msg) = @_;
650	warn "$msg\n" if $level <= $verbosity;	1012	warn "$msg\n" if $level <= $verbosity;
…		…
653	my %extension_pkg;	1015	my %extension_pkg;
654		1016
655	# load a single script into its own package, once only	1017	# load a single script into its own package, once only
656	sub extension_package($) {	1018	sub extension_package($) {
657	my ($path) = @_;	1019	my ($path) = @_;
658
659	no strict 'refs';
660		1020
661	$extension_pkg{$path} ||= do {	1021	$extension_pkg{$path} ||= do {
662	$path =~ /([^\/\\]+)$/;	1022	$path =~ /([^\/\\]+)$/;
663	my $pkg = $1;	1023	my $pkg = $1;
664	$pkg =~ s/[^[:word:]]/_/g;	1024	$pkg =~ s/[^[:word:]]/_/g;
…		…
667	verbose 3, "loading extension '$path' into package '$pkg'";	1027	verbose 3, "loading extension '$path' into package '$pkg'";
668		1028
669	open my $fh, "<:raw", $path	1029	open my $fh, "<:raw", $path
670	or die "$path: $!";	1030	or die "$path: $!";
671		1031
672	@{"$pkg\::ISA"} = urxvt::term::extension::;
673
674	my $source =	1032	my $source =
675	"package $pkg; use strict; use utf8;\n"	1033	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
676	. "#line 1 \"$path\"\n{\n"	1034	. "#line 1 \"$path\"\n{\n"
677	. (do { local $/; <$fh> })	1035	. (do { local $/; <$fh> })
678	. "\n};\n1";	1036	. "\n};\n1";
679		1037
680	eval $source	1038	eval $source
…		…
690	sub invoke {	1048	sub invoke {
691	local $TERM = shift;	1049	local $TERM = shift;
692	my $htype = shift;	1050	my $htype = shift;
693		1051
694	if ($htype == 0) { # INIT	1052	if ($htype == 0) { # INIT
695	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1053	my @dirs = $TERM->perl_libdirs;
696		1054
697	my %ext_arg;	1055	my %ext_arg;
698		1056
		1057	{
		1058	my @init = @TERM_INIT;
		1059	@TERM_INIT = ();
		1060	$_->($TERM) for @init;
		1061	my @pkg = @TERM_EXT;
		1062	@TERM_EXT = ();
		1063	$TERM->register_package ($_) for @pkg;
		1064	}
		1065
		1066	for (
		1067	@{ delete $TERM->{perl_ext_3} },
699	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1068	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1069	) {
700	if ($_ eq "default") {	1070	if ($_ eq "default") {
701	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	1071	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
702	} elsif (/^-(.*)$/) {	1072	} elsif (/^-(.*)$/) {
703	delete $ext_arg{$1};	1073	delete $ext_arg{$1};
704	} elsif (/^([^<]+)<(.*)>$/) {	1074	} elsif (/^([^<]+)<(.*)>$/) {
705	push @{ $ext_arg{$1} }, $2;	1075	push @{ $ext_arg{$1} }, $2;
706	} else {	1076	} else {
707	$ext_arg{$_} ||= [];	1077	$ext_arg{$_} ||= [];
708	}	1078	}
709	}	1079	}
710		1080
711	while (my ($ext, $argv) = each %ext_arg) {	1081	for my $ext (sort keys %ext_arg) {
712	my @files = grep -f $_, map "$_/$ext", @dirs;	1082	my @files = grep -f $_, map "$_/$ext", @dirs;
713		1083
714	if (@files) {	1084	if (@files) {
715	$TERM->register_package (extension_package $files[0], $argv);	1085	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
716	} else {	1086	} else {
717	warn "perl extension '$ext' not found in perl library search path\n";	1087	warn "perl extension '$ext' not found in perl library search path\n";
718	}	1088	}
719	}	1089	}
720		1090
…		…
726		1096
727	if (my $cb = $TERM->{_hook}[$htype]) {	1097	if (my $cb = $TERM->{_hook}[$htype]) {
728	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1098	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
729	if $verbosity >= 10;	1099	if $verbosity >= 10;
730		1100
731	keys %$cb;	1101	for my $pkg (keys %$cb) {
732
733	while (my ($pkg, $cb) = each %$cb) {
734	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1102	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
735	and last;	1103	$retval ||= $retval_;
736		1104
737	if ($@) {	1105	if ($@) {
738	$TERM->ungrab; # better to lose the grab than the session	1106	$TERM->ungrab; # better to lose the grab than the session
739	warn $@;	1107	warn $@;
740	}	1108	}
…		…
751	# clear package	1119	# clear package
752	%$TERM = ();	1120	%$TERM = ();
753	}	1121	}
754		1122
755	$retval	1123	$retval
		1124	}
		1125
		1126	sub SET_COLOR($$$) {
		1127	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1128	}
		1129
		1130	sub rend2mask {
		1131	no strict 'refs';
		1132	my ($str, $mask) = (@_, 0);
		1133	my %color = ( fg => undef, bg => undef );
		1134	my @failed;
		1135	for my $spec ( split /\s+/, $str ) {
		1136	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1137	$color{lc($1)} = $2;
		1138	} else {
		1139	my $neg = $spec =~ s/^[-^]//;
		1140	unless ( exists &{"RS_$spec"} ) {
		1141	push @failed, $spec;
		1142	next;
		1143	}
		1144	my $cur = &{"RS_$spec"};
		1145	if ( $neg ) {
		1146	$mask &= ~$cur;
		1147	} else {
		1148	$mask |= $cur;
		1149	}
		1150	}
		1151	}
		1152	($mask, @color{qw(fg bg)}, \@failed)
756	}	1153	}
757		1154
758	# urxvt::term::extension	1155	# urxvt::term::extension
759		1156
760	package urxvt::term::extension;	1157	package urxvt::term::extension;
…		…
825	=head2 The C<urxvt::anyevent> Class	1222	=head2 The C<urxvt::anyevent> Class
826		1223
827	The sole purpose of this class is to deliver an interface to the	1224	The sole purpose of this class is to deliver an interface to the
828	C<AnyEvent> module - any module using it will work inside urxvt without	1225	C<AnyEvent> module - any module using it will work inside urxvt without
829	further programming. The only exception is that you cannot wait on	1226	further programming. The only exception is that you cannot wait on
830	condition variables, but non-blocking condvar use is ok. What this means	1227	condition variables, but non-blocking condvar use is ok.
831	is that you cannot use blocking APIs, but the non-blocking variant should	1228
832	work.	1229	In practical terms this means is that you cannot use blocking APIs, but
		1230	the non-blocking variant should work.
833		1231
834	=cut	1232	=cut
835		1233
836	our $VERSION = 1;	1234	our $VERSION = '5.23';
837		1235
838	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1236	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
839	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1237	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
840		1238
841	sub timer {	1239	sub timer {
…		…
843		1241
844	my $cb = $arg{cb};	1242	my $cb = $arg{cb};
845		1243
846	urxvt::timer	1244	urxvt::timer
847	->new	1245	->new
848	->start (urxvt::NOW + $arg{after})	1246	->after ($arg{after}, $arg{interval})
849	->cb (sub {	1247	->cb ($arg{interval} ? $cb : sub {
850	$_[0]->stop; # need to cancel manually	1248	$_[0]->stop; # need to cancel manually
851	$cb->();	1249	$cb->();
852	})	1250	})
853	}	1251	}
854		1252
855	sub io {	1253	sub io {
856	my ($class, %arg) = @_;	1254	my ($class, %arg) = @_;
857		1255
858	my $cb = $arg{cb};	1256	my $cb = $arg{cb};
		1257	my $fd = fileno $arg{fh};
		1258	defined $fd or $fd = $arg{fh};
859		1259
860	bless [$arg{fh}, urxvt::iow	1260	bless [$arg{fh}, urxvt::iow
861	->new	1261	->new
862	->fd (fileno $arg{fh})	1262	->fd ($fd)
863	->events (($arg{poll} =~ /r/ ? 1 : 0)	1263	->events (($arg{poll} =~ /r/ ? 1 : 0)
864	| ($arg{poll} =~ /w/ ? 2 : 0))	1264	| ($arg{poll} =~ /w/ ? 2 : 0))
865	->start	1265	->start
866	->cb (sub {	1266	->cb ($cb)
867	$cb->(($_[1] & 1 ? 'r' : '')
868	. ($_[1] & 2 ? 'w' : ''));
869	})],
870	urxvt::anyevent::	1267	], urxvt::anyevent::
		1268	}
		1269
		1270	sub idle {
		1271	my ($class, %arg) = @_;
		1272
		1273	my $cb = $arg{cb};
		1274
		1275	urxvt::iw
		1276	->new
		1277	->start
		1278	->cb ($cb)
		1279	}
		1280
		1281	sub child {
		1282	my ($class, %arg) = @_;
		1283
		1284	my $cb = $arg{cb};
		1285
		1286	urxvt::pw
		1287	->new
		1288	->start ($arg{pid})
		1289	->cb (sub {
		1290	$_[0]->stop; # need to cancel manually
		1291	$cb->($_[0]->rpid, $_[0]->rstatus);
		1292	})
871	}	1293	}
872		1294
873	sub DESTROY {	1295	sub DESTROY {
874	$_[0][1]->stop;	1296	$_[0][1]->stop;
875	}	1297	}
876		1298
877	sub condvar {	1299	# only needed for AnyEvent < 6 compatibility
878	bless \my $flag, urxvt::anyevent::condvar::	1300	sub one_event {
879	}
880
881	sub urxvt::anyevent::condvar::broadcast {
882	${$_[0]}++;
883	}
884
885	sub urxvt::anyevent::condvar::wait {
886	unless (${$_[0]}) {
887	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1301	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
888	}
889	}	1302	}
890		1303
891	package urxvt::term;	1304	package urxvt::term;
892		1305
893	=head2 The C<urxvt::term> Class	1306	=head2 The C<urxvt::term> Class
…		…
898		1311
899	# find on_xxx subs in the package and register them	1312	# find on_xxx subs in the package and register them
900	# as hooks	1313	# as hooks
901	sub register_package {	1314	sub register_package {
902	my ($self, $pkg, $argv) = @_;	1315	my ($self, $pkg, $argv) = @_;
		1316
		1317	no strict 'refs';
		1318
		1319	urxvt::verbose 6, "register package $pkg to $self";
		1320
		1321	@{"$pkg\::ISA"} = urxvt::term::extension::;
903		1322
904	my $proxy = bless {	1323	my $proxy = bless {
905	_pkg => $pkg,	1324	_pkg => $pkg,
906	argv => $argv,	1325	argv => $argv,
907	}, $pkg;	1326	}, $pkg;
…		…
914	$proxy->enable ($name => $ref);	1333	$proxy->enable ($name => $ref);
915	}	1334	}
916	}	1335	}
917	}	1336	}
918		1337
		1338	sub perl_libdirs {
		1339	map { split /:/ }
		1340	$_[0]->resource ("perl_lib"),
		1341	$ENV{URXVT_PERL_LIB},
		1342	"$ENV{HOME}/.urxvt/ext",
		1343	"$LIBDIR/perl"
		1344	}
		1345
		1346	sub scan_meta {
		1347	my ($self) = @_;
		1348	my @libdirs = perl_libdirs $self;
		1349
		1350	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1351
		1352	my %meta;
		1353
		1354	$self->{meta_libdirs} = join "\x00", @libdirs;
		1355	$self->{meta} = \%meta;
		1356
		1357	for my $dir (reverse @libdirs) {
		1358	opendir my $fh, $dir
		1359	or next;
		1360	for my $ext (readdir $fh) {
		1361	$ext ne "."
		1362	and $ext ne ".."
		1363	and open my $fh, "<", "$dir/$ext"
		1364	or next;
		1365
		1366	while (<$fh>) {
		1367	if (/^#:META:X_RESOURCE:(.*)/) {
		1368	my ($pattern, $type, $desc) = split /:/, $1;
		1369	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1370	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1371	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1372	} else {
		1373	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1374	}
		1375	} elsif (/^\s*(?:#|$)/) {
		1376	# skip other comments and empty lines
		1377	} else {
		1378	last; # stop parsing on first non-empty non-comment line
		1379	}
		1380	}
		1381	}
		1382	}
		1383	}
		1384
919	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1385	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
920		1386
921	Creates a new terminal, very similar as if you had started it with system	1387	Creates a new terminal, very similar as if you had started it with system
922	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1388	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
923	hash which defines the environment of the new terminal.	1389	hash which defines the environment of the new terminal.
924		1390
925	Croaks (and probably outputs an error message) if the new instance	1391	Croaks (and probably outputs an error message) if the new instance
926	couldn't be created. Returns C<undef> if the new instance didn't	1392	couldn't be created. Returns C<undef> if the new instance didn't
927	initialise perl, and the terminal object otherwise. The C<init> and	1393	initialise perl, and the terminal object otherwise. The C<init> and
928	C<start> hooks will be called during this call.	1394	C<start> hooks will be called before this call returns, and are free to
		1395	refer to global data (which is race free).
929		1396
930	=cut	1397	=cut
931		1398
932	sub new {	1399	sub new {
933	my ($class, $env, @args) = @_;	1400	my ($class, $env, @args) = @_;
934		1401
		1402	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1403	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1404
935	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1405	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
936	}	1406	}
937		1407
938	=item $term->destroy	1408	=item $term->destroy
939		1409
940	Destroy the terminal object (close the window, free resources	1410	Destroy the terminal object (close the window, free resources
…		…
970		1440
971	Returns true if the option specified by C<$optval> is enabled, and	1441	Returns true if the option specified by C<$optval> is enabled, and
972	optionally change it. All option values are stored by name in the hash	1442	optionally change it. All option values are stored by name in the hash
973	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1443	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
974		1444
975	Here is a a likely non-exhaustive list of option names, please see the	1445	Here is a likely non-exhaustive list of option names, please see the
976	source file F</src/optinc.h> to see the actual list:	1446	source file F</src/optinc.h> to see the actual list:
977		1447
978	borderLess console cursorBlink cursorUnderline hold iconic insecure	1448	borderLess buffered console cursorBlink cursorUnderline hold iconic
979	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1449	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
980	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1450	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
981	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1451	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
982	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1452	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
983	transparent tripleclickwords utmpInhibit visualBell	1453	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1454	urgentOnBell utmpInhibit visualBell
984		1455
985	=item $value = $term->resource ($name[, $newval])	1456	=item $value = $term->resource ($name[, $newval])
986		1457
987	Returns the current resource value associated with a given name and	1458	Returns the current resource value associated with a given name and
988	optionally sets a new value. Setting values is most useful in the C<init>	1459	optionally sets a new value. Setting values is most useful in the C<init>
…		…
997	likely change).	1468	likely change).
998		1469
999	Please note that resource strings will currently only be freed when the	1470	Please note that resource strings will currently only be freed when the
1000	terminal is destroyed, so changing options frequently will eat memory.	1471	terminal is destroyed, so changing options frequently will eat memory.
1001		1472
1002	Here is a a likely non-exhaustive list of resource names, not all of which	1473	Here is a likely non-exhaustive list of resource names, not all of which
1003	are supported in every build, please see the source file F</src/rsinc.h>	1474	are supported in every build, please see the source file F</src/rsinc.h>
1004	to see the actual list:	1475	to see the actual list:
1005		1476
1006	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1477	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1007	borderLess color cursorBlink cursorUnderline cutchars delete_key	1478	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1008	display_name embed ext_bwidth fade font geometry hold iconName	1479	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1009	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1480	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1481	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1010	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1482	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1011	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1483	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1012	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1484	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1013	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1485	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1014	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1486	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1015	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1487	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1016	secondaryScreen secondaryScroll selectstyle shade term_name title	1488	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1017	transient_for transparent transparent_all tripleclickwords utmpInhibit	1489	term_name title transient_for transparent tripleclickwords urgentOnBell
1018	visualBell	1490	utmpInhibit visualBell
1019		1491
1020	=cut	1492	=cut
1021		1493
1022	sub resource($$;$) {	1494	sub resource($$;$) {
1023	my ($self, $name) = (shift, shift);	1495	my ($self, $name) = (shift, shift);
1024	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1496	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1025	&urxvt::term::_resource	1497	goto &urxvt::term::_resource
1026	}	1498	}
1027		1499
1028	=item $value = $term->x_resource ($pattern)	1500	=item $value = $term->x_resource ($pattern)
1029		1501
1030	Returns the X-Resource for the given pattern, excluding the program or	1502	Returns the X-Resource for the given pattern, excluding the program or
…		…
1034		1506
1035	This method should only be called during the C<on_start> hook, as there is	1507	This method should only be called during the C<on_start> hook, as there is
1036	only one resource database per display, and later invocations might return	1508	only one resource database per display, and later invocations might return
1037	the wrong resources.	1509	the wrong resources.
1038		1510
1039	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1511	=item $value = $term->x_resource_boolean ($pattern)
1040		1512
		1513	Like C<x_resource>, above, but interprets the string value as a boolean
		1514	and returns C<1> for true values, C<0> for false values and C<undef> if
		1515	the resource or option isn't specified.
		1516
		1517	You should always use this method to parse boolean resources.
		1518
		1519	=cut
		1520
		1521	sub x_resource_boolean {
		1522	my $res = &x_resource;
		1523
		1524	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1525	}
		1526
		1527	=item $success = $term->parse_keysym ($key, $octets)
		1528
1041	Adds a keymap translation exactly as specified via a resource. See the	1529	Adds a key binding exactly as specified via a resource. See the
1042	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1530	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1531
		1532	=item $term->register_command ($keysym, $modifiermask, $string)
		1533
		1534	Adds a key binding. This is a lower level api compared to
		1535	C<parse_keysym>, as it expects a parsed key description, and can be
		1536	used only inside either the C<on_init> hook, to add a binding, or the
		1537	C<on_register_command> hook, to modify a parsed binding.
1043		1538
1044	=item $rend = $term->rstyle ([$new_rstyle])	1539	=item $rend = $term->rstyle ([$new_rstyle])
1045		1540
1046	Return and optionally change the current rendition. Text that is output by	1541	Return and optionally change the current rendition. Text that is output by
1047	the terminal application will use this style.	1542	the terminal application will use this style.
…		…
1055		1550
1056	=item ($row, $col) = $term->selection_beg ([$row, $col])	1551	=item ($row, $col) = $term->selection_beg ([$row, $col])
1057		1552
1058	=item ($row, $col) = $term->selection_end ([$row, $col])	1553	=item ($row, $col) = $term->selection_end ([$row, $col])
1059		1554
1060	Return the current values of the selection mark, begin or end positions,	1555	Return the current values of the selection mark, begin or end positions.
1061	and optionally set them to new values.	1556
		1557	When arguments are given, then the selection coordinates are set to
		1558	C<$row> and C<$col>, and the selection screen is set to the current
		1559	screen.
		1560
		1561	=item $screen = $term->selection_screen ([$screen])
		1562
		1563	Returns the current selection screen, and then optionally sets it.
1062		1564
1063	=item $term->selection_make ($eventtime[, $rectangular])	1565	=item $term->selection_make ($eventtime[, $rectangular])
1064		1566
1065	Tries to make a selection as set by C<selection_beg> and	1567	Tries to make a selection as set by C<selection_beg> and
1066	C<selection_end>. If C<$rectangular> is true (default: false), a	1568	C<selection_end>. If C<$rectangular> is true (default: false), a
1067	rectangular selection will be made. This is the prefered function to make	1569	rectangular selection will be made. This is the preferred function to make
1068	a selection.	1570	a selection.
1069		1571
1070	=item $success = $term->selection_grab ($eventtime)	1572	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1071		1573
1072	Try to request the primary selection text from the server (for example, as	1574	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1575	true) selection from the server. The corresponding text can be set
1073	set by the next method). No visual feedback will be given. This function	1576	with the next method. No visual feedback will be given. This function
1074	is mostly useful from within C<on_sel_grab> hooks.	1577	is mostly useful from within C<on_sel_grab> hooks.
1075		1578
1076	=item $oldtext = $term->selection ([$newtext])	1579	=item $oldtext = $term->selection ([$newtext, $clipboard])
1077		1580
1078	Return the current selection text and optionally replace it by C<$newtext>.	1581	Return the current selection (clipboard if C<$clipboard> is true) text
		1582	and optionally replace it by C<$newtext>.
		1583
		1584	=item $term->selection_clear ([$clipboard])
		1585
		1586	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1079		1587
1080	=item $term->overlay_simple ($x, $y, $text)	1588	=item $term->overlay_simple ($x, $y, $text)
1081		1589
1082	Create a simple multi-line overlay box. See the next method for details.	1590	Create a simple multi-line overlay box. See the next method for details.
1083		1591
…		…
1113		1621
1114	The methods currently supported on C<urxvt::overlay> objects are:	1622	The methods currently supported on C<urxvt::overlay> objects are:
1115		1623
1116	=over 4	1624	=over 4
1117		1625
1118	=item $overlay->set ($x, $y, $text, $rend)	1626	=item $overlay->set ($x, $y, $text[, $rend])
1119		1627
1120	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1628	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1121	text in rxvt-unicode's special encoding and an array of rendition values	1629	text in rxvt-unicode's special encoding and an array of rendition values
1122	at a specific position inside the overlay.	1630	at a specific position inside the overlay.
		1631
		1632	If C<$rend> is missing, then the rendition will not be changed.
1123		1633
1124	=item $overlay->hide	1634	=item $overlay->hide
1125		1635
1126	If visible, hide the overlay, but do not destroy it.	1636	If visible, hide the overlay, but do not destroy it.
1127		1637
…		…
1197		1707
1198	Normally its not a good idea to use this function, as programs might be	1708	Normally its not a good idea to use this function, as programs might be
1199	confused by changes in cursor position or scrolling. Its useful inside a	1709	confused by changes in cursor position or scrolling. Its useful inside a
1200	C<on_add_lines> hook, though.	1710	C<on_add_lines> hook, though.
1201		1711
		1712	=item $term->scr_change_screen ($screen)
		1713
		1714	Switch to given screen - 0 primary, 1 secondary.
		1715
1202	=item $term->cmd_parse ($octets)	1716	=item $term->cmd_parse ($octets)
1203		1717
1204	Similar to C<scr_add_lines>, but the argument must be in the	1718	Similar to C<scr_add_lines>, but the argument must be in the
1205	locale-specific encoding of the terminal and can contain command sequences	1719	locale-specific encoding of the terminal and can contain command sequences
1206	(escape codes) that will be interpreted.	1720	(escape codes) that will be interpreted.
1207		1721
1208	=item $term->tt_write ($octets)	1722	=item $term->tt_write ($octets)
1209		1723
1210	Write the octets given in C<$data> to the tty (i.e. as program input). To	1724	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1211	pass characters instead of octets, you should convert your strings first	1725	pass characters instead of octets, you should convert your strings first
1212	to the locale-specific encoding using C<< $term->locale_encode >>.	1726	to the locale-specific encoding using C<< $term->locale_encode >>.
		1727
		1728	=item $term->tt_paste ($octets)
		1729
		1730	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1731	CR and bracketing the data with control sequences if bracketed paste mode
		1732	is set.
1213		1733
1214	=item $old_events = $term->pty_ev_events ([$new_events])	1734	=item $old_events = $term->pty_ev_events ([$new_events])
1215		1735
1216	Replaces the event mask of the pty watcher by the given event mask. Can	1736	Replaces the event mask of the pty watcher by the given event mask. Can
1217	be used to suppress input and output handling to the pty/tty. See the	1737	be used to suppress input and output handling to the pty/tty. See the
1218	description of C<< urxvt::timer->events >>. Make sure to always restore	1738	description of C<< urxvt::timer->events >>. Make sure to always restore
1219	the previous value.	1739	the previous value.
1220		1740
		1741	=item $fd = $term->pty_fd
		1742
		1743	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1744	is used.
		1745
1221	=item $windowid = $term->parent	1746	=item $windowid = $term->parent
1222		1747
1223	Return the window id of the toplevel window.	1748	Return the window id of the toplevel window.
1224		1749
1225	=item $windowid = $term->vt	1750	=item $windowid = $term->vt
…		…
1231	Adds the specified events to the vt event mask. Useful e.g. when you want	1756	Adds the specified events to the vt event mask. Useful e.g. when you want
1232	to receive pointer events all the times:	1757	to receive pointer events all the times:
1233		1758
1234	$term->vt_emask_add (urxvt::PointerMotionMask);	1759	$term->vt_emask_add (urxvt::PointerMotionMask);
1235		1760
		1761	=item $term->set_urgency ($set)
		1762
		1763	Enable/disable the urgency hint on the toplevel window.
		1764
		1765	=item $term->focus_in
		1766
		1767	=item $term->focus_out
		1768
		1769	=item $term->key_press ($state, $keycode[, $time])
		1770
		1771	=item $term->key_release ($state, $keycode[, $time])
		1772
		1773	Deliver various fake events to to terminal.
		1774
1236	=item $window_width = $term->width	1775	=item $window_width = $term->width
1237		1776
1238	=item $window_height = $term->height	1777	=item $window_height = $term->height
1239		1778
1240	=item $font_width = $term->fwidth	1779	=item $font_width = $term->fwidth
…		…
1270	=item $env = $term->env	1809	=item $env = $term->env
1271		1810
1272	Returns a copy of the environment in effect for the terminal as a hashref	1811	Returns a copy of the environment in effect for the terminal as a hashref
1273	similar to C<\%ENV>.	1812	similar to C<\%ENV>.
1274		1813
		1814	=item @envv = $term->envv
		1815
		1816	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1817
		1818	=item @argv = $term->argv
		1819
		1820	Return the argument vector as this terminal, similar to @ARGV, but
		1821	includes the program name as first element.
		1822
1275	=cut	1823	=cut
1276		1824
1277	sub env {	1825	sub env {
1278	if (my $env = $_[0]->_env) {
1279	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1826	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1280	} else {
1281	+{ %ENV }
1282	}
1283	}	1827	}
1284		1828
1285	=item $modifiermask = $term->ModLevel3Mask	1829	=item $modifiermask = $term->ModLevel3Mask
1286		1830
1287	=item $modifiermask = $term->ModMetaMask	1831	=item $modifiermask = $term->ModMetaMask
1288		1832
1289	=item $modifiermask = $term->ModNumLockMask	1833	=item $modifiermask = $term->ModNumLockMask
1290		1834
1291	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1835	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1292	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1836	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1837
		1838	=item $screen = $term->current_screen
		1839
		1840	Returns the currently displayed screen (0 primary, 1 secondary).
		1841
		1842	=item $cursor_is_hidden = $term->hidden_cursor
		1843
		1844	Returns whether the cursor is currently hidden or not.
1293		1845
1294	=item $view_start = $term->view_start ([$newvalue])	1846	=item $view_start = $term->view_start ([$newvalue])
1295		1847
1296	Returns the row number of the topmost displayed line. Maximum value is	1848	Returns the row number of the topmost displayed line. Maximum value is
1297	C<0>, which displays the normal terminal contents. Lower values scroll	1849	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1305		1857
1306	Used after changing terminal contents to display them.	1858	Used after changing terminal contents to display them.
1307		1859
1308	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1860	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1309		1861
1310	Returns the text of the entire row with number C<$row_number>. Row C<0>	1862	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1311	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1863	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1312	terminal line. The scrollback buffer starts at line C<-1> and extends to
1313	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1864	terminal line. Nothing will be returned if a nonexistent line
1314	is requested.	1865	is requested.
1315		1866
1316	If C<$new_text> is specified, it will replace characters in the current	1867	If C<$new_text> is specified, it will replace characters in the current
1317	line, starting at column C<$start_col> (default C<0>), which is useful	1868	line, starting at column C<$start_col> (default C<0>), which is useful
1318	to replace only parts of a line. The font index in the rendition will	1869	to replace only parts of a line. The font index in the rendition will
1319	automatically be updated.	1870	automatically be updated.
1320		1871
1321	C<$text> is in a special encoding: tabs and wide characters that use more	1872	C<$text> is in a special encoding: tabs and wide characters that use more
1322	than one cell when displayed are padded with urxvt::NOCHAR characters	1873	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1323	(C<chr 65535>). Characters with combining characters and other characters	1874	characters. Characters with combining characters and other characters that
1324	that do not fit into the normal tetx encoding will be replaced with	1875	do not fit into the normal text encoding will be replaced with characters
1325	characters in the private use area.	1876	in the private use area.
1326		1877
1327	You have to obey this encoding when changing text. The advantage is	1878	You have to obey this encoding when changing text. The advantage is
1328	that C<substr> and similar functions work on screen cells and not on	1879	that C<substr> and similar functions work on screen cells and not on
1329	characters.	1880	characters.
1330		1881
…		…
1474	where one character corresponds to one screen cell. See	2025	where one character corresponds to one screen cell. See
1475	C<< $term->ROW_t >> for details.	2026	C<< $term->ROW_t >> for details.
1476		2027
1477	=item $string = $term->special_decode $text	2028	=item $string = $term->special_decode $text
1478		2029
1479	Converts rxvt-unicodes text reprsentation into a perl string. See	2030	Converts rxvt-unicodes text representation into a perl string. See
1480	C<< $term->ROW_t >> for details.	2031	C<< $term->ROW_t >> for details.
1481		2032
1482	=item $success = $term->grab_button ($button, $modifiermask)	2033	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1483		2034
		2035	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2036
1484	Registers a synchronous button grab. See the XGrabButton manpage.	2037	Register/unregister a synchronous button grab. See the XGrabButton
		2038	manpage.
1485		2039
1486	=item $success = $term->grab ($eventtime[, $sync])	2040	=item $success = $term->grab ($eventtime[, $sync])
1487		2041
1488	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2042	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1489	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2043	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1490		2044
1491	=item $term->allow_events_async	2045	=item $term->allow_events_async
1492		2046
1493	Calls XAllowEvents with AsyncBoth for the most recent grab.	2047	Calls XAllowEvents with AsyncBoth for the most recent grab.
1494		2048
…		…
1501	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2055	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1502	recent grab.	2056	recent grab.
1503		2057
1504	=item $term->ungrab	2058	=item $term->ungrab
1505		2059
1506	Calls XUngrab for the most recent grab. Is called automatically on	2060	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1507	evaluation errors, as it is better to lose the grab in the error case as	2061	evaluation errors, as it is better to lose the grab in the error case as
1508	the session.	2062	the session.
		2063
		2064	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		2065
		2066	=item $atom_name = $term->XGetAtomName ($atom)
		2067
		2068	=item @atoms = $term->XListProperties ($window)
		2069
		2070	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		2071
		2072	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		2073
		2074	=item $term->XDeleteProperty ($window, $property)
		2075
		2076	=item $window = $term->DefaultRootWindow
		2077
		2078	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		2079
		2080	=item $term->XMapWindow ($window)
		2081
		2082	=item $term->XUnmapWindow ($window)
		2083
		2084	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		2085
		2086	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		2087
		2088	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2089
		2090	=item $keysym = $term->XStringToKeysym ($string)
		2091
		2092	=item $string = $term->XKeysymToString ($keysym)
		2093
		2094	Various X or X-related functions. The C<$term> object only serves as
		2095	the source of the display, otherwise those functions map more-or-less
		2096	directly onto the X functions of the same name.
1509		2097
1510	=back	2098	=back
1511		2099
1512	=cut	2100	=cut
1513		2101
…		…
1577	my ($self, $text, $cb) = @_;	2165	my ($self, $text, $cb) = @_;
1578		2166
1579	$self->add_item ({ type => "button", text => $text, activate => $cb});	2167	$self->add_item ({ type => "button", text => $text, activate => $cb});
1580	}	2168	}
1581		2169
1582	=item $popup->add_toggle ($text, $cb, $initial_value)	2170	=item $popup->add_toggle ($text, $initial_value, $cb)
1583		2171
1584	Adds a toggle/checkbox item to the popup. Teh callback gets called	2172	Adds a toggle/checkbox item to the popup. The callback gets called
1585	whenever it gets toggled, with a boolean indicating its value as its first	2173	whenever it gets toggled, with a boolean indicating its new value as its
1586	argument.	2174	first argument.
1587		2175
1588	=cut	2176	=cut
1589		2177
1590	sub add_toggle {	2178	sub add_toggle {
1591	my ($self, $text, $cb, $value) = @_;	2179	my ($self, $text, $value, $cb) = @_;
1592		2180
1593	my $item; $item = {	2181	my $item; $item = {
1594	type => "button",	2182	type => "button",
1595	text => " $text",	2183	text => " $text",
1596	value => $value,	2184	value => $value,
…		…
1615	my $env = $self->{term}->env;	2203	my $env = $self->{term}->env;
1616	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2204	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1617	delete $env->{LC_ALL};	2205	delete $env->{LC_ALL};
1618	$env->{LC_CTYPE} = $self->{term}->locale;	2206	$env->{LC_CTYPE} = $self->{term}->locale;
1619		2207
1620	urxvt::term->new ($env, "popup",	2208	my $term = urxvt::term->new (
		2209	$env, "popup",
1621	"--perl-lib" => "", "--perl-ext-common" => "",	2210	"--perl-lib" => "", "--perl-ext-common" => "",
1622	"-pty-fd" => -1, "-sl" => 0,	2211	"-pty-fd" => -1, "-sl" => 0,
1623	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2212	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1624	"--transient-for" => $self->{term}->parent,	2213	"--transient-for" => $self->{term}->parent,
1625	"-display" => $self->{term}->display_id,	2214	"-display" => $self->{term}->display_id,
1626	"-pe" => "urxvt-popup")	2215	"-pe" => "urxvt-popup",
1627	or die "unable to create popup window\n";	2216	) or die "unable to create popup window\n";
		2217
		2218	unless (delete $term->{urxvt_popup_init_done}) {
		2219	$term->ungrab;
		2220	$term->destroy;
		2221	die "unable to initialise popup window\n";
		2222	}
1628	}	2223	}
1629		2224
1630	sub DESTROY {	2225	sub DESTROY {
1631	my ($self) = @_;	2226	my ($self) = @_;
1632		2227
1633	delete $self->{term}{_destroy}{$self};	2228	delete $self->{term}{_destroy}{$self};
1634	$self->{term}->ungrab;	2229	$self->{term}->ungrab;
1635	}	2230	}
1636		2231
1637	=back	2232	=back
		2233
		2234	=cut
		2235
		2236	package urxvt::watcher;
1638		2237
1639	=head2 The C<urxvt::timer> Class	2238	=head2 The C<urxvt::timer> Class
1640		2239
1641	This class implements timer watchers/events. Time is represented as a	2240	This class implements timer watchers/events. Time is represented as a
1642	fractional number of seconds since the epoch. Example:	2241	fractional number of seconds since the epoch. Example:
…		…
1646	->new	2245	->new
1647	->interval (1)	2246	->interval (1)
1648	->cb (sub {	2247	->cb (sub {
1649	$term->{overlay}->set (0, 0,	2248	$term->{overlay}->set (0, 0,
1650	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2249	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1651	});	2250	});
1652		2251
1653	=over 4	2252	=over 4
1654		2253
1655	=item $timer = new urxvt::timer	2254	=item $timer = new urxvt::timer
1656		2255
…		…
1659		2258
1660	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2259	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1661		2260
1662	Set the callback to be called when the timer triggers.	2261	Set the callback to be called when the timer triggers.
1663		2262
1664	=item $tstamp = $timer->at
1665
1666	Return the time this watcher will fire next.
1667
1668	=item $timer = $timer->set ($tstamp)	2263	=item $timer = $timer->set ($tstamp[, $interval])
1669		2264
1670	Set the time the event is generated to $tstamp.	2265	Set the time the event is generated to $tstamp (and optionally specifies a
		2266	new $interval).
1671		2267
1672	=item $timer = $timer->interval ($interval)	2268	=item $timer = $timer->interval ($interval)
1673		2269
1674	Normally (and when C<$interval> is C<0>), the timer will automatically	2270	By default (and when C<$interval> is C<0>), the timer will automatically
1675	stop after it has fired once. If C<$interval> is non-zero, then the timer	2271	stop after it has fired once. If C<$interval> is non-zero, then the timer
1676	is automatically rescheduled at the given intervals.	2272	is automatically rescheduled at the given intervals.
1677		2273
1678	=item $timer = $timer->start	2274	=item $timer = $timer->start
1679		2275
1680	Start the timer.	2276	Start the timer.
1681		2277
1682	=item $timer = $timer->start ($tstamp)	2278	=item $timer = $timer->start ($tstamp[, $interval])
1683		2279
1684	Set the event trigger time to C<$tstamp> and start the timer.	2280	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2281	also replaces the interval.
1685		2282
1686	=item $timer = $timer->after ($delay)	2283	=item $timer = $timer->after ($delay[, $interval])
1687		2284
1688	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2285	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1689		2286
1690	=item $timer = $timer->stop	2287	=item $timer = $timer->stop
1691		2288
…		…
1699		2296
1700	$term->{socket} = ...	2297	$term->{socket} = ...
1701	$term->{iow} = urxvt::iow	2298	$term->{iow} = urxvt::iow
1702	->new	2299	->new
1703	->fd (fileno $term->{socket})	2300	->fd (fileno $term->{socket})
1704	->events (urxvt::EVENT_READ)	2301	->events (urxvt::EV_READ)
1705	->start	2302	->start
1706	->cb (sub {	2303	->cb (sub {
1707	my ($iow, $revents) = @_;	2304	my ($iow, $revents) = @_;
1708	# $revents must be 1 here, no need to check	2305	# $revents must be 1 here, no need to check
1709	sysread $term->{socket}, my $buf, 8192	2306	sysread $term->{socket}, my $buf, 8192
…		…
1722	Set the callback to be called when io events are triggered. C<$reventmask>	2319	Set the callback to be called when io events are triggered. C<$reventmask>
1723	is a bitset as described in the C<events> method.	2320	is a bitset as described in the C<events> method.
1724		2321
1725	=item $iow = $iow->fd ($fd)	2322	=item $iow = $iow->fd ($fd)
1726		2323
1727	Set the filedescriptor (not handle) to watch.	2324	Set the file descriptor (not handle) to watch.
1728		2325
1729	=item $iow = $iow->events ($eventmask)	2326	=item $iow = $iow->events ($eventmask)
1730		2327
1731	Set the event mask to watch. The only allowed values are	2328	Set the event mask to watch. The only allowed values are
1732	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2329	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1733	together, or C<urxvt::EVENT_NONE>.	2330	together, or C<urxvt::EV_NONE>.
1734		2331
1735	=item $iow = $iow->start	2332	=item $iow = $iow->start
1736		2333
1737	Start watching for requested events on the given handle.	2334	Start watching for requested events on the given handle.
1738		2335
1739	=item $iow = $iow->stop	2336	=item $iow = $iow->stop
1740		2337
1741	Stop watching for events on the given filehandle.	2338	Stop watching for events on the given file handle.
		2339
		2340	=back
		2341
		2342	=head2 The C<urxvt::iw> Class
		2343
		2344	This class implements idle watchers, that get called automatically when
		2345	the process is idle. They should return as fast as possible, after doing
		2346	some useful work.
		2347
		2348	=over 4
		2349
		2350	=item $iw = new urxvt::iw
		2351
		2352	Create a new idle watcher object in stopped state.
		2353
		2354	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2355
		2356	Set the callback to be called when the watcher triggers.
		2357
		2358	=item $timer = $timer->start
		2359
		2360	Start the watcher.
		2361
		2362	=item $timer = $timer->stop
		2363
		2364	Stop the watcher.
		2365
		2366	=back
		2367
		2368	=head2 The C<urxvt::pw> Class
		2369
		2370	This class implements process watchers. They create an event whenever a
		2371	process exits, after which they stop automatically.
		2372
		2373	my $pid = fork;
		2374	...
		2375	$term->{pw} = urxvt::pw
		2376	->new
		2377	->start ($pid)
		2378	->cb (sub {
		2379	my ($pw, $exit_status) = @_;
		2380	...
		2381	});
		2382
		2383	=over 4
		2384
		2385	=item $pw = new urxvt::pw
		2386
		2387	Create a new process watcher in stopped state.
		2388
		2389	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2390
		2391	Set the callback to be called when the timer triggers.
		2392
		2393	=item $pw = $timer->start ($pid)
		2394
		2395	Tells the watcher to start watching for process C<$pid>.
		2396
		2397	=item $pw = $pw->stop
		2398
		2399	Stop the watcher.
1742		2400
1743	=back	2401	=back
1744		2402
1745	=head1 ENVIRONMENT	2403	=head1 ENVIRONMENT
1746		2404
…		…
1755		2413
1756	=item >= 3 - script loading and management	2414	=item >= 3 - script loading and management
1757		2415
1758	=item >=10 - all called hooks	2416	=item >=10 - all called hooks
1759		2417
1760	=item >=11 - hook reutrn values	2418	=item >=11 - hook return values
1761		2419
1762	=back	2420	=back
1763		2421
1764	=head1 AUTHOR	2422	=head1 AUTHOR
1765		2423
1766	Marc Lehmann <pcg@goof.com>	2424	Marc Lehmann <schmorp@schmorp.de>
1767	http://software.schmorp.de/pkg/rxvt-unicode	2425	http://software.schmorp.de/pkg/rxvt-unicode
1768		2426
1769	=cut	2427	=cut
1770		2428
1771	1	2429	1
		2430
		2431	# vim: sw=3:

Diff Legend

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