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.105 by root, Wed Jan 18 19:43:51 2006 UTC vs.
Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC

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

Diff Legend

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