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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.118 by root, Fri Jan 20 18:50:49 2006 UTC vs.
Revision 1.217 by root, Sun Jun 10 13:58:05 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
…		…
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.
…		…
165	the message into vi commands to load the file.	223	the message into vi commands to load the file.
166		224
167	=item tabbed	225	=item tabbed
168		226
169	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
170	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
171	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
172	button per tab.	230	button per tab.
173		231
174	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
175	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,
176	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
177		235
178	=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):
179		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
180	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
181	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
182	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
183	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.
184		258
185	=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.
186		263
187	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
188	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
189	a custom pixmap. No scaling is supported in this mode. Exmaple:	266	"perl:matcher:list" as seen in the example below.
190		267
191	@@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.
192		315
193	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
194		317
195	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
196	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
197	similar-looking ascii character.	320	similar-looking ascii character.
198		321
199	=item digital-clock	322	=item digital-clock
200		323
201	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.
202		393
203	=item example-refresh-hooks	394	=item example-refresh-hooks
204		395
205	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
206	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
207	overlays or changes.	398	overlays or changes.
208		399
209	=item selection-pastebin	400	=item confirm-paste
210		401
211	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
212	textfile to a remote site (or does other things). (The implementation is	403	line is detected.
213	not currently secure for use in a multiuser environment as it writes to
214	F</tmp> directly.).
215		404
216	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	405	=item bell-command
217	i.e.
218		406
219	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:
220		410
221	Pressing this combination runs a command with C<%> replaced by the name of	411	URxvt.bell-command: notify-send "Beep, Beep"
222	the textfile. This command can be set via a resource:
223
224	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
225
226	And the default is likely not useful to anybody but the few people around
227	here :)
228
229	The name of the textfile is the hex encoded md5 sum of the selection, so
230	the same content should lead to the same filename.
231
232	After a successful upload the selection will be replaced by the text given
233	in the C<selection-pastebin-url> resource (again, the % is the placeholder
234	for the filename):
235
236	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
237		412
238	=back	413	=back
239		414
240	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
241		416
…		…
257		432
258	=over 4	433	=over 4
259		434
260	=item $text	435	=item $text
261		436
262	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
263	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.
264		439
265	=item $string	440	=item $string
266		441
267	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
…		…
271	=item $octets	446	=item $octets
272		447
273	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
274	locale-specific way.	449	locale-specific way.
275		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
276	=back	457	=back
277		458
278	=head2 Extension Objects	459	=head2 Extension Objects
279		460
280	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
281	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,
282	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
283	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
284	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
285	use.	467	internal use.
286		468
287	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
288	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
289		471
290	It has the following methods and data members:	472	It has the following methods and data members:
…		…
311	=head2 Hooks	493	=head2 Hooks
312		494
313	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
314	called whenever the relevant event happens.	496	called whenever the relevant event happens.
315		497
316	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
317	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
318		500
319	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
320	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
321	relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
…		…
334	place.	516	place.
335		517
336	=item on_start $term	518	=item on_start $term
337		519
338	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
339	trying to map (display) the toplevel and returning to the mainloop.	521	trying to map (display) the toplevel and returning to the main loop.
340		522
341	=item on_destroy $term	523	=item on_destroy $term
342		524
343	Called whenever something tries to destroy terminal, before doing anything	525	Called whenever something tries to destroy terminal, when the terminal is
344	yet. If this hook returns true, then destruction is skipped, but this is	526	still fully functional (not for long, though).
345	rarely a good idea.
346		527
347	=item on_reset $term	528	=item on_reset $term
348		529
349	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
350	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
…		…
372		553
373	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
374	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
375	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
376		557
377	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.
378		559
379	=item on_sel_extend $term	560	=item on_sel_extend $term
380		561
381	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
382	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
383	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
384	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
385	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
386	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
387		568
388	See the F<selection> example extension.	569	See the F<selection> example extension.
389		570
390	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
391		572
392	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
393	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
394	show this many lines of scrollback.	575	show this many lines of scrollback.
395		576
396	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
397		578
…		…
401		582
402	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,
403	$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
404	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
405		586
406	=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
407		598
408	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
409	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
410	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
411	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,
412	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
413	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	}
414		615
415	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,
416	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
417	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.
418		622
419	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
420		624
421	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
422	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
…		…
427	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
428		632
429	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
430	suppress or filter tty input.	634	suppress or filter tty input.
431		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
432	=item on_line_update $term, $row	643	=item on_line_update $term, $row
433		644
434	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
435	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
436	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,
…		…
443	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
444	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
445		656
446	=item on_refresh_begin $term	657	=item on_refresh_begin $term
447		658
448	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
449	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
450	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
451	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
452		663
453	=item on_refresh_end $term	664	=item on_refresh_end $term
454		665
455	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>.
456		667
457	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
458		669
459	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
460	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>
461	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.
462		689
463	=item on_x_event $term, $event	690	=item on_x_event $term, $event
464		691
465	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
466	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
467	members are not passed.	694	members are not passed.
468		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
469	=item on_focus_in $term	700	=item on_focus_in $term
470		701
471	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
472	does focus in processing.	703	does focus in processing.
473		704
474	=item on_focus_out $term	705	=item on_focus_out $term
475		706
476	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
477	focus out processing.	708	focus out processing.
478		709
479	=item on_configure_notify $term, $event	710	=item on_configure_notify $term, $event
480		711
481	=item on_property_notify $term, $event	712	=item on_property_notify $term, $event
…		…
492		723
493	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
494		725
495	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
496		727
497	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
498	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.
499		730
500	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
501	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
502	and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
503		734
504	C<on_key_press> additionally receives the string rxvt-unicode would	735	C<on_key_press> additionally receives the string rxvt-unicode would
505	output, if any, in locale-specific encoding.	736	output, if any, in locale-specific encoding.
506		737
507	subwindow.	738	subwindow.
…		…
513	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
514		745
515	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
516	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
517		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
		752
518	=back	753	=back
519		754
520	=cut	755	=cut
521		756
522	package urxvt;	757	package urxvt;
523		758
524	use utf8;	759	use utf8;
525	use strict;	760	use strict 'vars';
526	use Carp ();	761	use Carp ();
527	use Scalar::Util ();	762	use Scalar::Util ();
528	use List::Util ();	763	use List::Util ();
529		764
530	our $VERSION = 1;	765	our $VERSION = 1;
531	our $TERM;	766	our $TERM;
532	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
533	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
534	our @HOOKNAME;	769	our @HOOKNAME;
535	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
536	our %OPTION;	771	our %OPTION;
537		772
538	our $LIBDIR;	773	our $LIBDIR;
539	our $RESNAME;	774	our $RESNAME;
540	our $RESCLASS;	775	our $RESCLASS;
541	our $RXVTNAME;	776	our $RXVTNAME;
542		777
		778	our $NOCHAR = chr 0xffff;
		779
543	=head2 Variables in the C<urxvt> Package	780	=head2 Variables in the C<urxvt> Package
544		781
545	=over 4	782	=over 4
546		783
547	=item $urxvt::LIBDIR	784	=item $urxvt::LIBDIR
…		…
562	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
563	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
564		801
565	=item @urxvt::TERM_INIT	802	=item @urxvt::TERM_INIT
566		803
567	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
568	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
569	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,
570	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.
571		808
572	This complements to the perl-eval commandline option, but gets executed	809	This complements to the perl-eval command line option, but gets executed
573	first.	810	first.
574		811
575	=item @urxvt::TERM_EXT	812	=item @urxvt::TERM_EXT
576		813
577	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
…		…
584		821
585	=over 4	822	=over 4
586		823
587	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
588		825
589	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
590	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
591	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
592		830
593	=item urxvt::warn $string	831	=item urxvt::warn $string
594		832
595	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
596	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
597	that calls this function.	835	that calls this function.
598		836
599	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
600	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
601		839
602	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).
603		848
604	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
605		850
606	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
607		852
…		…
650		895
651	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
652		897
653	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
654		899
655	=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
656		902
657	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
658	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
659	the bitset.	905	the bitset.
660		906
…		…
665	Return the foreground/background colour index, respectively.	911	Return the foreground/background colour index, respectively.
666		912
667	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
668		914
669	=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
670		918
671	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
672	specified one.	920	specified one.
673		921
674	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
…		…
693	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
694	urxvt::warn ($msg);	942	urxvt::warn ($msg);
695	};	943	};
696	}	944	}
697		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
698	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1008	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
699		1009
700	sub verbose {	1010	sub verbose {
701	my ($level, $msg) = @_;	1011	my ($level, $msg) = @_;
702	warn "$msg\n" if $level <= $verbosity;	1012	warn "$msg\n" if $level <= $verbosity;
…		…
714	$pkg =~ s/[^[:word:]]/_/g;	1024	$pkg =~ s/[^[:word:]]/_/g;
715	$pkg = "urxvt::ext::$pkg";	1025	$pkg = "urxvt::ext::$pkg";
716		1026
717	verbose 3, "loading extension '$path' into package '$pkg'";	1027	verbose 3, "loading extension '$path' into package '$pkg'";
718		1028
		1029	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		1030
719	open my $fh, "<:raw", $path	1031	open my $fh, "<:raw", $path
720	or die "$path: $!";	1032	or die "$path: $!";
721		1033
722	my $source =	1034	my $source =
723	"package $pkg; use strict; use utf8;\n"	1035	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
724	. "#line 1 \"$path\"\n{\n"	1036	. "#line 1 \"$path\"\n{\n"
725	. (do { local $/; <$fh> })	1037	. (do { local $/; <$fh> })
726	. "\n};\n1";	1038	. "\n};\n1";
727		1039
728	eval $source	1040	eval $source
…		…
738	sub invoke {	1050	sub invoke {
739	local $TERM = shift;	1051	local $TERM = shift;
740	my $htype = shift;	1052	my $htype = shift;
741		1053
742	if ($htype == 0) { # INIT	1054	if ($htype == 0) { # INIT
743	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1055	my @dirs = $TERM->perl_libdirs;
744		1056
745	my %ext_arg;	1057	my %ext_arg;
746		1058
747	{	1059	{
748	my @init = @TERM_INIT;	1060	my @init = @TERM_INIT;
749	@TERM_INIT = ();	1061	@TERM_INIT = ();
…		…
751	my @pkg = @TERM_EXT;	1063	my @pkg = @TERM_EXT;
752	@TERM_EXT = ();	1064	@TERM_EXT = ();
753	$TERM->register_package ($_) for @pkg;	1065	$TERM->register_package ($_) for @pkg;
754	}	1066	}
755		1067
		1068	for (
		1069	@{ delete $TERM->{perl_ext_3} },
756	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1070	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1071	) {
757	if ($_ eq "default") {	1072	if ($_ eq "default") {
758	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	1073	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
759	} elsif (/^-(.*)$/) {	1074	} elsif (/^-(.*)$/) {
760	delete $ext_arg{$1};	1075	delete $ext_arg{$1};
761	} elsif (/^([^<]+)<(.*)>$/) {	1076	} elsif (/^([^<]+)<(.*)>$/) {
762	push @{ $ext_arg{$1} }, $2;	1077	push @{ $ext_arg{$1} }, $2;
763	} else {	1078	} else {
764	$ext_arg{$_} \|\|= [];	1079	$ext_arg{$_} \|\|= [];
765	}	1080	}
766	}	1081	}
767		1082
768	while (my ($ext, $argv) = each %ext_arg) {	1083	for my $ext (sort keys %ext_arg) {
769	my @files = grep -f $_, map "$_/$ext", @dirs;	1084	my @files = grep -f $_, map "$_/$ext", @dirs;
770		1085
771	if (@files) {	1086	if (@files) {
772	$TERM->register_package (extension_package $files[0], $argv);	1087	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
773	} else {	1088	} else {
774	warn "perl extension '$ext' not found in perl library search path\n";	1089	warn "perl extension '$ext' not found in perl library search path\n";
775	}	1090	}
776	}	1091	}
777		1092
…		…
783		1098
784	if (my $cb = $TERM->{_hook}[$htype]) {	1099	if (my $cb = $TERM->{_hook}[$htype]) {
785	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1100	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
786	if $verbosity >= 10;	1101	if $verbosity >= 10;
787		1102
788	keys %$cb;	1103	for my $pkg (keys %$cb) {
789
790	while (my ($pkg, $cb) = each %$cb) {
791	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1104	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
792	$retval \|\|= $retval_;	1105	$retval \|\|= $retval_;
793		1106
794	if ($@) {	1107	if ($@) {
795	$TERM->ungrab; # better to lose the grab than the session	1108	$TERM->ungrab; # better to lose the grab than the session
796	warn $@;	1109	warn $@;
…		…
810	}	1123	}
811		1124
812	$retval	1125	$retval
813	}	1126	}
814		1127
815	# urxvt::term::extension	1128	sub SET_COLOR($$$) {
		1129	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1130	}
		1131
		1132	sub rend2mask {
		1133	no strict 'refs';
		1134	my ($str, $mask) = (@_, 0);
		1135	my %color = ( fg => undef, bg => undef );
		1136	my @failed;
		1137	for my $spec ( split /\s+/, $str ) {
		1138	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1139	$color{lc($1)} = $2;
		1140	} else {
		1141	my $neg = $spec =~ s/^[-^]//;
		1142	unless ( exists &{"RS_$spec"} ) {
		1143	push @failed, $spec;
		1144	next;
		1145	}
		1146	my $cur = &{"RS_$spec"};
		1147	if ( $neg ) {
		1148	$mask &= ~$cur;
		1149	} else {
		1150	$mask \|= $cur;
		1151	}
		1152	}
		1153	}
		1154	($mask, @color{qw(fg bg)}, \@failed)
		1155	}
816		1156
817	package urxvt::term::extension;	1157	package urxvt::term::extension;
818		1158
819	sub enable {	1159	sub enable {
820	my ($self, %hook) = @_;	1160	my ($self, %hook) = @_;
…		…
875		1215
876	sub urxvt::destroy_hook(&) {	1216	sub urxvt::destroy_hook(&) {
877	bless \shift, urxvt::destroy_hook::	1217	bless \shift, urxvt::destroy_hook::
878	}	1218	}
879		1219
		1220	sub x_resource {
		1221	my ($self, $name) = @_;
		1222	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		1223	$self->{term}->x_resource ($name)
		1224	}
		1225
		1226	sub x_resource_boolean {
		1227	my ($self, $name) = @_;
		1228	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		1229	$self->{term}->x_resource_boolean ($name)
		1230	}
		1231
880	package urxvt::anyevent;	1232	package urxvt::anyevent;
881		1233
882	=head2 The C<urxvt::anyevent> Class	1234	=head2 The C<urxvt::anyevent> Class
883		1235
884	The sole purpose of this class is to deliver an interface to the	1236	The sole purpose of this class is to deliver an interface to the
885	C<AnyEvent> module - any module using it will work inside urxvt without	1237	C<AnyEvent> module - any module using it will work inside urxvt without
886	further programming. The only exception is that you cannot wait on	1238	further programming. The only exception is that you cannot wait on
887	condition variables, but non-blocking condvar use is ok. What this means	1239	condition variables, but non-blocking condvar use is ok.
888	is that you cannot use blocking APIs, but the non-blocking variant should	1240
889	work.	1241	In practical terms this means is that you cannot use blocking APIs, but
		1242	the non-blocking variant should work.
890		1243
891	=cut	1244	=cut
892		1245
893	our $VERSION = 1;	1246	our $VERSION = '5.23';
894		1247
895	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1248	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
896	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1249	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
897		1250
898	sub timer {	1251	sub timer {
…		…
900		1253
901	my $cb = $arg{cb};	1254	my $cb = $arg{cb};
902		1255
903	urxvt::timer	1256	urxvt::timer
904	->new	1257	->new
905	->start (urxvt::NOW + $arg{after})	1258	->after ($arg{after}, $arg{interval})
906	->cb (sub {	1259	->cb ($arg{interval} ? $cb : sub {
907	$_[0]->stop; # need to cancel manually	1260	$_[0]->stop; # need to cancel manually
908	$cb->();	1261	$cb->();
909	})	1262	})
910	}	1263	}
911		1264
912	sub io {	1265	sub io {
913	my ($class, %arg) = @_;	1266	my ($class, %arg) = @_;
914		1267
915	my $cb = $arg{cb};	1268	my $cb = $arg{cb};
		1269	my $fd = fileno $arg{fh};
		1270	defined $fd or $fd = $arg{fh};
916		1271
917	bless [$arg{fh}, urxvt::iow	1272	bless [$arg{fh}, urxvt::iow
918	->new	1273	->new
919	->fd (fileno $arg{fh})	1274	->fd ($fd)
920	->events (($arg{poll} =~ /r/ ? 1 : 0)	1275	->events (($arg{poll} =~ /r/ ? 1 : 0)
921	\| ($arg{poll} =~ /w/ ? 2 : 0))	1276	\| ($arg{poll} =~ /w/ ? 2 : 0))
922	->start	1277	->start
923	->cb (sub {	1278	->cb ($cb)
924	$cb->(($_[1] & 1 ? 'r' : '')
925	. ($_[1] & 2 ? 'w' : ''));
926	})],
927	urxvt::anyevent::	1279	], urxvt::anyevent::
		1280	}
		1281
		1282	sub idle {
		1283	my ($class, %arg) = @_;
		1284
		1285	my $cb = $arg{cb};
		1286
		1287	urxvt::iw
		1288	->new
		1289	->start
		1290	->cb ($cb)
		1291	}
		1292
		1293	sub child {
		1294	my ($class, %arg) = @_;
		1295
		1296	my $cb = $arg{cb};
		1297
		1298	urxvt::pw
		1299	->new
		1300	->start ($arg{pid})
		1301	->cb (sub {
		1302	$_[0]->stop; # need to cancel manually
		1303	$cb->($_[0]->rpid, $_[0]->rstatus);
		1304	})
928	}	1305	}
929		1306
930	sub DESTROY {	1307	sub DESTROY {
931	$_[0][1]->stop;	1308	$_[0][1]->stop;
932	}	1309	}
933		1310
934	sub condvar {	1311	# only needed for AnyEvent < 6 compatibility
935	bless \my $flag, urxvt::anyevent::condvar::	1312	sub one_event {
936	}
937
938	sub urxvt::anyevent::condvar::broadcast {
939	${$_[0]}++;
940	}
941
942	sub urxvt::anyevent::condvar::wait {
943	unless (${$_[0]}) {
944	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1313	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
945	}
946	}	1314	}
947		1315
948	package urxvt::term;	1316	package urxvt::term;
949		1317
950	=head2 The C<urxvt::term> Class	1318	=head2 The C<urxvt::term> Class
…		…
963	urxvt::verbose 6, "register package $pkg to $self";	1331	urxvt::verbose 6, "register package $pkg to $self";
964		1332
965	@{"$pkg\::ISA"} = urxvt::term::extension::;	1333	@{"$pkg\::ISA"} = urxvt::term::extension::;
966		1334
967	my $proxy = bless {	1335	my $proxy = bless {
968	_pkg => $pkg,	1336	_pkg => $pkg,
		1337	_name => ${"$pkg\::_NAME"}, # hackish
969	argv => $argv,	1338	argv => $argv,
970	}, $pkg;	1339	}, $pkg;
971	Scalar::Util::weaken ($proxy->{term} = $self);	1340	Scalar::Util::weaken ($proxy->{term} = $self);
972		1341
973	$self->{_pkg}{$pkg} = $proxy;	1342	$self->{_pkg}{$pkg} = $proxy;
974		1343
…		…
977	$proxy->enable ($name => $ref);	1346	$proxy->enable ($name => $ref);
978	}	1347	}
979	}	1348	}
980	}	1349	}
981		1350
		1351	sub perl_libdirs {
		1352	map { split /:/ }
		1353	$_[0]->resource ("perl_lib"),
		1354	$ENV{URXVT_PERL_LIB},
		1355	"$ENV{HOME}/.urxvt/ext",
		1356	"$LIBDIR/perl"
		1357	}
		1358
		1359	sub scan_meta {
		1360	my ($self) = @_;
		1361	my @libdirs = perl_libdirs $self;
		1362
		1363	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1364
		1365	my %meta;
		1366
		1367	$self->{meta_libdirs} = join "\x00", @libdirs;
		1368	$self->{meta} = \%meta;
		1369
		1370	for my $dir (reverse @libdirs) {
		1371	opendir my $fh, $dir
		1372	or next;
		1373	for my $ext (readdir $fh) {
		1374	$ext ne "."
		1375	and $ext ne ".."
		1376	and open my $fh, "<", "$dir/$ext"
		1377	or next;
		1378
		1379	while (<$fh>) {
		1380	if (/^#:META:X_RESOURCE:(.*)/) {
		1381	my ($pattern, $type, $desc) = split /:/, $1;
		1382	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1383	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1384	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1385	} else {
		1386	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1387	}
		1388	} elsif (/^\s*(?:#\|$)/) {
		1389	# skip other comments and empty lines
		1390	} else {
		1391	last; # stop parsing on first non-empty non-comment line
		1392	}
		1393	}
		1394	}
		1395	}
		1396	}
		1397
982	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1398	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
983		1399
984	Creates a new terminal, very similar as if you had started it with system	1400	Creates a new terminal, very similar as if you had started it with system
985	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1401	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
986	hash which defines the environment of the new terminal.	1402	hash which defines the environment of the new terminal.
987		1403
988	Croaks (and probably outputs an error message) if the new instance	1404	Croaks (and probably outputs an error message) if the new instance
989	couldn't be created. Returns C<undef> if the new instance didn't	1405	couldn't be created. Returns C<undef> if the new instance didn't
990	initialise perl, and the terminal object otherwise. The C<init> and	1406	initialise perl, and the terminal object otherwise. The C<init> and
991	C<start> hooks will be called during this call.	1407	C<start> hooks will be called before this call returns, and are free to
		1408	refer to global data (which is race free).
992		1409
993	=cut	1410	=cut
994		1411
995	sub new {	1412	sub new {
996	my ($class, $env, @args) = @_;	1413	my ($class, $env, @args) = @_;
997		1414
		1415	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1416	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1417
998	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1418	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
999	}	1419	}
1000		1420
1001	=item $term->destroy	1421	=item $term->destroy
1002		1422
1003	Destroy the terminal object (close the window, free resources	1423	Destroy the terminal object (close the window, free resources
…		…
1033		1453
1034	Returns true if the option specified by C<$optval> is enabled, and	1454	Returns true if the option specified by C<$optval> is enabled, and
1035	optionally change it. All option values are stored by name in the hash	1455	optionally change it. All option values are stored by name in the hash
1036	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1456	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1037		1457
1038	Here is a a likely non-exhaustive list of option names, please see the	1458	Here is a likely non-exhaustive list of option names, please see the
1039	source file F</src/optinc.h> to see the actual list:	1459	source file F</src/optinc.h> to see the actual list:
1040		1460
1041	borderLess console cursorBlink cursorUnderline hold iconic insecure	1461	borderLess buffered console cursorBlink cursorUnderline hold iconic
1042	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1462	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1043	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1463	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1044	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1464	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1045	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1465	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1046	transparent tripleclickwords utmpInhibit visualBell	1466	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1467	urgentOnBell utmpInhibit visualBell
1047		1468
1048	=item $value = $term->resource ($name[, $newval])	1469	=item $value = $term->resource ($name[, $newval])
1049		1470
1050	Returns the current resource value associated with a given name and	1471	Returns the current resource value associated with a given name and
1051	optionally sets a new value. Setting values is most useful in the C<init>	1472	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1060	likely change).	1481	likely change).
1061		1482
1062	Please note that resource strings will currently only be freed when the	1483	Please note that resource strings will currently only be freed when the
1063	terminal is destroyed, so changing options frequently will eat memory.	1484	terminal is destroyed, so changing options frequently will eat memory.
1064		1485
1065	Here is a a likely non-exhaustive list of resource names, not all of which	1486	Here is a likely non-exhaustive list of resource names, not all of which
1066	are supported in every build, please see the source file F</src/rsinc.h>	1487	are supported in every build, please see the source file F</src/rsinc.h>
1067	to see the actual list:	1488	to see the actual list:
1068		1489
1069	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1490	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1070	borderLess color cursorBlink cursorUnderline cutchars delete_key	1491	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1071	display_name embed ext_bwidth fade font geometry hold iconName	1492	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1072	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1493	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1494	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1073	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1495	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1074	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1496	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1075	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1497	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1076	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1498	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1077	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1499	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1078	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1500	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1079	secondaryScreen secondaryScroll selectstyle shade term_name title	1501	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1080	transient_for transparent transparent_all tripleclickwords utmpInhibit	1502	term_name title transient_for transparent tripleclickwords urgentOnBell
1081	visualBell	1503	utmpInhibit visualBell
1082		1504
1083	=cut	1505	=cut
1084		1506
1085	sub resource($$;$) {	1507	sub resource($$;$) {
1086	my ($self, $name) = (shift, shift);	1508	my ($self, $name) = (shift, shift);
1087	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1509	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1088	&urxvt::term::_resource	1510	goto &urxvt::term::_resource
1089	}	1511	}
1090		1512
1091	=item $value = $term->x_resource ($pattern)	1513	=item $value = $term->x_resource ($pattern)
1092		1514
1093	Returns the X-Resource for the given pattern, excluding the program or	1515	Returns the X-Resource for the given pattern, excluding the program or
1094	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1516	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1095	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1517	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1096	resource with that pattern exists.	1518	resource with that pattern exists.
1097		1519
		1520	Extensions that define extra resource or command line arguments also need
		1521	to call this method to access their values.
		1522
		1523	If the method is called on an extension object (basically, from an
		1524	extension), then the special prefix C<%.> will be replaced by the name of
		1525	the extension and a dot, and the lone string C<%> will be replcaed by the
		1526	extension name itself. This makes it possible to code extensions so you
		1527	can rename them and get a new set of commandline switches and resources
		1528	without having to change the actual code.
		1529
1098	This method should only be called during the C<on_start> hook, as there is	1530	This method should only be called during the C<on_start> hook, as there is
1099	only one resource database per display, and later invocations might return	1531	only one resource database per display, and later invocations might return
1100	the wrong resources.	1532	the wrong resources.
1101		1533
1102	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1534	=item $value = $term->x_resource_boolean ($pattern)
1103		1535
		1536	Like C<x_resource>, above, but interprets the string value as a boolean
		1537	and returns C<1> for true values, C<0> for false values and C<undef> if
		1538	the resource or option isn't specified.
		1539
		1540	You should always use this method to parse boolean resources.
		1541
		1542	=cut
		1543
		1544	sub x_resource_boolean {
		1545	my $res = &x_resource;
		1546
		1547	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1548	}
		1549
		1550	=item $success = $term->parse_keysym ($key, $octets)
		1551
1104	Adds a keymap translation exactly as specified via a resource. See the	1552	Adds a key binding exactly as specified via a resource. See the
1105	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1553	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1554
		1555	=item $term->register_command ($keysym, $modifiermask, $string)
		1556
		1557	Adds a key binding. This is a lower level api compared to
		1558	C<parse_keysym>, as it expects a parsed key description, and can be
		1559	used only inside either the C<on_init> hook, to add a binding, or the
		1560	C<on_register_command> hook, to modify a parsed binding.
1106		1561
1107	=item $rend = $term->rstyle ([$new_rstyle])	1562	=item $rend = $term->rstyle ([$new_rstyle])
1108		1563
1109	Return and optionally change the current rendition. Text that is output by	1564	Return and optionally change the current rendition. Text that is output by
1110	the terminal application will use this style.	1565	the terminal application will use this style.
…		…
1118		1573
1119	=item ($row, $col) = $term->selection_beg ([$row, $col])	1574	=item ($row, $col) = $term->selection_beg ([$row, $col])
1120		1575
1121	=item ($row, $col) = $term->selection_end ([$row, $col])	1576	=item ($row, $col) = $term->selection_end ([$row, $col])
1122		1577
1123	Return the current values of the selection mark, begin or end positions,	1578	Return the current values of the selection mark, begin or end positions.
1124	and optionally set them to new values.	1579
		1580	When arguments are given, then the selection coordinates are set to
		1581	C<$row> and C<$col>, and the selection screen is set to the current
		1582	screen.
		1583
		1584	=item $screen = $term->selection_screen ([$screen])
		1585
		1586	Returns the current selection screen, and then optionally sets it.
1125		1587
1126	=item $term->selection_make ($eventtime[, $rectangular])	1588	=item $term->selection_make ($eventtime[, $rectangular])
1127		1589
1128	Tries to make a selection as set by C<selection_beg> and	1590	Tries to make a selection as set by C<selection_beg> and
1129	C<selection_end>. If C<$rectangular> is true (default: false), a	1591	C<selection_end>. If C<$rectangular> is true (default: false), a
1130	rectangular selection will be made. This is the prefered function to make	1592	rectangular selection will be made. This is the preferred function to make
1131	a selection.	1593	a selection.
1132		1594
1133	=item $success = $term->selection_grab ($eventtime)	1595	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1134		1596
1135	Try to request the primary selection text from the server (for example, as	1597	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1598	true) selection from the server. The corresponding text can be set
1136	set by the next method). No visual feedback will be given. This function	1599	with the next method. No visual feedback will be given. This function
1137	is mostly useful from within C<on_sel_grab> hooks.	1600	is mostly useful from within C<on_sel_grab> hooks.
1138		1601
1139	=item $oldtext = $term->selection ([$newtext])	1602	=item $oldtext = $term->selection ([$newtext, $clipboard])
1140		1603
1141	Return the current selection text and optionally replace it by C<$newtext>.	1604	Return the current selection (clipboard if C<$clipboard> is true) text
		1605	and optionally replace it by C<$newtext>.
		1606
		1607	=item $term->selection_clear ([$clipboard])
		1608
		1609	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1142		1610
1143	=item $term->overlay_simple ($x, $y, $text)	1611	=item $term->overlay_simple ($x, $y, $text)
1144		1612
1145	Create a simple multi-line overlay box. See the next method for details.	1613	Create a simple multi-line overlay box. See the next method for details.
1146		1614
…		…
1176		1644
1177	The methods currently supported on C<urxvt::overlay> objects are:	1645	The methods currently supported on C<urxvt::overlay> objects are:
1178		1646
1179	=over 4	1647	=over 4
1180		1648
1181	=item $overlay->set ($x, $y, $text, $rend)	1649	=item $overlay->set ($x, $y, $text[, $rend])
1182		1650
1183	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1651	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1184	text in rxvt-unicode's special encoding and an array of rendition values	1652	text in rxvt-unicode's special encoding and an array of rendition values
1185	at a specific position inside the overlay.	1653	at a specific position inside the overlay.
		1654
		1655	If C<$rend> is missing, then the rendition will not be changed.
1186		1656
1187	=item $overlay->hide	1657	=item $overlay->hide
1188		1658
1189	If visible, hide the overlay, but do not destroy it.	1659	If visible, hide the overlay, but do not destroy it.
1190		1660
…		…
1260		1730
1261	Normally its not a good idea to use this function, as programs might be	1731	Normally its not a good idea to use this function, as programs might be
1262	confused by changes in cursor position or scrolling. Its useful inside a	1732	confused by changes in cursor position or scrolling. Its useful inside a
1263	C<on_add_lines> hook, though.	1733	C<on_add_lines> hook, though.
1264		1734
		1735	=item $term->scr_change_screen ($screen)
		1736
		1737	Switch to given screen - 0 primary, 1 secondary.
		1738
1265	=item $term->cmd_parse ($octets)	1739	=item $term->cmd_parse ($octets)
1266		1740
1267	Similar to C<scr_add_lines>, but the argument must be in the	1741	Similar to C<scr_add_lines>, but the argument must be in the
1268	locale-specific encoding of the terminal and can contain command sequences	1742	locale-specific encoding of the terminal and can contain command sequences
1269	(escape codes) that will be interpreted.	1743	(escape codes) that will be interpreted.
1270		1744
1271	=item $term->tt_write ($octets)	1745	=item $term->tt_write ($octets)
1272		1746
1273	Write the octets given in C<$data> to the tty (i.e. as program input). To	1747	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1274	pass characters instead of octets, you should convert your strings first	1748	pass characters instead of octets, you should convert your strings first
1275	to the locale-specific encoding using C<< $term->locale_encode >>.	1749	to the locale-specific encoding using C<< $term->locale_encode >>.
		1750
		1751	=item $term->tt_paste ($octets)
		1752
		1753	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1754	CR and bracketing the data with control sequences if bracketed paste mode
		1755	is set.
1276		1756
1277	=item $old_events = $term->pty_ev_events ([$new_events])	1757	=item $old_events = $term->pty_ev_events ([$new_events])
1278		1758
1279	Replaces the event mask of the pty watcher by the given event mask. Can	1759	Replaces the event mask of the pty watcher by the given event mask. Can
1280	be used to suppress input and output handling to the pty/tty. See the	1760	be used to suppress input and output handling to the pty/tty. See the
1281	description of C<< urxvt::timer->events >>. Make sure to always restore	1761	description of C<< urxvt::timer->events >>. Make sure to always restore
1282	the previous value.	1762	the previous value.
1283		1763
		1764	=item $fd = $term->pty_fd
		1765
		1766	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1767	is used.
		1768
1284	=item $windowid = $term->parent	1769	=item $windowid = $term->parent
1285		1770
1286	Return the window id of the toplevel window.	1771	Return the window id of the toplevel window.
1287		1772
1288	=item $windowid = $term->vt	1773	=item $windowid = $term->vt
…		…
1294	Adds the specified events to the vt event mask. Useful e.g. when you want	1779	Adds the specified events to the vt event mask. Useful e.g. when you want
1295	to receive pointer events all the times:	1780	to receive pointer events all the times:
1296		1781
1297	$term->vt_emask_add (urxvt::PointerMotionMask);	1782	$term->vt_emask_add (urxvt::PointerMotionMask);
1298		1783
		1784	=item $term->set_urgency ($set)
		1785
		1786	Enable/disable the urgency hint on the toplevel window.
		1787
		1788	=item $term->focus_in
		1789
		1790	=item $term->focus_out
		1791
		1792	=item $term->key_press ($state, $keycode[, $time])
		1793
		1794	=item $term->key_release ($state, $keycode[, $time])
		1795
		1796	Deliver various fake events to to terminal.
		1797
1299	=item $window_width = $term->width	1798	=item $window_width = $term->width
1300		1799
1301	=item $window_height = $term->height	1800	=item $window_height = $term->height
1302		1801
1303	=item $font_width = $term->fwidth	1802	=item $font_width = $term->fwidth
…		…
1333	=item $env = $term->env	1832	=item $env = $term->env
1334		1833
1335	Returns a copy of the environment in effect for the terminal as a hashref	1834	Returns a copy of the environment in effect for the terminal as a hashref
1336	similar to C<\%ENV>.	1835	similar to C<\%ENV>.
1337		1836
		1837	=item @envv = $term->envv
		1838
		1839	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1840
		1841	=item @argv = $term->argv
		1842
		1843	Return the argument vector as this terminal, similar to @ARGV, but
		1844	includes the program name as first element.
		1845
1338	=cut	1846	=cut
1339		1847
1340	sub env {	1848	sub env {
1341	if (my $env = $_[0]->_env) {
1342	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1849	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1343	} else {
1344	+{ %ENV }
1345	}
1346	}	1850	}
1347		1851
1348	=item $modifiermask = $term->ModLevel3Mask	1852	=item $modifiermask = $term->ModLevel3Mask
1349		1853
1350	=item $modifiermask = $term->ModMetaMask	1854	=item $modifiermask = $term->ModMetaMask
1351		1855
1352	=item $modifiermask = $term->ModNumLockMask	1856	=item $modifiermask = $term->ModNumLockMask
1353		1857
1354	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1858	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1355	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1859	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1860
		1861	=item $screen = $term->current_screen
		1862
		1863	Returns the currently displayed screen (0 primary, 1 secondary).
		1864
		1865	=item $cursor_is_hidden = $term->hidden_cursor
		1866
		1867	Returns whether the cursor is currently hidden or not.
1356		1868
1357	=item $view_start = $term->view_start ([$newvalue])	1869	=item $view_start = $term->view_start ([$newvalue])
1358		1870
1359	Returns the row number of the topmost displayed line. Maximum value is	1871	Returns the row number of the topmost displayed line. Maximum value is
1360	C<0>, which displays the normal terminal contents. Lower values scroll	1872	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1368		1880
1369	Used after changing terminal contents to display them.	1881	Used after changing terminal contents to display them.
1370		1882
1371	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1883	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1372		1884
1373	Returns the text of the entire row with number C<$row_number>. Row C<0>	1885	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1374	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1886	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1375	terminal line. The scrollback buffer starts at line C<-1> and extends to
1376	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1887	terminal line. Nothing will be returned if a nonexistent line
1377	is requested.	1888	is requested.
1378		1889
1379	If C<$new_text> is specified, it will replace characters in the current	1890	If C<$new_text> is specified, it will replace characters in the current
1380	line, starting at column C<$start_col> (default C<0>), which is useful	1891	line, starting at column C<$start_col> (default C<0>), which is useful
1381	to replace only parts of a line. The font index in the rendition will	1892	to replace only parts of a line. The font index in the rendition will
1382	automatically be updated.	1893	automatically be updated.
1383		1894
1384	C<$text> is in a special encoding: tabs and wide characters that use more	1895	C<$text> is in a special encoding: tabs and wide characters that use more
1385	than one cell when displayed are padded with urxvt::NOCHAR characters	1896	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1386	(C<chr 65535>). Characters with combining characters and other characters	1897	characters. Characters with combining characters and other characters that
1387	that do not fit into the normal tetx encoding will be replaced with	1898	do not fit into the normal text encoding will be replaced with characters
1388	characters in the private use area.	1899	in the private use area.
1389		1900
1390	You have to obey this encoding when changing text. The advantage is	1901	You have to obey this encoding when changing text. The advantage is
1391	that C<substr> and similar functions work on screen cells and not on	1902	that C<substr> and similar functions work on screen cells and not on
1392	characters.	1903	characters.
1393		1904
…		…
1537	where one character corresponds to one screen cell. See	2048	where one character corresponds to one screen cell. See
1538	C<< $term->ROW_t >> for details.	2049	C<< $term->ROW_t >> for details.
1539		2050
1540	=item $string = $term->special_decode $text	2051	=item $string = $term->special_decode $text
1541		2052
1542	Converts rxvt-unicodes text reprsentation into a perl string. See	2053	Converts rxvt-unicodes text representation into a perl string. See
1543	C<< $term->ROW_t >> for details.	2054	C<< $term->ROW_t >> for details.
1544		2055
1545	=item $success = $term->grab_button ($button, $modifiermask)	2056	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1546		2057
		2058	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2059
1547	Registers a synchronous button grab. See the XGrabButton manpage.	2060	Register/unregister a synchronous button grab. See the XGrabButton
		2061	manpage.
1548		2062
1549	=item $success = $term->grab ($eventtime[, $sync])	2063	=item $success = $term->grab ($eventtime[, $sync])
1550		2064
1551	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2065	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1552	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2066	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1553		2067
1554	=item $term->allow_events_async	2068	=item $term->allow_events_async
1555		2069
1556	Calls XAllowEvents with AsyncBoth for the most recent grab.	2070	Calls XAllowEvents with AsyncBoth for the most recent grab.
1557		2071
…		…
1564	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2078	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1565	recent grab.	2079	recent grab.
1566		2080
1567	=item $term->ungrab	2081	=item $term->ungrab
1568		2082
1569	Calls XUngrab for the most recent grab. Is called automatically on	2083	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1570	evaluation errors, as it is better to lose the grab in the error case as	2084	evaluation errors, as it is better to lose the grab in the error case as
1571	the session.	2085	the session.
		2086
		2087	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		2088
		2089	=item $atom_name = $term->XGetAtomName ($atom)
		2090
		2091	=item @atoms = $term->XListProperties ($window)
		2092
		2093	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		2094
		2095	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		2096
		2097	=item $term->XDeleteProperty ($window, $property)
		2098
		2099	=item $window = $term->DefaultRootWindow
		2100
		2101	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		2102
		2103	=item $term->XMapWindow ($window)
		2104
		2105	=item $term->XUnmapWindow ($window)
		2106
		2107	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		2108
		2109	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		2110
		2111	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2112
		2113	=item $keysym = $term->XStringToKeysym ($string)
		2114
		2115	=item $string = $term->XKeysymToString ($keysym)
		2116
		2117	Various X or X-related functions. The C<$term> object only serves as
		2118	the source of the display, otherwise those functions map more-or-less
		2119	directly onto the X functions of the same name.
1572		2120
1573	=back	2121	=back
1574		2122
1575	=cut	2123	=cut
1576		2124
…		…
1640	my ($self, $text, $cb) = @_;	2188	my ($self, $text, $cb) = @_;
1641		2189
1642	$self->add_item ({ type => "button", text => $text, activate => $cb});	2190	$self->add_item ({ type => "button", text => $text, activate => $cb});
1643	}	2191	}
1644		2192
1645	=item $popup->add_toggle ($text, $cb, $initial_value)	2193	=item $popup->add_toggle ($text, $initial_value, $cb)
1646		2194
1647	Adds a toggle/checkbox item to the popup. Teh callback gets called	2195	Adds a toggle/checkbox item to the popup. The callback gets called
1648	whenever it gets toggled, with a boolean indicating its value as its first	2196	whenever it gets toggled, with a boolean indicating its new value as its
1649	argument.	2197	first argument.
1650		2198
1651	=cut	2199	=cut
1652		2200
1653	sub add_toggle {	2201	sub add_toggle {
1654	my ($self, $text, $cb, $value) = @_;	2202	my ($self, $text, $value, $cb) = @_;
1655		2203
1656	my $item; $item = {	2204	my $item; $item = {
1657	type => "button",	2205	type => "button",
1658	text => " $text",	2206	text => " $text",
1659	value => $value,	2207	value => $value,
…		…
1678	my $env = $self->{term}->env;	2226	my $env = $self->{term}->env;
1679	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2227	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1680	delete $env->{LC_ALL};	2228	delete $env->{LC_ALL};
1681	$env->{LC_CTYPE} = $self->{term}->locale;	2229	$env->{LC_CTYPE} = $self->{term}->locale;
1682		2230
1683	urxvt::term->new ($env, "popup",	2231	my $term = urxvt::term->new (
		2232	$env, "popup",
1684	"--perl-lib" => "", "--perl-ext-common" => "",	2233	"--perl-lib" => "", "--perl-ext-common" => "",
1685	"-pty-fd" => -1, "-sl" => 0,	2234	"-pty-fd" => -1, "-sl" => 0,
1686	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2235	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1687	"--transient-for" => $self->{term}->parent,	2236	"--transient-for" => $self->{term}->parent,
1688	"-display" => $self->{term}->display_id,	2237	"-display" => $self->{term}->display_id,
1689	"-pe" => "urxvt-popup")	2238	"-pe" => "urxvt-popup",
1690	or die "unable to create popup window\n";	2239	) or die "unable to create popup window\n";
		2240
		2241	unless (delete $term->{urxvt_popup_init_done}) {
		2242	$term->ungrab;
		2243	$term->destroy;
		2244	die "unable to initialise popup window\n";
		2245	}
1691	}	2246	}
1692		2247
1693	sub DESTROY {	2248	sub DESTROY {
1694	my ($self) = @_;	2249	my ($self) = @_;
1695		2250
…		…
1700	=back	2255	=back
1701		2256
1702	=cut	2257	=cut
1703		2258
1704	package urxvt::watcher;	2259	package urxvt::watcher;
1705
1706	@urxvt::timer::ISA = __PACKAGE__;
1707	@urxvt::iow::ISA = __PACKAGE__;
1708	@urxvt::pw::ISA = __PACKAGE__;
1709	@urxvt::iw::ISA = __PACKAGE__;
1710		2260
1711	=head2 The C<urxvt::timer> Class	2261	=head2 The C<urxvt::timer> Class
1712		2262
1713	This class implements timer watchers/events. Time is represented as a	2263	This class implements timer watchers/events. Time is represented as a
1714	fractional number of seconds since the epoch. Example:	2264	fractional number of seconds since the epoch. Example:
…		…
1718	->new	2268	->new
1719	->interval (1)	2269	->interval (1)
1720	->cb (sub {	2270	->cb (sub {
1721	$term->{overlay}->set (0, 0,	2271	$term->{overlay}->set (0, 0,
1722	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2272	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1723	});	2273	});
1724		2274
1725	=over 4	2275	=over 4
1726		2276
1727	=item $timer = new urxvt::timer	2277	=item $timer = new urxvt::timer
1728		2278
…		…
1731		2281
1732	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2282	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1733		2283
1734	Set the callback to be called when the timer triggers.	2284	Set the callback to be called when the timer triggers.
1735		2285
1736	=item $tstamp = $timer->at
1737
1738	Return the time this watcher will fire next.
1739
1740	=item $timer = $timer->set ($tstamp)	2286	=item $timer = $timer->set ($tstamp[, $interval])
1741		2287
1742	Set the time the event is generated to $tstamp.	2288	Set the time the event is generated to $tstamp (and optionally specifies a
		2289	new $interval).
1743		2290
1744	=item $timer = $timer->interval ($interval)	2291	=item $timer = $timer->interval ($interval)
1745		2292
1746	Normally (and when C<$interval> is C<0>), the timer will automatically	2293	By default (and when C<$interval> is C<0>), the timer will automatically
1747	stop after it has fired once. If C<$interval> is non-zero, then the timer	2294	stop after it has fired once. If C<$interval> is non-zero, then the timer
1748	is automatically rescheduled at the given intervals.	2295	is automatically rescheduled at the given intervals.
1749		2296
1750	=item $timer = $timer->start	2297	=item $timer = $timer->start
1751		2298
1752	Start the timer.	2299	Start the timer.
1753		2300
1754	=item $timer = $timer->start ($tstamp)	2301	=item $timer = $timer->start ($tstamp[, $interval])
1755		2302
1756	Set the event trigger time to C<$tstamp> and start the timer.	2303	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2304	also replaces the interval.
1757		2305
1758	=item $timer = $timer->after ($delay)	2306	=item $timer = $timer->after ($delay[, $interval])
1759		2307
1760	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2308	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1761		2309
1762	=item $timer = $timer->stop	2310	=item $timer = $timer->stop
1763		2311
…		…
1771		2319
1772	$term->{socket} = ...	2320	$term->{socket} = ...
1773	$term->{iow} = urxvt::iow	2321	$term->{iow} = urxvt::iow
1774	->new	2322	->new
1775	->fd (fileno $term->{socket})	2323	->fd (fileno $term->{socket})
1776	->events (urxvt::EVENT_READ)	2324	->events (urxvt::EV_READ)
1777	->start	2325	->start
1778	->cb (sub {	2326	->cb (sub {
1779	my ($iow, $revents) = @_;	2327	my ($iow, $revents) = @_;
1780	# $revents must be 1 here, no need to check	2328	# $revents must be 1 here, no need to check
1781	sysread $term->{socket}, my $buf, 8192	2329	sysread $term->{socket}, my $buf, 8192
…		…
1794	Set the callback to be called when io events are triggered. C<$reventmask>	2342	Set the callback to be called when io events are triggered. C<$reventmask>
1795	is a bitset as described in the C<events> method.	2343	is a bitset as described in the C<events> method.
1796		2344
1797	=item $iow = $iow->fd ($fd)	2345	=item $iow = $iow->fd ($fd)
1798		2346
1799	Set the filedescriptor (not handle) to watch.	2347	Set the file descriptor (not handle) to watch.
1800		2348
1801	=item $iow = $iow->events ($eventmask)	2349	=item $iow = $iow->events ($eventmask)
1802		2350
1803	Set the event mask to watch. The only allowed values are	2351	Set the event mask to watch. The only allowed values are
1804	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2352	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1805	together, or C<urxvt::EVENT_NONE>.	2353	together, or C<urxvt::EV_NONE>.
1806		2354
1807	=item $iow = $iow->start	2355	=item $iow = $iow->start
1808		2356
1809	Start watching for requested events on the given handle.	2357	Start watching for requested events on the given handle.
1810		2358
1811	=item $iow = $iow->stop	2359	=item $iow = $iow->stop
1812		2360
1813	Stop watching for events on the given filehandle.	2361	Stop watching for events on the given file handle.
1814		2362
1815	=back	2363	=back
1816		2364
1817	=head2 The C<urxvt::iw> Class	2365	=head2 The C<urxvt::iw> Class
1818		2366
…		…
1851	->new	2399	->new
1852	->start ($pid)	2400	->start ($pid)
1853	->cb (sub {	2401	->cb (sub {
1854	my ($pw, $exit_status) = @_;	2402	my ($pw, $exit_status) = @_;
1855	...	2403	...
1856	});	2404	});
1857		2405
1858	=over 4	2406	=over 4
1859		2407
1860	=item $pw = new urxvt::pw	2408	=item $pw = new urxvt::pw
1861		2409
…		…
1865		2413
1866	Set the callback to be called when the timer triggers.	2414	Set the callback to be called when the timer triggers.
1867		2415
1868	=item $pw = $timer->start ($pid)	2416	=item $pw = $timer->start ($pid)
1869		2417
1870	Tells the wqtcher to start watching for process C<$pid>.	2418	Tells the watcher to start watching for process C<$pid>.
1871		2419
1872	=item $pw = $pw->stop	2420	=item $pw = $pw->stop
1873		2421
1874	Stop the watcher.	2422	Stop the watcher.
1875		2423
…		…
1888		2436
1889	=item >= 3 - script loading and management	2437	=item >= 3 - script loading and management
1890		2438
1891	=item >=10 - all called hooks	2439	=item >=10 - all called hooks
1892		2440
1893	=item >=11 - hook reutrn values	2441	=item >=11 - hook return values
1894		2442
1895	=back	2443	=back
1896		2444
1897	=head1 AUTHOR	2445	=head1 AUTHOR
1898		2446
1899	Marc Lehmann <pcg@goof.com>	2447	Marc Lehmann <schmorp@schmorp.de>
1900	http://software.schmorp.de/pkg/rxvt-unicode	2448	http://software.schmorp.de/pkg/rxvt-unicode
1901		2449
1902	=cut	2450	=cut
1903		2451
1904	1	2452	1
		2453
		2454	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.118 by root, Fri Jan 20 18:50:49 2006 UTC vs. Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.118 by root, Fri Jan 20 18:50:49 2006 UTC vs.
Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC