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.121 by root, Fri Jan 20 22:49:34 2006 UTC vs.
Revision 1.208 by root, Tue Jun 5 22:23:07 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
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	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
66	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
67	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
68	between two vertical bars:	71	between two vertical bars:
69		72
70	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: ^(/[^:]+):\
71		81
72	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
73	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
74		84
75	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
86		96
87	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
88		98
89	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
90	runtime.	100	runtime.
		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	};
91		118
92	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
93		120
94	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
95	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
96	evaluation, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
97		124
98	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100	popup is displayed.	127	popup is being displayed.
101		128
102	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
103	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.
104	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
105	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
106	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
107		134
108	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
109	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
110	C<a>s:	137	C<a>s:
111		138
112	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
114	: ()	141	: ()
115	};	142	};
116		143
117	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
118		145
…		…
125	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>
126	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
127	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
128	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
129	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
130	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.
131		189
132	=item selection-autotransform	190	=item selection-autotransform
133		191
134	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
135	whenever a selection is made.	193	whenever a selection is made.
…		…
162		220
163	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
164	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
165	the message into vi commands to load the file.	223	the message into vi commands to load the file.
166		224
167	=item readline
168
169	A support package that tries to make editing with readline easier. At the
170	moment, it reacts to clicking with the left mouse button by trying to
171	move the text cursor to this position. It does so by generating as many
172	cursor-left or cursor-right keypresses as required (the this only works
173	for programs that correctly support wide characters).
174
175	It only works when clicking into the same line (possibly extended over
176	multiple rows) as the text cursor and on the primary screen, to reduce the
177	risk of misinterpreting. The normal selection isn't disabled, so quick
178	successive clicks might interfere with selection creation in harmless
179	ways.
180
181	=item tabbed	225	=item tabbed
182		226
183	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
184	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
185	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one	229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
186	button per tab.	230	button per tab.
187		231
188	Clicking a button will activate that tab. Pressing B<Shift-Left> and	232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
189	B<Shift-Right> will switch to the tab left or right of the current one,	233	B<Shift-Right> will switch to the tab left or right of the current one,
190	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
191		235
192	=item mark-urls	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):
193		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
194	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
195	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
196	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
197	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.
198		258
199	=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.
200		263
201	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
202	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
203	a custom pixmap. No scaling is supported in this mode. Exmaple:	266	"perl:matcher:list" as seen in the example below.
204		267
205	@@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.
206		315
207	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
208		317
209	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
210	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
211	similar-looking ascii character.	320	similar-looking ascii character.
212		321
213	=item digital-clock	322	=item digital-clock
214		323
215	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.
216		393
217	=item example-refresh-hooks	394	=item example-refresh-hooks
218		395
219	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
220	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
221	overlays or changes.	398	overlays or changes.
222		399
223	=item selection-pastebin	400	=item confirm-paste
224		401
225	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
226	textfile to a remote site (or does other things). (The implementation is	403	line is detected.
227	not currently secure for use in a multiuser environment as it writes to
228	F</tmp> directly.).
229		404
230	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	405	=item bell-command
231	i.e.
232		406
233	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:
234		410
235	Pressing this combination runs a command with C<%> replaced by the name of	411	URxvt.bell-command: notify-send "Beep, Beep"
236	the textfile. This command can be set via a resource:
237
238	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
239
240	And the default is likely not useful to anybody but the few people around
241	here :)
242
243	The name of the textfile is the hex encoded md5 sum of the selection, so
244	the same content should lead to the same filename.
245
246	After a successful upload the selection will be replaced by the text given
247	in the C<selection-pastebin-url> resource (again, the % is the placeholder
248	for the filename):
249
250	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
251		412
252	=back	413	=back
253		414
254	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
255		416
…		…
271		432
272	=over 4	433	=over 4
273		434
274	=item $text	435	=item $text
275		436
276	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
277	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.
278		439
279	=item $string	440	=item $string
280		441
281	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
…		…
285	=item $octets	446	=item $octets
286		447
287	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
288	locale-specific way.	449	locale-specific way.
289		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
290	=back	457	=back
291		458
292	=head2 Extension Objects	459	=head2 Extension Objects
293		460
294	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
295	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,
296	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
297	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
298	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
299	use.	467	internal use.
300		468
301	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
302	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
303		471
304	It has the following methods and data members:	472	It has the following methods and data members:
…		…
325	=head2 Hooks	493	=head2 Hooks
326		494
327	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
328	called whenever the relevant event happens.	496	called whenever the relevant event happens.
329		497
330	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
331	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
332		500
333	B<All> of these hooks must return a boolean value. If any of the called	501	B<All> of these hooks must return a boolean value. If any of the called
334	hooks returns true, then the event counts as being I<consumed>, and the	502	hooks returns true, then the event counts as being I<consumed>, and the
335	relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
…		…
348	place.	516	place.
349		517
350	=item on_start $term	518	=item on_start $term
351		519
352	Called at the very end of initialisation of a new terminal, just before	520	Called at the very end of initialisation of a new terminal, just before
353	trying to map (display) the toplevel and returning to the mainloop.	521	trying to map (display) the toplevel and returning to the main loop.
354		522
355	=item on_destroy $term	523	=item on_destroy $term
356		524
357	Called whenever something tries to destroy terminal, before doing anything	525	Called whenever something tries to destroy terminal, when the terminal is
358	yet. If this hook returns true, then destruction is skipped, but this is	526	still fully functional (not for long, though).
359	rarely a good idea.
360		527
361	=item on_reset $term	528	=item on_reset $term
362		529
363	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
364	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
…		…
386		553
387	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
388	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
389	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
390		557
391	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.
392		559
393	=item on_sel_extend $term	560	=item on_sel_extend $term
394		561
395	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
396	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
397	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
398	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
399	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
400	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
401		568
402	See the F<selection> example extension.	569	See the F<selection> example extension.
403		570
404	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
405		572
406	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
407	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
408	show this many lines of scrollback.	575	show this many lines of scrollback.
409		576
410	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
411		578
…		…
415		582
416	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,
417	$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
418	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
419		586
420	=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
421		598
422	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
423	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
424	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
425	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,
426	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
427	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	}
428		615
429	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,
430	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
431	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.
432		622
433	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
434		624
435	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
436	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
…		…
441	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
442		632
443	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
444	suppress or filter tty input.	634	suppress or filter tty input.
445		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
446	=item on_line_update $term, $row	643	=item on_line_update $term, $row
447		644
448	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
449	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
450	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,
…		…
457	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
458	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
459		656
460	=item on_refresh_begin $term	657	=item on_refresh_begin $term
461		658
462	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
463	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
464	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
465	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
466		663
467	=item on_refresh_end $term	664	=item on_refresh_end $term
468		665
469	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>.
470		667
471	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
472		669
473	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
474	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>
475	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.
476		689
477	=item on_x_event $term, $event	690	=item on_x_event $term, $event
478		691
479	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
480	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
481	members are not passed.	694	members are not passed.
482		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
483	=item on_focus_in $term	700	=item on_focus_in $term
484		701
485	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
486	does focus in processing.	703	does focus in processing.
487		704
488	=item on_focus_out $term	705	=item on_focus_out $term
489		706
490	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
491	focus out processing.	708	focus out processing.
492		709
493	=item on_configure_notify $term, $event	710	=item on_configure_notify $term, $event
494		711
495	=item on_property_notify $term, $event	712	=item on_property_notify $term, $event
…		…
506		723
507	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
508		725
509	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
510		727
511	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
512	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.
513		730
514	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
515	manpage), with the additional members C<row> and C<col>, which are the	732	manpage), with the additional members C<row> and C<col>, which are the
516	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
517		734
…		…
526		743
527	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
528		745
529	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
530	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	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.
531		752
532	=back	753	=back
533		754
534	=cut	755	=cut
535		756
…		…
552	our $LIBDIR;	773	our $LIBDIR;
553	our $RESNAME;	774	our $RESNAME;
554	our $RESCLASS;	775	our $RESCLASS;
555	our $RXVTNAME;	776	our $RXVTNAME;
556		777
557	our $NOCHAR = chr 0xfffe;	778	our $NOCHAR = chr 0xffff;
558		779
559	=head2 Variables in the C<urxvt> Package	780	=head2 Variables in the C<urxvt> Package
560		781
561	=over 4	782	=over 4
562		783
…		…
578	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
579	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
580		801
581	=item @urxvt::TERM_INIT	802	=item @urxvt::TERM_INIT
582		803
583	All coderefs in this array will be called as methods of the next newly	804	All code references in this array will be called as methods of the next newly
584	created C<urxvt::term> object (during the C<on_init> phase). The array	805	created C<urxvt::term> object (during the C<on_init> phase). The array
585	gets cleared before the codereferences that were in it are being executed,	806	gets cleared before the code references that were in it are being executed,
586	so coderefs can push themselves onto it again if they so desire.	807	so references can push themselves onto it again if they so desire.
587		808
588	This complements to the perl-eval commandline option, but gets executed	809	This complements to the perl-eval command line option, but gets executed
589	first.	810	first.
590		811
591	=item @urxvt::TERM_EXT	812	=item @urxvt::TERM_EXT
592		813
593	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	814	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
600		821
601	=over 4	822	=over 4
602		823
603	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
604		825
605	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
606	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
607	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
608		830
609	=item urxvt::warn $string	831	=item urxvt::warn $string
610		832
611	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
612	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
613	that calls this function.	835	that calls this function.
614		836
615	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
616	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
617		839
618	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).
619		848
620	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
621		850
622	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
623		852
…		…
666		895
667	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
668		897
669	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
670		899
671	=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
672		902
673	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
674	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
675	the bitset.	905	the bitset.
676		906
…		…
681	Return the foreground/background colour index, respectively.	911	Return the foreground/background colour index, respectively.
682		912
683	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
684		914
685	=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
686		918
687	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
688	specified one.	920	specified one.
689		921
690	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
…		…
709	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
710	urxvt::warn ($msg);	942	urxvt::warn ($msg);
711	};	943	};
712	}	944	}
713		945
		946	no warnings 'utf8';
		947
		948	sub resource {
		949	my ($term, $name, $isarg, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	warn "resourece<@_>\n";#d#
		954
		955	0
		956	}
		957
		958	sub usage {
		959	my ($term, $usage_type) = @_;
		960
		961	$term->scan_meta;
		962
		963	my $r = $term->{meta}{resource};
		964
		965	for my $regex (sort keys %$r) {
		966	my ($ext, $type, $desc) = @{ $r->{$regex} };
		967
		968	$desc .= " (-pe $ext)";
		969
		970	if ($usage_type == 1) {
		971	if ($type eq "boolean") {
		972	urxvt::log sprintf " -%-20.20s %s\n", "/+$regex", $desc;
		973	} else {
		974	urxvt::log sprintf " -%-20.20s %s\n", "$regex $type", $desc;
		975	}
		976	} else {
		977	urxvt::log sprintf " %-19.19s %s\n", "$regex:", $type;
		978	}
		979	}
		980	}
		981
714	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	982	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
715		983
716	sub verbose {	984	sub verbose {
717	my ($level, $msg) = @_;	985	my ($level, $msg) = @_;
718	warn "$msg\n" if $level <= $verbosity;	986	warn "$msg\n" if $level <= $verbosity;
…		…
734		1002
735	open my $fh, "<:raw", $path	1003	open my $fh, "<:raw", $path
736	or die "$path: $!";	1004	or die "$path: $!";
737		1005
738	my $source =	1006	my $source =
739	"package $pkg; use strict; use utf8;\n"	1007	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
740	. "#line 1 \"$path\"\n{\n"	1008	. "#line 1 \"$path\"\n{\n"
741	. (do { local $/; <$fh> })	1009	. (do { local $/; <$fh> })
742	. "\n};\n1";	1010	. "\n};\n1";
743		1011
744	eval $source	1012	eval $source
…		…
754	sub invoke {	1022	sub invoke {
755	local $TERM = shift;	1023	local $TERM = shift;
756	my $htype = shift;	1024	my $htype = shift;
757		1025
758	if ($htype == 0) { # INIT	1026	if ($htype == 0) { # INIT
759	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1027	my @dirs = $TERM->perl_libdirs;
760		1028
761	my %ext_arg;	1029	my %ext_arg;
762		1030
763	{	1031	{
764	my @init = @TERM_INIT;	1032	my @init = @TERM_INIT;
765	@TERM_INIT = ();	1033	@TERM_INIT = ();
…		…
769	$TERM->register_package ($_) for @pkg;	1037	$TERM->register_package ($_) for @pkg;
770	}	1038	}
771		1039
772	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1040	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
773	if ($_ eq "default") {	1041	if ($_ eq "default") {
774	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	1042	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
775	} elsif (/^-(.*)$/) {	1043	} elsif (/^-(.*)$/) {
776	delete $ext_arg{$1};	1044	delete $ext_arg{$1};
777	} elsif (/^([^<]+)<(.*)>$/) {	1045	} elsif (/^([^<]+)<(.*)>$/) {
778	push @{ $ext_arg{$1} }, $2;	1046	push @{ $ext_arg{$1} }, $2;
779	} else {	1047	} else {
780	$ext_arg{$_} ||= [];	1048	$ext_arg{$_} ||= [];
781	}	1049	}
782	}	1050	}
783		1051
784	while (my ($ext, $argv) = each %ext_arg) {	1052	for my $ext (sort keys %ext_arg) {
785	my @files = grep -f $_, map "$_/$ext", @dirs;	1053	my @files = grep -f $_, map "$_/$ext", @dirs;
786		1054
787	if (@files) {	1055	if (@files) {
788	$TERM->register_package (extension_package $files[0], $argv);	1056	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
789	} else {	1057	} else {
790	warn "perl extension '$ext' not found in perl library search path\n";	1058	warn "perl extension '$ext' not found in perl library search path\n";
791	}	1059	}
792	}	1060	}
793		1061
…		…
799		1067
800	if (my $cb = $TERM->{_hook}[$htype]) {	1068	if (my $cb = $TERM->{_hook}[$htype]) {
801	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1069	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
802	if $verbosity >= 10;	1070	if $verbosity >= 10;
803		1071
804	keys %$cb;	1072	for my $pkg (keys %$cb) {
805
806	while (my ($pkg, $cb) = each %$cb) {
807	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1073	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
808	$retval ||= $retval_;	1074	$retval ||= $retval_;
809		1075
810	if ($@) {	1076	if ($@) {
811	$TERM->ungrab; # better to lose the grab than the session	1077	$TERM->ungrab; # better to lose the grab than the session
812	warn $@;	1078	warn $@;
…		…
824	# clear package	1090	# clear package
825	%$TERM = ();	1091	%$TERM = ();
826	}	1092	}
827		1093
828	$retval	1094	$retval
		1095	}
		1096
		1097	sub SET_COLOR($$$) {
		1098	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1099	}
		1100
		1101	sub rend2mask {
		1102	no strict 'refs';
		1103	my ($str, $mask) = (@_, 0);
		1104	my %color = ( fg => undef, bg => undef );
		1105	my @failed;
		1106	for my $spec ( split /\s+/, $str ) {
		1107	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1108	$color{lc($1)} = $2;
		1109	} else {
		1110	my $neg = $spec =~ s/^[-^]//;
		1111	unless ( exists &{"RS_$spec"} ) {
		1112	push @failed, $spec;
		1113	next;
		1114	}
		1115	my $cur = &{"RS_$spec"};
		1116	if ( $neg ) {
		1117	$mask &= ~$cur;
		1118	} else {
		1119	$mask |= $cur;
		1120	}
		1121	}
		1122	}
		1123	($mask, @color{qw(fg bg)}, \@failed)
829	}	1124	}
830		1125
831	# urxvt::term::extension	1126	# urxvt::term::extension
832		1127
833	package urxvt::term::extension;	1128	package urxvt::term::extension;
…		…
904	is that you cannot use blocking APIs, but the non-blocking variant should	1199	is that you cannot use blocking APIs, but the non-blocking variant should
905	work.	1200	work.
906		1201
907	=cut	1202	=cut
908		1203
909	our $VERSION = 1;	1204	our $VERSION = '5.23';
910		1205
911	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1206	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
912	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1207	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
913		1208
914	sub timer {	1209	sub timer {
…		…
916		1211
917	my $cb = $arg{cb};	1212	my $cb = $arg{cb};
918		1213
919	urxvt::timer	1214	urxvt::timer
920	->new	1215	->new
921	->start (urxvt::NOW + $arg{after})	1216	->after ($arg{after}, $arg{interval})
922	->cb (sub {	1217	->cb ($arg{interval} ? $cb : sub {
923	$_[0]->stop; # need to cancel manually	1218	$_[0]->stop; # need to cancel manually
924	$cb->();	1219	$cb->();
925	})	1220	})
926	}	1221	}
927		1222
928	sub io {	1223	sub io {
929	my ($class, %arg) = @_;	1224	my ($class, %arg) = @_;
930		1225
931	my $cb = $arg{cb};	1226	my $cb = $arg{cb};
		1227	my $fd = fileno $arg{fh};
		1228	defined $fd or $fd = $arg{fh};
932		1229
933	bless [$arg{fh}, urxvt::iow	1230	bless [$arg{fh}, urxvt::iow
934	->new	1231	->new
935	->fd (fileno $arg{fh})	1232	->fd ($fd)
936	->events (($arg{poll} =~ /r/ ? 1 : 0)	1233	->events (($arg{poll} =~ /r/ ? 1 : 0)
937	| ($arg{poll} =~ /w/ ? 2 : 0))	1234	| ($arg{poll} =~ /w/ ? 2 : 0))
938	->start	1235	->start
939	->cb (sub {	1236	->cb ($cb)
940	$cb->(($_[1] & 1 ? 'r' : '')
941	. ($_[1] & 2 ? 'w' : ''));
942	})],
943	urxvt::anyevent::	1237	], urxvt::anyevent::
		1238	}
		1239
		1240	sub idle {
		1241	my ($class, %arg) = @_;
		1242
		1243	my $cb = $arg{cb};
		1244
		1245	urxvt::iw
		1246	->new
		1247	->start
		1248	->cb ($cb)
		1249	}
		1250
		1251	sub child {
		1252	my ($class, %arg) = @_;
		1253
		1254	my $cb = $arg{cb};
		1255
		1256	urxvt::pw
		1257	->new
		1258	->start ($arg{pid})
		1259	->cb (sub {
		1260	$_[0]->stop; # need to cancel manually
		1261	$cb->($_[0]->rpid, $_[0]->rstatus);
		1262	})
944	}	1263	}
945		1264
946	sub DESTROY {	1265	sub DESTROY {
947	$_[0][1]->stop;	1266	$_[0][1]->stop;
948	}	1267	}
949		1268
950	sub condvar {	1269	# only needed for AnyEvent < 6 compatibility
951	bless \my $flag, urxvt::anyevent::condvar::	1270	sub one_event {
952	}
953
954	sub urxvt::anyevent::condvar::broadcast {
955	${$_[0]}++;
956	}
957
958	sub urxvt::anyevent::condvar::wait {
959	unless (${$_[0]}) {
960	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1271	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
961	}
962	}	1272	}
963		1273
964	package urxvt::term;	1274	package urxvt::term;
965		1275
966	=head2 The C<urxvt::term> Class	1276	=head2 The C<urxvt::term> Class
…		…
993	$proxy->enable ($name => $ref);	1303	$proxy->enable ($name => $ref);
994	}	1304	}
995	}	1305	}
996	}	1306	}
997		1307
		1308	sub perl_libdirs {
		1309	map { split /:/ }
		1310	$_[0]->resource ("perl_lib"),
		1311	$ENV{URXVT_PERL_LIB},
		1312	"$ENV{HOME}/.urxvt/ext",
		1313	"$LIBDIR/perl"
		1314	}
		1315
		1316	sub scan_meta {
		1317	my ($self) = @_;
		1318	my @libdirs = perl_libdirs $self;
		1319
		1320	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1321
		1322	my %meta;
		1323
		1324	$self->{meta_libdirs} = join "\x00", @libdirs;
		1325	$self->{meta} = \%meta;
		1326
		1327	for my $dir (reverse @libdirs) {
		1328	opendir my $fh, $dir
		1329	or next;
		1330	for my $ext (readdir $fh) {
		1331	$ext ne "."
		1332	and $ext ne ".."
		1333	and open my $fh, "<", "$dir/$ext"
		1334	or next;
		1335
		1336	while (<$fh>) {
		1337	if (/^#:META:RESOURCE:(.*)/) {
		1338	my ($regex, $type, $desc) = split /:/, $1;
		1339	$regex =~ s/\$\$/$ext/g; # $$ in regex == extension name
		1340	$meta{resource}{$regex} = [$ext, $type, $desc];
		1341	} elsif (/^\s*(?:#|$)/) {
		1342	# skip other comments and empty lines
		1343	} else {
		1344	last; # stop parsing on first non-empty non-comment line
		1345	}
		1346	}
		1347	}
		1348	}
		1349	}
		1350
998	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1351	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
999		1352
1000	Creates a new terminal, very similar as if you had started it with system	1353	Creates a new terminal, very similar as if you had started it with system
1001	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1354	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1002	hash which defines the environment of the new terminal.	1355	hash which defines the environment of the new terminal.
1003		1356
1004	Croaks (and probably outputs an error message) if the new instance	1357	Croaks (and probably outputs an error message) if the new instance
1005	couldn't be created. Returns C<undef> if the new instance didn't	1358	couldn't be created. Returns C<undef> if the new instance didn't
1006	initialise perl, and the terminal object otherwise. The C<init> and	1359	initialise perl, and the terminal object otherwise. The C<init> and
1007	C<start> hooks will be called during this call.	1360	C<start> hooks will be called before this call returns, and are free to
		1361	refer to global data (which is race free).
1008		1362
1009	=cut	1363	=cut
1010		1364
1011	sub new {	1365	sub new {
1012	my ($class, $env, @args) = @_;	1366	my ($class, $env, @args) = @_;
1013		1367
		1368	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1369	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1370
1014	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1371	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1015	}	1372	}
1016		1373
1017	=item $term->destroy	1374	=item $term->destroy
1018		1375
1019	Destroy the terminal object (close the window, free resources	1376	Destroy the terminal object (close the window, free resources
…		…
1049		1406
1050	Returns true if the option specified by C<$optval> is enabled, and	1407	Returns true if the option specified by C<$optval> is enabled, and
1051	optionally change it. All option values are stored by name in the hash	1408	optionally change it. All option values are stored by name in the hash
1052	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1409	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1053		1410
1054	Here is a a likely non-exhaustive list of option names, please see the	1411	Here is a likely non-exhaustive list of option names, please see the
1055	source file F</src/optinc.h> to see the actual list:	1412	source file F</src/optinc.h> to see the actual list:
1056		1413
1057	borderLess console cursorBlink cursorUnderline hold iconic insecure	1414	borderLess buffered console cursorBlink cursorUnderline hold iconic
1058	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1415	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1059	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1416	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1060	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1417	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1061	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1418	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1062	transparent tripleclickwords utmpInhibit visualBell	1419	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1420	urgentOnBell utmpInhibit visualBell
1063		1421
1064	=item $value = $term->resource ($name[, $newval])	1422	=item $value = $term->resource ($name[, $newval])
1065		1423
1066	Returns the current resource value associated with a given name and	1424	Returns the current resource value associated with a given name and
1067	optionally sets a new value. Setting values is most useful in the C<init>	1425	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1076	likely change).	1434	likely change).
1077		1435
1078	Please note that resource strings will currently only be freed when the	1436	Please note that resource strings will currently only be freed when the
1079	terminal is destroyed, so changing options frequently will eat memory.	1437	terminal is destroyed, so changing options frequently will eat memory.
1080		1438
1081	Here is a a likely non-exhaustive list of resource names, not all of which	1439	Here is a likely non-exhaustive list of resource names, not all of which
1082	are supported in every build, please see the source file F</src/rsinc.h>	1440	are supported in every build, please see the source file F</src/rsinc.h>
1083	to see the actual list:	1441	to see the actual list:
1084		1442
1085	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1443	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1086	borderLess color cursorBlink cursorUnderline cutchars delete_key	1444	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1087	display_name embed ext_bwidth fade font geometry hold iconName	1445	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1088	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1446	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1447	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1089	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1448	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1090	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1449	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1091	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1450	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1092	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1451	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1093	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1452	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1094	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1453	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1095	secondaryScreen secondaryScroll selectstyle shade term_name title	1454	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1096	transient_for transparent transparent_all tripleclickwords utmpInhibit	1455	term_name title transient_for transparent tripleclickwords urgentOnBell
1097	visualBell	1456	utmpInhibit visualBell
1098		1457
1099	=cut	1458	=cut
1100		1459
1101	sub resource($$;$) {	1460	sub resource($$;$) {
1102	my ($self, $name) = (shift, shift);	1461	my ($self, $name) = (shift, shift);
1103	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1462	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1104	&urxvt::term::_resource	1463	goto &urxvt::term::_resource
1105	}	1464	}
1106		1465
1107	=item $value = $term->x_resource ($pattern)	1466	=item $value = $term->x_resource ($pattern)
1108		1467
1109	Returns the X-Resource for the given pattern, excluding the program or	1468	Returns the X-Resource for the given pattern, excluding the program or
…		…
1113		1472
1114	This method should only be called during the C<on_start> hook, as there is	1473	This method should only be called during the C<on_start> hook, as there is
1115	only one resource database per display, and later invocations might return	1474	only one resource database per display, and later invocations might return
1116	the wrong resources.	1475	the wrong resources.
1117		1476
1118	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1477	=item $success = $term->parse_keysym ($key, $octets)
1119		1478
1120	Adds a keymap translation exactly as specified via a resource. See the	1479	Adds a key binding exactly as specified via a resource. See the
1121	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1480	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1481
		1482	=item $term->register_command ($keysym, $modifiermask, $string)
		1483
		1484	Adds a key binding. This is a lower level api compared to
		1485	C<parse_keysym>, as it expects a parsed key description, and can be
		1486	used only inside either the C<on_init> hook, to add a binding, or the
		1487	C<on_register_command> hook, to modify a parsed binding.
1122		1488
1123	=item $rend = $term->rstyle ([$new_rstyle])	1489	=item $rend = $term->rstyle ([$new_rstyle])
1124		1490
1125	Return and optionally change the current rendition. Text that is output by	1491	Return and optionally change the current rendition. Text that is output by
1126	the terminal application will use this style.	1492	the terminal application will use this style.
…		…
1134		1500
1135	=item ($row, $col) = $term->selection_beg ([$row, $col])	1501	=item ($row, $col) = $term->selection_beg ([$row, $col])
1136		1502
1137	=item ($row, $col) = $term->selection_end ([$row, $col])	1503	=item ($row, $col) = $term->selection_end ([$row, $col])
1138		1504
1139	Return the current values of the selection mark, begin or end positions,	1505	Return the current values of the selection mark, begin or end positions.
1140	and optionally set them to new values.	1506
		1507	When arguments are given, then the selection coordinates are set to
		1508	C<$row> and C<$col>, and the selection screen is set to the current
		1509	screen.
		1510
		1511	=item $screen = $term->selection_screen ([$screen])
		1512
		1513	Returns the current selection screen, and then optionally sets it.
1141		1514
1142	=item $term->selection_make ($eventtime[, $rectangular])	1515	=item $term->selection_make ($eventtime[, $rectangular])
1143		1516
1144	Tries to make a selection as set by C<selection_beg> and	1517	Tries to make a selection as set by C<selection_beg> and
1145	C<selection_end>. If C<$rectangular> is true (default: false), a	1518	C<selection_end>. If C<$rectangular> is true (default: false), a
1146	rectangular selection will be made. This is the prefered function to make	1519	rectangular selection will be made. This is the preferred function to make
1147	a selection.	1520	a selection.
1148		1521
1149	=item $success = $term->selection_grab ($eventtime)	1522	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1150		1523
1151	Try to request the primary selection text from the server (for example, as	1524	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1525	true) selection from the server. The corresponding text can be set
1152	set by the next method). No visual feedback will be given. This function	1526	with the next method. No visual feedback will be given. This function
1153	is mostly useful from within C<on_sel_grab> hooks.	1527	is mostly useful from within C<on_sel_grab> hooks.
1154		1528
1155	=item $oldtext = $term->selection ([$newtext])	1529	=item $oldtext = $term->selection ([$newtext, $clipboard])
1156		1530
1157	Return the current selection text and optionally replace it by C<$newtext>.	1531	Return the current selection (clipboard if C<$clipboard> is true) text
		1532	and optionally replace it by C<$newtext>.
		1533
		1534	=item $term->selection_clear ([$clipboard])
		1535
		1536	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1158		1537
1159	=item $term->overlay_simple ($x, $y, $text)	1538	=item $term->overlay_simple ($x, $y, $text)
1160		1539
1161	Create a simple multi-line overlay box. See the next method for details.	1540	Create a simple multi-line overlay box. See the next method for details.
1162		1541
…		…
1192		1571
1193	The methods currently supported on C<urxvt::overlay> objects are:	1572	The methods currently supported on C<urxvt::overlay> objects are:
1194		1573
1195	=over 4	1574	=over 4
1196		1575
1197	=item $overlay->set ($x, $y, $text, $rend)	1576	=item $overlay->set ($x, $y, $text[, $rend])
1198		1577
1199	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1578	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1200	text in rxvt-unicode's special encoding and an array of rendition values	1579	text in rxvt-unicode's special encoding and an array of rendition values
1201	at a specific position inside the overlay.	1580	at a specific position inside the overlay.
		1581
		1582	If C<$rend> is missing, then the rendition will not be changed.
1202		1583
1203	=item $overlay->hide	1584	=item $overlay->hide
1204		1585
1205	If visible, hide the overlay, but do not destroy it.	1586	If visible, hide the overlay, but do not destroy it.
1206		1587
…		…
1288	locale-specific encoding of the terminal and can contain command sequences	1669	locale-specific encoding of the terminal and can contain command sequences
1289	(escape codes) that will be interpreted.	1670	(escape codes) that will be interpreted.
1290		1671
1291	=item $term->tt_write ($octets)	1672	=item $term->tt_write ($octets)
1292		1673
1293	Write the octets given in C<$data> to the tty (i.e. as program input). To	1674	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1294	pass characters instead of octets, you should convert your strings first	1675	pass characters instead of octets, you should convert your strings first
1295	to the locale-specific encoding using C<< $term->locale_encode >>.	1676	to the locale-specific encoding using C<< $term->locale_encode >>.
		1677
		1678	=item $term->tt_paste ($octets)
		1679
		1680	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1681	CR and bracketing the data with control sequences if bracketed paste mode
		1682	is set.
1296		1683
1297	=item $old_events = $term->pty_ev_events ([$new_events])	1684	=item $old_events = $term->pty_ev_events ([$new_events])
1298		1685
1299	Replaces the event mask of the pty watcher by the given event mask. Can	1686	Replaces the event mask of the pty watcher by the given event mask. Can
1300	be used to suppress input and output handling to the pty/tty. See the	1687	be used to suppress input and output handling to the pty/tty. See the
1301	description of C<< urxvt::timer->events >>. Make sure to always restore	1688	description of C<< urxvt::timer->events >>. Make sure to always restore
1302	the previous value.	1689	the previous value.
1303		1690
		1691	=item $fd = $term->pty_fd
		1692
		1693	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1694	is used.
		1695
1304	=item $windowid = $term->parent	1696	=item $windowid = $term->parent
1305		1697
1306	Return the window id of the toplevel window.	1698	Return the window id of the toplevel window.
1307		1699
1308	=item $windowid = $term->vt	1700	=item $windowid = $term->vt
…		…
1314	Adds the specified events to the vt event mask. Useful e.g. when you want	1706	Adds the specified events to the vt event mask. Useful e.g. when you want
1315	to receive pointer events all the times:	1707	to receive pointer events all the times:
1316		1708
1317	$term->vt_emask_add (urxvt::PointerMotionMask);	1709	$term->vt_emask_add (urxvt::PointerMotionMask);
1318		1710
		1711	=item $term->set_urgency ($set)
		1712
		1713	Enable/disable the urgency hint on the toplevel window.
		1714
		1715	=item $term->focus_in
		1716
		1717	=item $term->focus_out
		1718
		1719	=item $term->key_press ($state, $keycode[, $time])
		1720
		1721	=item $term->key_release ($state, $keycode[, $time])
		1722
		1723	Deliver various fake events to to terminal.
		1724
1319	=item $window_width = $term->width	1725	=item $window_width = $term->width
1320		1726
1321	=item $window_height = $term->height	1727	=item $window_height = $term->height
1322		1728
1323	=item $font_width = $term->fwidth	1729	=item $font_width = $term->fwidth
…		…
1353	=item $env = $term->env	1759	=item $env = $term->env
1354		1760
1355	Returns a copy of the environment in effect for the terminal as a hashref	1761	Returns a copy of the environment in effect for the terminal as a hashref
1356	similar to C<\%ENV>.	1762	similar to C<\%ENV>.
1357		1763
		1764	=item @envv = $term->envv
		1765
		1766	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1767
		1768	=item @argv = $term->argv
		1769
		1770	Return the argument vector as this terminal, similar to @ARGV, but
		1771	includes the program name as first element.
		1772
1358	=cut	1773	=cut
1359		1774
1360	sub env {	1775	sub env {
1361	if (my $env = $_[0]->_env) {
1362	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1776	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1363	} else {
1364	+{ %ENV }
1365	}
1366	}	1777	}
1367		1778
1368	=item $modifiermask = $term->ModLevel3Mask	1779	=item $modifiermask = $term->ModLevel3Mask
1369		1780
1370	=item $modifiermask = $term->ModMetaMask	1781	=item $modifiermask = $term->ModMetaMask
…		…
1375	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1786	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1376		1787
1377	=item $screen = $term->current_screen	1788	=item $screen = $term->current_screen
1378		1789
1379	Returns the currently displayed screen (0 primary, 1 secondary).	1790	Returns the currently displayed screen (0 primary, 1 secondary).
		1791
		1792	=item $cursor_is_hidden = $term->hidden_cursor
		1793
		1794	Returns whether the cursor is currently hidden or not.
1380		1795
1381	=item $view_start = $term->view_start ([$newvalue])	1796	=item $view_start = $term->view_start ([$newvalue])
1382		1797
1383	Returns the row number of the topmost displayed line. Maximum value is	1798	Returns the row number of the topmost displayed line. Maximum value is
1384	C<0>, which displays the normal terminal contents. Lower values scroll	1799	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1392		1807
1393	Used after changing terminal contents to display them.	1808	Used after changing terminal contents to display them.
1394		1809
1395	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1810	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1396		1811
1397	Returns the text of the entire row with number C<$row_number>. Row C<0>	1812	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1398	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1813	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1399	terminal line. The scrollback buffer starts at line C<-1> and extends to
1400	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1814	terminal line. Nothing will be returned if a nonexistent line
1401	is requested.	1815	is requested.
1402		1816
1403	If C<$new_text> is specified, it will replace characters in the current	1817	If C<$new_text> is specified, it will replace characters in the current
1404	line, starting at column C<$start_col> (default C<0>), which is useful	1818	line, starting at column C<$start_col> (default C<0>), which is useful
1405	to replace only parts of a line. The font index in the rendition will	1819	to replace only parts of a line. The font index in the rendition will
1406	automatically be updated.	1820	automatically be updated.
1407		1821
1408	C<$text> is in a special encoding: tabs and wide characters that use	1822	C<$text> is in a special encoding: tabs and wide characters that use more
1409	more than one cell when displayed are padded with C<$urxvt::NOCHAR>	1823	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1410	characters. Characters with combining characters and other characters that	1824	characters. Characters with combining characters and other characters that
1411	do not fit into the normal tetx encoding will be replaced with characters	1825	do not fit into the normal text encoding will be replaced with characters
1412	in the private use area.	1826	in the private use area.
1413		1827
1414	You have to obey this encoding when changing text. The advantage is	1828	You have to obey this encoding when changing text. The advantage is
1415	that C<substr> and similar functions work on screen cells and not on	1829	that C<substr> and similar functions work on screen cells and not on
1416	characters.	1830	characters.
…		…
1561	where one character corresponds to one screen cell. See	1975	where one character corresponds to one screen cell. See
1562	C<< $term->ROW_t >> for details.	1976	C<< $term->ROW_t >> for details.
1563		1977
1564	=item $string = $term->special_decode $text	1978	=item $string = $term->special_decode $text
1565		1979
1566	Converts rxvt-unicodes text reprsentation into a perl string. See	1980	Converts rxvt-unicodes text representation into a perl string. See
1567	C<< $term->ROW_t >> for details.	1981	C<< $term->ROW_t >> for details.
1568		1982
1569	=item $success = $term->grab_button ($button, $modifiermask)	1983	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1570		1984
		1985	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1986
1571	Registers a synchronous button grab. See the XGrabButton manpage.	1987	Register/unregister a synchronous button grab. See the XGrabButton
		1988	manpage.
1572		1989
1573	=item $success = $term->grab ($eventtime[, $sync])	1990	=item $success = $term->grab ($eventtime[, $sync])
1574		1991
1575	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1992	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1576	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1993	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1577		1994
1578	=item $term->allow_events_async	1995	=item $term->allow_events_async
1579		1996
1580	Calls XAllowEvents with AsyncBoth for the most recent grab.	1997	Calls XAllowEvents with AsyncBoth for the most recent grab.
1581		1998
…		…
1588	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2005	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1589	recent grab.	2006	recent grab.
1590		2007
1591	=item $term->ungrab	2008	=item $term->ungrab
1592		2009
1593	Calls XUngrab for the most recent grab. Is called automatically on	2010	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1594	evaluation errors, as it is better to lose the grab in the error case as	2011	evaluation errors, as it is better to lose the grab in the error case as
1595	the session.	2012	the session.
1596		2013
1597	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2014	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1598		2015
…		…
1600		2017
1601	=item @atoms = $term->XListProperties ($window)	2018	=item @atoms = $term->XListProperties ($window)
1602		2019
1603	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2020	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1604		2021
1605	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2022	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1606		2023
1607	=item $term->XDeleteProperty ($window, $property)	2024	=item $term->XDeleteProperty ($window, $property)
1608		2025
1609	=item $window = $term->DefaultRootWindow	2026	=item $window = $term->DefaultRootWindow
1610		2027
…		…
1617	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2034	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1618		2035
1619	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2036	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1620		2037
1621	=item $term->XChangeInput ($window, $add_events[, $del_events])	2038	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2039
		2040	=item $keysym = $term->XStringToKeysym ($string)
		2041
		2042	=item $string = $term->XKeysymToString ($keysym)
1622		2043
1623	Various X or X-related functions. The C<$term> object only serves as	2044	Various X or X-related functions. The C<$term> object only serves as
1624	the source of the display, otherwise those functions map more-or-less	2045	the source of the display, otherwise those functions map more-or-less
1625	directory onto the X functions of the same name.	2046	directly onto the X functions of the same name.
1626		2047
1627	=back	2048	=back
1628		2049
1629	=cut	2050	=cut
1630		2051
…		…
1694	my ($self, $text, $cb) = @_;	2115	my ($self, $text, $cb) = @_;
1695		2116
1696	$self->add_item ({ type => "button", text => $text, activate => $cb});	2117	$self->add_item ({ type => "button", text => $text, activate => $cb});
1697	}	2118	}
1698		2119
1699	=item $popup->add_toggle ($text, $cb, $initial_value)	2120	=item $popup->add_toggle ($text, $initial_value, $cb)
1700		2121
1701	Adds a toggle/checkbox item to the popup. Teh callback gets called	2122	Adds a toggle/checkbox item to the popup. The callback gets called
1702	whenever it gets toggled, with a boolean indicating its value as its first	2123	whenever it gets toggled, with a boolean indicating its new value as its
1703	argument.	2124	first argument.
1704		2125
1705	=cut	2126	=cut
1706		2127
1707	sub add_toggle {	2128	sub add_toggle {
1708	my ($self, $text, $cb, $value) = @_;	2129	my ($self, $text, $value, $cb) = @_;
1709		2130
1710	my $item; $item = {	2131	my $item; $item = {
1711	type => "button",	2132	type => "button",
1712	text => " $text",	2133	text => " $text",
1713	value => $value,	2134	value => $value,
…		…
1732	my $env = $self->{term}->env;	2153	my $env = $self->{term}->env;
1733	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2154	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1734	delete $env->{LC_ALL};	2155	delete $env->{LC_ALL};
1735	$env->{LC_CTYPE} = $self->{term}->locale;	2156	$env->{LC_CTYPE} = $self->{term}->locale;
1736		2157
1737	urxvt::term->new ($env, "popup",	2158	my $term = urxvt::term->new (
		2159	$env, "popup",
1738	"--perl-lib" => "", "--perl-ext-common" => "",	2160	"--perl-lib" => "", "--perl-ext-common" => "",
1739	"-pty-fd" => -1, "-sl" => 0,	2161	"-pty-fd" => -1, "-sl" => 0,
1740	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2162	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1741	"--transient-for" => $self->{term}->parent,	2163	"--transient-for" => $self->{term}->parent,
1742	"-display" => $self->{term}->display_id,	2164	"-display" => $self->{term}->display_id,
1743	"-pe" => "urxvt-popup")	2165	"-pe" => "urxvt-popup",
1744	or die "unable to create popup window\n";	2166	) or die "unable to create popup window\n";
		2167
		2168	unless (delete $term->{urxvt_popup_init_done}) {
		2169	$term->ungrab;
		2170	$term->destroy;
		2171	die "unable to initialise popup window\n";
		2172	}
1745	}	2173	}
1746		2174
1747	sub DESTROY {	2175	sub DESTROY {
1748	my ($self) = @_;	2176	my ($self) = @_;
1749		2177
…		…
1754	=back	2182	=back
1755		2183
1756	=cut	2184	=cut
1757		2185
1758	package urxvt::watcher;	2186	package urxvt::watcher;
1759
1760	@urxvt::timer::ISA = __PACKAGE__;
1761	@urxvt::iow::ISA = __PACKAGE__;
1762	@urxvt::pw::ISA = __PACKAGE__;
1763	@urxvt::iw::ISA = __PACKAGE__;
1764		2187
1765	=head2 The C<urxvt::timer> Class	2188	=head2 The C<urxvt::timer> Class
1766		2189
1767	This class implements timer watchers/events. Time is represented as a	2190	This class implements timer watchers/events. Time is represented as a
1768	fractional number of seconds since the epoch. Example:	2191	fractional number of seconds since the epoch. Example:
…		…
1772	->new	2195	->new
1773	->interval (1)	2196	->interval (1)
1774	->cb (sub {	2197	->cb (sub {
1775	$term->{overlay}->set (0, 0,	2198	$term->{overlay}->set (0, 0,
1776	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2199	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1777	});	2200	});
1778		2201
1779	=over 4	2202	=over 4
1780		2203
1781	=item $timer = new urxvt::timer	2204	=item $timer = new urxvt::timer
1782		2205
…		…
1785		2208
1786	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2209	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1787		2210
1788	Set the callback to be called when the timer triggers.	2211	Set the callback to be called when the timer triggers.
1789		2212
1790	=item $tstamp = $timer->at
1791
1792	Return the time this watcher will fire next.
1793
1794	=item $timer = $timer->set ($tstamp)	2213	=item $timer = $timer->set ($tstamp[, $interval])
1795		2214
1796	Set the time the event is generated to $tstamp.	2215	Set the time the event is generated to $tstamp (and optionally specifies a
		2216	new $interval).
1797		2217
1798	=item $timer = $timer->interval ($interval)	2218	=item $timer = $timer->interval ($interval)
1799		2219
1800	Normally (and when C<$interval> is C<0>), the timer will automatically	2220	By default (and when C<$interval> is C<0>), the timer will automatically
1801	stop after it has fired once. If C<$interval> is non-zero, then the timer	2221	stop after it has fired once. If C<$interval> is non-zero, then the timer
1802	is automatically rescheduled at the given intervals.	2222	is automatically rescheduled at the given intervals.
1803		2223
1804	=item $timer = $timer->start	2224	=item $timer = $timer->start
1805		2225
1806	Start the timer.	2226	Start the timer.
1807		2227
1808	=item $timer = $timer->start ($tstamp)	2228	=item $timer = $timer->start ($tstamp[, $interval])
1809		2229
1810	Set the event trigger time to C<$tstamp> and start the timer.	2230	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2231	also replaces the interval.
1811		2232
1812	=item $timer = $timer->after ($delay)	2233	=item $timer = $timer->after ($delay[, $interval])
1813		2234
1814	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2235	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1815		2236
1816	=item $timer = $timer->stop	2237	=item $timer = $timer->stop
1817		2238
…		…
1825		2246
1826	$term->{socket} = ...	2247	$term->{socket} = ...
1827	$term->{iow} = urxvt::iow	2248	$term->{iow} = urxvt::iow
1828	->new	2249	->new
1829	->fd (fileno $term->{socket})	2250	->fd (fileno $term->{socket})
1830	->events (urxvt::EVENT_READ)	2251	->events (urxvt::EV_READ)
1831	->start	2252	->start
1832	->cb (sub {	2253	->cb (sub {
1833	my ($iow, $revents) = @_;	2254	my ($iow, $revents) = @_;
1834	# $revents must be 1 here, no need to check	2255	# $revents must be 1 here, no need to check
1835	sysread $term->{socket}, my $buf, 8192	2256	sysread $term->{socket}, my $buf, 8192
…		…
1848	Set the callback to be called when io events are triggered. C<$reventmask>	2269	Set the callback to be called when io events are triggered. C<$reventmask>
1849	is a bitset as described in the C<events> method.	2270	is a bitset as described in the C<events> method.
1850		2271
1851	=item $iow = $iow->fd ($fd)	2272	=item $iow = $iow->fd ($fd)
1852		2273
1853	Set the filedescriptor (not handle) to watch.	2274	Set the file descriptor (not handle) to watch.
1854		2275
1855	=item $iow = $iow->events ($eventmask)	2276	=item $iow = $iow->events ($eventmask)
1856		2277
1857	Set the event mask to watch. The only allowed values are	2278	Set the event mask to watch. The only allowed values are
1858	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2279	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1859	together, or C<urxvt::EVENT_NONE>.	2280	together, or C<urxvt::EV_NONE>.
1860		2281
1861	=item $iow = $iow->start	2282	=item $iow = $iow->start
1862		2283
1863	Start watching for requested events on the given handle.	2284	Start watching for requested events on the given handle.
1864		2285
1865	=item $iow = $iow->stop	2286	=item $iow = $iow->stop
1866		2287
1867	Stop watching for events on the given filehandle.	2288	Stop watching for events on the given file handle.
1868		2289
1869	=back	2290	=back
1870		2291
1871	=head2 The C<urxvt::iw> Class	2292	=head2 The C<urxvt::iw> Class
1872		2293
…		…
1905	->new	2326	->new
1906	->start ($pid)	2327	->start ($pid)
1907	->cb (sub {	2328	->cb (sub {
1908	my ($pw, $exit_status) = @_;	2329	my ($pw, $exit_status) = @_;
1909	...	2330	...
1910	});	2331	});
1911		2332
1912	=over 4	2333	=over 4
1913		2334
1914	=item $pw = new urxvt::pw	2335	=item $pw = new urxvt::pw
1915		2336
…		…
1919		2340
1920	Set the callback to be called when the timer triggers.	2341	Set the callback to be called when the timer triggers.
1921		2342
1922	=item $pw = $timer->start ($pid)	2343	=item $pw = $timer->start ($pid)
1923		2344
1924	Tells the wqtcher to start watching for process C<$pid>.	2345	Tells the watcher to start watching for process C<$pid>.
1925		2346
1926	=item $pw = $pw->stop	2347	=item $pw = $pw->stop
1927		2348
1928	Stop the watcher.	2349	Stop the watcher.
1929		2350
…		…
1942		2363
1943	=item >= 3 - script loading and management	2364	=item >= 3 - script loading and management
1944		2365
1945	=item >=10 - all called hooks	2366	=item >=10 - all called hooks
1946		2367
1947	=item >=11 - hook reutrn values	2368	=item >=11 - hook return values
1948		2369
1949	=back	2370	=back
1950		2371
1951	=head1 AUTHOR	2372	=head1 AUTHOR
1952		2373
1953	Marc Lehmann <pcg@goof.com>	2374	Marc Lehmann <schmorp@schmorp.de>
1954	http://software.schmorp.de/pkg/rxvt-unicode	2375	http://software.schmorp.de/pkg/rxvt-unicode
1955		2376
1956	=cut	2377	=cut
1957		2378
1958	1	2379	1
		2380
		2381	# vim: sw=3:

Diff Legend

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