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.106 by root, Wed Jan 18 19:44:22 2006 UTC vs.
Revision 1.206 by root, Tue Jun 5 21:06:15 2012 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	71	between two vertical bars:
65		72
66	URxvt.selection.pattern-0: \\|([^|]+)\\|	73	URxvt.selection.pattern-0: \\|([^|]+)\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
67		81
68	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
83	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
84		98
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.	100	runtime.
87		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
88	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
89		120
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
93		124
94	Other extensions can extend this popup menu by pushing a code reference onto	125	Other extensions can extend this popup menu by pushing a code reference
95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
96		128
97	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
98	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
99	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
100	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
101	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
102		134
103	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
104	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	137	C<a>s:
106		138
107	push urxvt::ext::selection_popup::hook, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
109	: ()	141	: ()
110	};	142	};
111		143
112	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
113		145
…		…
120	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
121	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
122	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
123	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
124	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
125	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
126		189
127	=item selection-autotransform	190	=item selection-autotransform
128		191
129	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
130	whenever a selection is made.	193	whenever a selection is made.
…		…
143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144		207
145	And this example matches the same,but replaces it with vi-commands you can	208	And this example matches the same,but replaces it with vi-commands you can
146	paste directly into your (vi :) editor:	209	paste directly into your (vi :) editor:
147		210
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149		212
150	Of course, this can be modified to suit your needs and your editor :)	213	Of course, this can be modified to suit your needs and your editor :)
151		214
152	To expand the example above to typical perl error messages ("XXX at	215	To expand the example above to typical perl error messages ("XXX at
153	FILENAME line YYY."), you need a slightly more elaborate solution:	216	FILENAME line YYY."), you need a slightly more elaborate solution:
154		217
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157		220
158	The first line tells the selection code to treat the unchanging part of	221	The first line tells the selection code to treat the unchanging part of
159	every error message as a selection pattern, and the second line transforms	222	every error message as a selection pattern, and the second line transforms
160	the message into vi commands to load the file.	223	the message into vi commands to load the file.
161		224
162	=item mark-urls	225	=item tabbed
163		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
164	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
165	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
166	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
167	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
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_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.
430		689
431	=item on_x_event $term, $event	690	=item on_x_event $term, $event
432		691
433	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
434	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
435	members are not passed.	694	members are not passed.
436		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
437	=item on_focus_in $term	700	=item on_focus_in $term
438		701
439	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
440	does focus in processing.	703	does focus in processing.
441		704
442	=item on_focus_out $term	705	=item on_focus_out $term
443		706
444	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
445	focus out processing.	708	focus out processing.
446		709
447	=item on_configure_notify $term, $event	710	=item on_configure_notify $term, $event
448		711
		712	=item on_property_notify $term, $event
		713
449	=item on_key_press $term, $event, $keysym, $octets	714	=item on_key_press $term, $event, $keysym, $octets
450		715
451	=item on_key_release $term, $event, $keysym	716	=item on_key_release $term, $event, $keysym
452		717
453	=item on_button_press $term, $event	718	=item on_button_press $term, $event
…		…
458		723
459	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
460		725
461	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
462		727
463	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
464	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.
465		730
466	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
467	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
468	and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
469		734
470	C<on_key_press> additionally receives the string rxvt-unicode would	735	C<on_key_press> additionally receives the string rxvt-unicode would
471	output, if any, in locale-specific encoding.	736	output, if any, in locale-specific encoding.
472		737
473	subwindow.	738	subwindow.
		739
		740	=item on_client_message $term, $event
		741
		742	=item on_wm_protocols $term, $event
		743
		744	=item on_wm_delete_window $term, $event
		745
		746	Called when various types of ClientMessage events are received (all with
		747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
474		752
475	=back	753	=back
476		754
477	=cut	755	=cut
478		756
…		…
484	use Scalar::Util ();	762	use Scalar::Util ();
485	use List::Util ();	763	use List::Util ();
486		764
487	our $VERSION = 1;	765	our $VERSION = 1;
488	our $TERM;	766	our $TERM;
		767	our @TERM_INIT;
		768	our @TERM_EXT;
489	our @HOOKNAME;	769	our @HOOKNAME;
490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491	our %OPTION;	771	our %OPTION;
492		772
493	our $LIBDIR;	773	our $LIBDIR;
494	our $RESNAME;	774	our $RESNAME;
495	our $RESCLASS;	775	our $RESCLASS;
496	our $RXVTNAME;	776	our $RXVTNAME;
497		777
		778	our $NOCHAR = chr 0xffff;
		779
498	=head2 Variables in the C<urxvt> Package	780	=head2 Variables in the C<urxvt> Package
499		781
500	=over 4	782	=over 4
501		783
502	=item $urxvt::LIBDIR	784	=item $urxvt::LIBDIR
…		…
515	=item $urxvt::TERM	797	=item $urxvt::TERM
516		798
517	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
518	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
519		801
		802	=item @urxvt::TERM_INIT
		803
		804	All code references in this array will be called as methods of the next newly
		805	created C<urxvt::term> object (during the C<on_init> phase). The array
		806	gets cleared before the code references that were in it are being executed,
		807	so references can push themselves onto it again if they so desire.
		808
		809	This complements to the perl-eval command line option, but gets executed
		810	first.
		811
		812	=item @urxvt::TERM_EXT
		813
		814	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		815	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		816	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		817
520	=back	818	=back
521		819
522	=head2 Functions in the C<urxvt> Package	820	=head2 Functions in the C<urxvt> Package
523		821
524	=over 4	822	=over 4
525		823
526	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
527		825
528	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
529	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
530	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
531		830
532	=item urxvt::warn $string	831	=item urxvt::warn $string
533		832
534	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
535	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
536	that calls this function.	835	that calls this function.
537		836
538	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
539	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
540		839
541	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).
542		848
543	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
544		850
545	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
546		852
…		…
589		895
590	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
591		897
592	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
593		899
594	=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
595		902
596	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
597	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
598	the bitset.	905	the bitset.
599		906
…		…
604	Return the foreground/background colour index, respectively.	911	Return the foreground/background colour index, respectively.
605		912
606	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
607		914
608	=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
609		918
610	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
611	specified one.	920	specified one.
612		921
613	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
…		…
630	my $msg = join "", @_;	939	my $msg = join "", @_;
631	$msg .= "\n"	940	$msg .= "\n"
632	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
633	urxvt::warn ($msg);	942	urxvt::warn ($msg);
634	};	943	};
		944	}
635		945
636	# %ENV is the original startup environment	946	no warnings 'utf8';
637	delete $ENV{IFS};	947
638	delete $ENV{CDPATH};	948	sub resource {
639	delete $ENV{BASH_ENV};	949	my ($term, $name, $isarg, $flag, $value) = @_;
640	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	950
		951	warn "resourece<@_>\n";#d#
		952
		953	0
641	}	954	}
642		955
643	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	956	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
644		957
645	sub verbose {	958	sub verbose {
…		…
650	my %extension_pkg;	963	my %extension_pkg;
651		964
652	# load a single script into its own package, once only	965	# load a single script into its own package, once only
653	sub extension_package($) {	966	sub extension_package($) {
654	my ($path) = @_;	967	my ($path) = @_;
655
656	no strict 'refs';
657		968
658	$extension_pkg{$path} ||= do {	969	$extension_pkg{$path} ||= do {
659	$path =~ /([^\/\\]+)$/;	970	$path =~ /([^\/\\]+)$/;
660	my $pkg = $1;	971	my $pkg = $1;
661	$pkg =~ s/[^[:word:]]/_/g;	972	$pkg =~ s/[^[:word:]]/_/g;
…		…
664	verbose 3, "loading extension '$path' into package '$pkg'";	975	verbose 3, "loading extension '$path' into package '$pkg'";
665		976
666	open my $fh, "<:raw", $path	977	open my $fh, "<:raw", $path
667	or die "$path: $!";	978	or die "$path: $!";
668		979
669	@{"$pkg\::ISA"} = urxvt::term::extension::;
670
671	my $source =	980	my $source =
672	"package $pkg; use strict; use utf8;\n"	981	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
673	. "#line 1 \"$path\"\n{\n"	982	. "#line 1 \"$path\"\n{\n"
674	. (do { local $/; <$fh> })	983	. (do { local $/; <$fh> })
675	. "\n};\n1";	984	. "\n};\n1";
676		985
677	eval $source	986	eval $source
…		…
687	sub invoke {	996	sub invoke {
688	local $TERM = shift;	997	local $TERM = shift;
689	my $htype = shift;	998	my $htype = shift;
690		999
691	if ($htype == 0) { # INIT	1000	if ($htype == 0) { # INIT
692	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1001	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
693		1002
694	my %ext_arg;	1003	my %ext_arg;
695		1004
		1005	{
		1006	my @init = @TERM_INIT;
		1007	@TERM_INIT = ();
		1008	$_->($TERM) for @init;
		1009	my @pkg = @TERM_EXT;
		1010	@TERM_EXT = ();
		1011	$TERM->register_package ($_) for @pkg;
		1012	}
		1013
696	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1014	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
697	if ($_ eq "default") {	1015	if ($_ eq "default") {
698	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	1016	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
699	} elsif (/^-(.*)$/) {	1017	} elsif (/^-(.*)$/) {
700	delete $ext_arg{$1};	1018	delete $ext_arg{$1};
701	} elsif (/^([^<]+)<(.*)>$/) {	1019	} elsif (/^([^<]+)<(.*)>$/) {
702	push @{ $ext_arg{$1} }, $2;	1020	push @{ $ext_arg{$1} }, $2;
703	} else {	1021	} else {
704	$ext_arg{$_} ||= [];	1022	$ext_arg{$_} ||= [];
705	}	1023	}
706	}	1024	}
707		1025
708	while (my ($ext, $argv) = each %ext_arg) {	1026	for my $ext (sort keys %ext_arg) {
709	my @files = grep -f $_, map "$_/$ext", @dirs;	1027	my @files = grep -f $_, map "$_/$ext", @dirs;
710		1028
711	if (@files) {	1029	if (@files) {
712	$TERM->register_package (extension_package $files[0], $argv);	1030	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
713	} else {	1031	} else {
714	warn "perl extension '$ext' not found in perl library search path\n";	1032	warn "perl extension '$ext' not found in perl library search path\n";
715	}	1033	}
716	}	1034	}
717		1035
…		…
723		1041
724	if (my $cb = $TERM->{_hook}[$htype]) {	1042	if (my $cb = $TERM->{_hook}[$htype]) {
725	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1043	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
726	if $verbosity >= 10;	1044	if $verbosity >= 10;
727		1045
728	keys %$cb;	1046	for my $pkg (keys %$cb) {
729
730	while (my ($pkg, $cb) = each %$cb) {
731	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1047	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
732	and last;	1048	$retval ||= $retval_;
733		1049
734	if ($@) {	1050	if ($@) {
735	$TERM->ungrab; # better to lose the grab than the session	1051	$TERM->ungrab; # better to lose the grab than the session
736	warn $@;	1052	warn $@;
737	}	1053	}
…		…
750	}	1066	}
751		1067
752	$retval	1068	$retval
753	}	1069	}
754		1070
755	sub exec_async(@) {	1071	sub SET_COLOR($$$) {
756	my $pid = fork;	1072	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1073	}
757		1074
758	return	1075	sub rend2mask {
759	if !defined $pid or $pid;	1076	no strict 'refs';
760		1077	my ($str, $mask) = (@_, 0);
761	%ENV = %{ $TERM->env };	1078	my %color = ( fg => undef, bg => undef );
762		1079	my @failed;
763	exec @_;	1080	for my $spec ( split /\s+/, $str ) {
764	_exit 255;	1081	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1082	$color{lc($1)} = $2;
		1083	} else {
		1084	my $neg = $spec =~ s/^[-^]//;
		1085	unless ( exists &{"RS_$spec"} ) {
		1086	push @failed, $spec;
		1087	next;
		1088	}
		1089	my $cur = &{"RS_$spec"};
		1090	if ( $neg ) {
		1091	$mask &= ~$cur;
		1092	} else {
		1093	$mask |= $cur;
		1094	}
		1095	}
		1096	}
		1097	($mask, @color{qw(fg bg)}, \@failed)
765	}	1098	}
766		1099
767	# urxvt::term::extension	1100	# urxvt::term::extension
768		1101
769	package urxvt::term::extension;	1102	package urxvt::term::extension;
…		…
840	is that you cannot use blocking APIs, but the non-blocking variant should	1173	is that you cannot use blocking APIs, but the non-blocking variant should
841	work.	1174	work.
842		1175
843	=cut	1176	=cut
844		1177
845	our $VERSION = 1;	1178	our $VERSION = '5.23';
846		1179
847	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1180	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
848	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1181	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
849		1182
850	sub timer {	1183	sub timer {
…		…
852		1185
853	my $cb = $arg{cb};	1186	my $cb = $arg{cb};
854		1187
855	urxvt::timer	1188	urxvt::timer
856	->new	1189	->new
857	->start (urxvt::NOW + $arg{after})	1190	->after ($arg{after}, $arg{interval})
858	->cb (sub {	1191	->cb ($arg{interval} ? $cb : sub {
859	$_[0]->stop; # need to cancel manually	1192	$_[0]->stop; # need to cancel manually
860	$cb->();	1193	$cb->();
861	})	1194	})
862	}	1195	}
863		1196
864	sub io {	1197	sub io {
865	my ($class, %arg) = @_;	1198	my ($class, %arg) = @_;
866		1199
867	my $cb = $arg{cb};	1200	my $cb = $arg{cb};
		1201	my $fd = fileno $arg{fh};
		1202	defined $fd or $fd = $arg{fh};
868		1203
869	bless [$arg{fh}, urxvt::iow	1204	bless [$arg{fh}, urxvt::iow
870	->new	1205	->new
871	->fd (fileno $arg{fh})	1206	->fd ($fd)
872	->events (($arg{poll} =~ /r/ ? 1 : 0)	1207	->events (($arg{poll} =~ /r/ ? 1 : 0)
873	| ($arg{poll} =~ /w/ ? 2 : 0))	1208	| ($arg{poll} =~ /w/ ? 2 : 0))
874	->start	1209	->start
875	->cb (sub {	1210	->cb ($cb)
876	$cb->(($_[1] & 1 ? 'r' : '')
877	. ($_[1] & 2 ? 'w' : ''));
878	})],
879	urxvt::anyevent::	1211	], urxvt::anyevent::
		1212	}
		1213
		1214	sub idle {
		1215	my ($class, %arg) = @_;
		1216
		1217	my $cb = $arg{cb};
		1218
		1219	urxvt::iw
		1220	->new
		1221	->start
		1222	->cb ($cb)
		1223	}
		1224
		1225	sub child {
		1226	my ($class, %arg) = @_;
		1227
		1228	my $cb = $arg{cb};
		1229
		1230	urxvt::pw
		1231	->new
		1232	->start ($arg{pid})
		1233	->cb (sub {
		1234	$_[0]->stop; # need to cancel manually
		1235	$cb->($_[0]->rpid, $_[0]->rstatus);
		1236	})
880	}	1237	}
881		1238
882	sub DESTROY {	1239	sub DESTROY {
883	$_[0][1]->stop;	1240	$_[0][1]->stop;
884	}	1241	}
885		1242
886	sub condvar {	1243	# only needed for AnyEvent < 6 compatibility
887	bless \my $flag, urxvt::anyevent::condvar::	1244	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";	1245	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
897	}
898	}	1246	}
899		1247
900	package urxvt::term;	1248	package urxvt::term;
901		1249
902	=head2 The C<urxvt::term> Class	1250	=head2 The C<urxvt::term> Class
…		…
907		1255
908	# find on_xxx subs in the package and register them	1256	# find on_xxx subs in the package and register them
909	# as hooks	1257	# as hooks
910	sub register_package {	1258	sub register_package {
911	my ($self, $pkg, $argv) = @_;	1259	my ($self, $pkg, $argv) = @_;
		1260
		1261	no strict 'refs';
		1262
		1263	urxvt::verbose 6, "register package $pkg to $self";
		1264
		1265	@{"$pkg\::ISA"} = urxvt::term::extension::;
912		1266
913	my $proxy = bless {	1267	my $proxy = bless {
914	_pkg => $pkg,	1268	_pkg => $pkg,
915	argv => $argv,	1269	argv => $argv,
916	}, $pkg;	1270	}, $pkg;
…		…
932	hash which defines the environment of the new terminal.	1286	hash which defines the environment of the new terminal.
933		1287
934	Croaks (and probably outputs an error message) if the new instance	1288	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	1289	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	1290	initialise perl, and the terminal object otherwise. The C<init> and
937	C<start> hooks will be called during this call.	1291	C<start> hooks will be called before this call returns, and are free to
		1292	refer to global data (which is race free).
938		1293
939	=cut	1294	=cut
940		1295
941	sub new {	1296	sub new {
942	my ($class, $env, @args) = @_;	1297	my ($class, $env, @args) = @_;
943		1298
		1299	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1300	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1301
944	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1302	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
945	}	1303	}
946		1304
947	=item $term->destroy	1305	=item $term->destroy
948		1306
949	Destroy the terminal object (close the window, free resources	1307	Destroy the terminal object (close the window, free resources
950	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1308	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
951	watchers (timers, io watchers) are still active.	1309	watchers (timers, io watchers) are still active.
952		1310
		1311	=item $term->exec_async ($cmd[, @args])
		1312
		1313	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1314	("starts") programs in the background. This function takes care of setting
		1315	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1316	be preferred over explicit calls to C<exec> or C<system>.
		1317
		1318	Returns the pid of the subprocess or C<undef> on error.
		1319
		1320	=cut
		1321
		1322	sub exec_async {
		1323	my $self = shift;
		1324
		1325	my $pid = fork;
		1326
		1327	return $pid
		1328	if !defined $pid or $pid;
		1329
		1330	%ENV = %{ $self->env };
		1331
		1332	exec @_;
		1333	urxvt::_exit 255;
		1334	}
		1335
953	=item $isset = $term->option ($optval[, $set])	1336	=item $isset = $term->option ($optval[, $set])
954		1337
955	Returns true if the option specified by C<$optval> is enabled, and	1338	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	1339	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.	1340	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
958		1341
959	Here is a a likely non-exhaustive list of option names, please see the	1342	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:	1343	source file F</src/optinc.h> to see the actual list:
961		1344
962	borderLess console cursorBlink cursorUnderline hold iconic insecure	1345	borderLess buffered console cursorBlink cursorUnderline hold iconic
963	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1346	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
964	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1347	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
965	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1348	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
966	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1349	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
967	transparent tripleclickwords utmpInhibit visualBell	1350	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1351	urgentOnBell utmpInhibit visualBell
968		1352
969	=item $value = $term->resource ($name[, $newval])	1353	=item $value = $term->resource ($name[, $newval])
970		1354
971	Returns the current resource value associated with a given name and	1355	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>	1356	optionally sets a new value. Setting values is most useful in the C<init>
…		…
981	likely change).	1365	likely change).
982		1366
983	Please note that resource strings will currently only be freed when the	1367	Please note that resource strings will currently only be freed when the
984	terminal is destroyed, so changing options frequently will eat memory.	1368	terminal is destroyed, so changing options frequently will eat memory.
985		1369
986	Here is a a likely non-exhaustive list of resource names, not all of which	1370	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>	1371	are supported in every build, please see the source file F</src/rsinc.h>
988	to see the actual list:	1372	to see the actual list:
989		1373
990	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1374	answerbackstring backgroundPixmap backspace_key blendtype blurradius
991	borderLess color cursorBlink cursorUnderline cutchars delete_key	1375	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
992	display_name embed ext_bwidth fade font geometry hold iconName	1376	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
993	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1377	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1378	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
994	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1379	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
995	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1380	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
996	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1381	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
997	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1382	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
998	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1383	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
999	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1384	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1000	secondaryScreen secondaryScroll selectstyle shade term_name title	1385	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1001	transient_for transparent transparent_all tripleclickwords utmpInhibit	1386	term_name title transient_for transparent tripleclickwords urgentOnBell
1002	visualBell	1387	utmpInhibit visualBell
1003		1388
1004	=cut	1389	=cut
1005		1390
1006	sub resource($$;$) {	1391	sub resource($$;$) {
1007	my ($self, $name) = (shift, shift);	1392	my ($self, $name) = (shift, shift);
1008	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1393	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1009	&urxvt::term::_resource	1394	goto &urxvt::term::_resource
1010	}	1395	}
1011		1396
1012	=item $value = $term->x_resource ($pattern)	1397	=item $value = $term->x_resource ($pattern)
1013		1398
1014	Returns the X-Resource for the given pattern, excluding the program or	1399	Returns the X-Resource for the given pattern, excluding the program or
…		…
1018		1403
1019	This method should only be called during the C<on_start> hook, as there is	1404	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	1405	only one resource database per display, and later invocations might return
1021	the wrong resources.	1406	the wrong resources.
1022		1407
1023	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1408	=item $success = $term->parse_keysym ($key, $octets)
1024		1409
1025	Adds a keymap translation exactly as specified via a resource. See the	1410	Adds a key binding exactly as specified via a resource. See the
1026	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1411	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1412
		1413	=item $term->register_command ($keysym, $modifiermask, $string)
		1414
		1415	Adds a key binding. This is a lower level api compared to
		1416	C<parse_keysym>, as it expects a parsed key description, and can be
		1417	used only inside either the C<on_init> hook, to add a binding, or the
		1418	C<on_register_command> hook, to modify a parsed binding.
1027		1419
1028	=item $rend = $term->rstyle ([$new_rstyle])	1420	=item $rend = $term->rstyle ([$new_rstyle])
1029		1421
1030	Return and optionally change the current rendition. Text that is output by	1422	Return and optionally change the current rendition. Text that is output by
1031	the terminal application will use this style.	1423	the terminal application will use this style.
…		…
1039		1431
1040	=item ($row, $col) = $term->selection_beg ([$row, $col])	1432	=item ($row, $col) = $term->selection_beg ([$row, $col])
1041		1433
1042	=item ($row, $col) = $term->selection_end ([$row, $col])	1434	=item ($row, $col) = $term->selection_end ([$row, $col])
1043		1435
1044	Return the current values of the selection mark, begin or end positions,	1436	Return the current values of the selection mark, begin or end positions.
1045	and optionally set them to new values.	1437
		1438	When arguments are given, then the selection coordinates are set to
		1439	C<$row> and C<$col>, and the selection screen is set to the current
		1440	screen.
		1441
		1442	=item $screen = $term->selection_screen ([$screen])
		1443
		1444	Returns the current selection screen, and then optionally sets it.
1046		1445
1047	=item $term->selection_make ($eventtime[, $rectangular])	1446	=item $term->selection_make ($eventtime[, $rectangular])
1048		1447
1049	Tries to make a selection as set by C<selection_beg> and	1448	Tries to make a selection as set by C<selection_beg> and
1050	C<selection_end>. If C<$rectangular> is true (default: false), a	1449	C<selection_end>. If C<$rectangular> is true (default: false), a
1051	rectangular selection will be made. This is the prefered function to make	1450	rectangular selection will be made. This is the preferred function to make
1052	a selection.	1451	a selection.
1053		1452
1054	=item $success = $term->selection_grab ($eventtime)	1453	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1055		1454
1056	Try to request the primary selection text from the server (for example, as	1455	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1456	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	1457	with the next method. No visual feedback will be given. This function
1058	is mostly useful from within C<on_sel_grab> hooks.	1458	is mostly useful from within C<on_sel_grab> hooks.
1059		1459
1060	=item $oldtext = $term->selection ([$newtext])	1460	=item $oldtext = $term->selection ([$newtext, $clipboard])
1061		1461
1062	Return the current selection text and optionally replace it by C<$newtext>.	1462	Return the current selection (clipboard if C<$clipboard> is true) text
		1463	and optionally replace it by C<$newtext>.
		1464
		1465	=item $term->selection_clear ([$clipboard])
		1466
		1467	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1063		1468
1064	=item $term->overlay_simple ($x, $y, $text)	1469	=item $term->overlay_simple ($x, $y, $text)
1065		1470
1066	Create a simple multi-line overlay box. See the next method for details.	1471	Create a simple multi-line overlay box. See the next method for details.
1067		1472
…		…
1097		1502
1098	The methods currently supported on C<urxvt::overlay> objects are:	1503	The methods currently supported on C<urxvt::overlay> objects are:
1099		1504
1100	=over 4	1505	=over 4
1101		1506
1102	=item $overlay->set ($x, $y, $text, $rend)	1507	=item $overlay->set ($x, $y, $text[, $rend])
1103		1508
1104	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1509	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	1510	text in rxvt-unicode's special encoding and an array of rendition values
1106	at a specific position inside the overlay.	1511	at a specific position inside the overlay.
		1512
		1513	If C<$rend> is missing, then the rendition will not be changed.
1107		1514
1108	=item $overlay->hide	1515	=item $overlay->hide
1109		1516
1110	If visible, hide the overlay, but do not destroy it.	1517	If visible, hide the overlay, but do not destroy it.
1111		1518
…		…
1181		1588
1182	Normally its not a good idea to use this function, as programs might be	1589	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	1590	confused by changes in cursor position or scrolling. Its useful inside a
1184	C<on_add_lines> hook, though.	1591	C<on_add_lines> hook, though.
1185		1592
		1593	=item $term->scr_change_screen ($screen)
		1594
		1595	Switch to given screen - 0 primary, 1 secondary.
		1596
1186	=item $term->cmd_parse ($octets)	1597	=item $term->cmd_parse ($octets)
1187		1598
1188	Similar to C<scr_add_lines>, but the argument must be in the	1599	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	1600	locale-specific encoding of the terminal and can contain command sequences
1190	(escape codes) that will be interpreted.	1601	(escape codes) that will be interpreted.
1191		1602
1192	=item $term->tt_write ($octets)	1603	=item $term->tt_write ($octets)
1193		1604
1194	Write the octets given in C<$data> to the tty (i.e. as program input). To	1605	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	1606	pass characters instead of octets, you should convert your strings first
1196	to the locale-specific encoding using C<< $term->locale_encode >>.	1607	to the locale-specific encoding using C<< $term->locale_encode >>.
		1608
		1609	=item $term->tt_paste ($octets)
		1610
		1611	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1612	CR and bracketing the data with control sequences if bracketed paste mode
		1613	is set.
1197		1614
1198	=item $old_events = $term->pty_ev_events ([$new_events])	1615	=item $old_events = $term->pty_ev_events ([$new_events])
1199		1616
1200	Replaces the event mask of the pty watcher by the given event mask. Can	1617	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	1618	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	1619	description of C<< urxvt::timer->events >>. Make sure to always restore
1203	the previous value.	1620	the previous value.
1204		1621
		1622	=item $fd = $term->pty_fd
		1623
		1624	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1625	is used.
		1626
1205	=item $windowid = $term->parent	1627	=item $windowid = $term->parent
1206		1628
1207	Return the window id of the toplevel window.	1629	Return the window id of the toplevel window.
1208		1630
1209	=item $windowid = $term->vt	1631	=item $windowid = $term->vt
…		…
1215	Adds the specified events to the vt event mask. Useful e.g. when you want	1637	Adds the specified events to the vt event mask. Useful e.g. when you want
1216	to receive pointer events all the times:	1638	to receive pointer events all the times:
1217		1639
1218	$term->vt_emask_add (urxvt::PointerMotionMask);	1640	$term->vt_emask_add (urxvt::PointerMotionMask);
1219		1641
		1642	=item $term->set_urgency ($set)
		1643
		1644	Enable/disable the urgency hint on the toplevel window.
		1645
		1646	=item $term->focus_in
		1647
		1648	=item $term->focus_out
		1649
		1650	=item $term->key_press ($state, $keycode[, $time])
		1651
		1652	=item $term->key_release ($state, $keycode[, $time])
		1653
		1654	Deliver various fake events to to terminal.
		1655
1220	=item $window_width = $term->width	1656	=item $window_width = $term->width
1221		1657
1222	=item $window_height = $term->height	1658	=item $window_height = $term->height
1223		1659
1224	=item $font_width = $term->fwidth	1660	=item $font_width = $term->fwidth
…		…
1254	=item $env = $term->env	1690	=item $env = $term->env
1255		1691
1256	Returns a copy of the environment in effect for the terminal as a hashref	1692	Returns a copy of the environment in effect for the terminal as a hashref
1257	similar to C<\%ENV>.	1693	similar to C<\%ENV>.
1258		1694
		1695	=item @envv = $term->envv
		1696
		1697	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1698
		1699	=item @argv = $term->argv
		1700
		1701	Return the argument vector as this terminal, similar to @ARGV, but
		1702	includes the program name as first element.
		1703
1259	=cut	1704	=cut
1260		1705
1261	sub env {	1706	sub env {
1262	if (my $env = $_[0]->_env) {
1263	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1707	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1264	} else {
1265	+{ %ENV }
1266	}
1267	}	1708	}
1268		1709
1269	=item $modifiermask = $term->ModLevel3Mask	1710	=item $modifiermask = $term->ModLevel3Mask
1270		1711
1271	=item $modifiermask = $term->ModMetaMask	1712	=item $modifiermask = $term->ModMetaMask
1272		1713
1273	=item $modifiermask = $term->ModNumLockMask	1714	=item $modifiermask = $term->ModNumLockMask
1274		1715
1275	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1716	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.	1717	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1718
		1719	=item $screen = $term->current_screen
		1720
		1721	Returns the currently displayed screen (0 primary, 1 secondary).
		1722
		1723	=item $cursor_is_hidden = $term->hidden_cursor
		1724
		1725	Returns whether the cursor is currently hidden or not.
1277		1726
1278	=item $view_start = $term->view_start ([$newvalue])	1727	=item $view_start = $term->view_start ([$newvalue])
1279		1728
1280	Returns the row number of the topmost displayed line. Maximum value is	1729	Returns the row number of the topmost displayed line. Maximum value is
1281	C<0>, which displays the normal terminal contents. Lower values scroll	1730	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1289		1738
1290	Used after changing terminal contents to display them.	1739	Used after changing terminal contents to display them.
1291		1740
1292	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1741	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1293		1742
1294	Returns the text of the entire row with number C<$row_number>. Row C<0>	1743	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	1744	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	1745	terminal line. Nothing will be returned if a nonexistent line
1298	is requested.	1746	is requested.
1299		1747
1300	If C<$new_text> is specified, it will replace characters in the current	1748	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	1749	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	1750	to replace only parts of a line. The font index in the rendition will
1303	automatically be updated.	1751	automatically be updated.
1304		1752
1305	C<$text> is in a special encoding: tabs and wide characters that use more	1753	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	1754	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1307	(C<chr 65535>). Characters with combining characters and other characters	1755	characters. Characters with combining characters and other characters that
1308	that do not fit into the normal tetx encoding will be replaced with	1756	do not fit into the normal text encoding will be replaced with characters
1309	characters in the private use area.	1757	in the private use area.
1310		1758
1311	You have to obey this encoding when changing text. The advantage is	1759	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	1760	that C<substr> and similar functions work on screen cells and not on
1313	characters.	1761	characters.
1314		1762
…		…
1458	where one character corresponds to one screen cell. See	1906	where one character corresponds to one screen cell. See
1459	C<< $term->ROW_t >> for details.	1907	C<< $term->ROW_t >> for details.
1460		1908
1461	=item $string = $term->special_decode $text	1909	=item $string = $term->special_decode $text
1462		1910
1463	Converts rxvt-unicodes text reprsentation into a perl string. See	1911	Converts rxvt-unicodes text representation into a perl string. See
1464	C<< $term->ROW_t >> for details.	1912	C<< $term->ROW_t >> for details.
1465		1913
1466	=item $success = $term->grab_button ($button, $modifiermask)	1914	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1467		1915
		1916	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1917
1468	Registers a synchronous button grab. See the XGrabButton manpage.	1918	Register/unregister a synchronous button grab. See the XGrabButton
		1919	manpage.
1469		1920
1470	=item $success = $term->grab ($eventtime[, $sync])	1921	=item $success = $term->grab ($eventtime[, $sync])
1471		1922
1472	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1923	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1473	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1924	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1474		1925
1475	=item $term->allow_events_async	1926	=item $term->allow_events_async
1476		1927
1477	Calls XAllowEvents with AsyncBoth for the most recent grab.	1928	Calls XAllowEvents with AsyncBoth for the most recent grab.
1478		1929
…		…
1485	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1936	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1486	recent grab.	1937	recent grab.
1487		1938
1488	=item $term->ungrab	1939	=item $term->ungrab
1489		1940
1490	Calls XUngrab for the most recent grab. Is called automatically on	1941	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	1942	evaluation errors, as it is better to lose the grab in the error case as
1492	the session.	1943	the session.
		1944
		1945	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1946
		1947	=item $atom_name = $term->XGetAtomName ($atom)
		1948
		1949	=item @atoms = $term->XListProperties ($window)
		1950
		1951	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1952
		1953	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1954
		1955	=item $term->XDeleteProperty ($window, $property)
		1956
		1957	=item $window = $term->DefaultRootWindow
		1958
		1959	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1960
		1961	=item $term->XMapWindow ($window)
		1962
		1963	=item $term->XUnmapWindow ($window)
		1964
		1965	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1966
		1967	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1968
		1969	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1970
		1971	=item $keysym = $term->XStringToKeysym ($string)
		1972
		1973	=item $string = $term->XKeysymToString ($keysym)
		1974
		1975	Various X or X-related functions. The C<$term> object only serves as
		1976	the source of the display, otherwise those functions map more-or-less
		1977	directly onto the X functions of the same name.
1493		1978
1494	=back	1979	=back
1495		1980
1496	=cut	1981	=cut
1497		1982
…		…
1561	my ($self, $text, $cb) = @_;	2046	my ($self, $text, $cb) = @_;
1562		2047
1563	$self->add_item ({ type => "button", text => $text, activate => $cb});	2048	$self->add_item ({ type => "button", text => $text, activate => $cb});
1564	}	2049	}
1565		2050
1566	=item $popup->add_toggle ($text, $cb, $initial_value)	2051	=item $popup->add_toggle ($text, $initial_value, $cb)
1567		2052
1568	Adds a toggle/checkbox item to the popup. Teh callback gets called	2053	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	2054	whenever it gets toggled, with a boolean indicating its new value as its
1570	argument.	2055	first argument.
1571		2056
1572	=cut	2057	=cut
1573		2058
1574	sub add_toggle {	2059	sub add_toggle {
1575	my ($self, $text, $cb, $value) = @_;	2060	my ($self, $text, $value, $cb) = @_;
1576		2061
1577	my $item; $item = {	2062	my $item; $item = {
1578	type => "button",	2063	type => "button",
1579	text => " $text",	2064	text => " $text",
1580	value => $value,	2065	value => $value,
…		…
1599	my $env = $self->{term}->env;	2084	my $env = $self->{term}->env;
1600	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2085	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1601	delete $env->{LC_ALL};	2086	delete $env->{LC_ALL};
1602	$env->{LC_CTYPE} = $self->{term}->locale;	2087	$env->{LC_CTYPE} = $self->{term}->locale;
1603		2088
1604	urxvt::term->new ($env, "popup",	2089	my $term = urxvt::term->new (
		2090	$env, "popup",
1605	"--perl-lib" => "", "--perl-ext-common" => "",	2091	"--perl-lib" => "", "--perl-ext-common" => "",
1606	"-pty-fd" => -1, "-sl" => 0,	2092	"-pty-fd" => -1, "-sl" => 0,
1607	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2093	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1608	"--transient-for" => $self->{term}->parent,	2094	"--transient-for" => $self->{term}->parent,
1609	"-display" => $self->{term}->display_id,	2095	"-display" => $self->{term}->display_id,
1610	"-pe" => "urxvt-popup")	2096	"-pe" => "urxvt-popup",
1611	or die "unable to create popup window\n";	2097	) or die "unable to create popup window\n";
		2098
		2099	unless (delete $term->{urxvt_popup_init_done}) {
		2100	$term->ungrab;
		2101	$term->destroy;
		2102	die "unable to initialise popup window\n";
		2103	}
1612	}	2104	}
1613		2105
1614	sub DESTROY {	2106	sub DESTROY {
1615	my ($self) = @_;	2107	my ($self) = @_;
1616		2108
1617	delete $self->{term}{_destroy}{$self};	2109	delete $self->{term}{_destroy}{$self};
1618	$self->{term}->ungrab;	2110	$self->{term}->ungrab;
1619	}	2111	}
1620		2112
1621	=back	2113	=back
		2114
		2115	=cut
		2116
		2117	package urxvt::watcher;
1622		2118
1623	=head2 The C<urxvt::timer> Class	2119	=head2 The C<urxvt::timer> Class
1624		2120
1625	This class implements timer watchers/events. Time is represented as a	2121	This class implements timer watchers/events. Time is represented as a
1626	fractional number of seconds since the epoch. Example:	2122	fractional number of seconds since the epoch. Example:
…		…
1630	->new	2126	->new
1631	->interval (1)	2127	->interval (1)
1632	->cb (sub {	2128	->cb (sub {
1633	$term->{overlay}->set (0, 0,	2129	$term->{overlay}->set (0, 0,
1634	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2130	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1635	});	2131	});
1636		2132
1637	=over 4	2133	=over 4
1638		2134
1639	=item $timer = new urxvt::timer	2135	=item $timer = new urxvt::timer
1640		2136
…		…
1643		2139
1644	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2140	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1645		2141
1646	Set the callback to be called when the timer triggers.	2142	Set the callback to be called when the timer triggers.
1647		2143
1648	=item $tstamp = $timer->at
1649
1650	Return the time this watcher will fire next.
1651
1652	=item $timer = $timer->set ($tstamp)	2144	=item $timer = $timer->set ($tstamp[, $interval])
1653		2145
1654	Set the time the event is generated to $tstamp.	2146	Set the time the event is generated to $tstamp (and optionally specifies a
		2147	new $interval).
1655		2148
1656	=item $timer = $timer->interval ($interval)	2149	=item $timer = $timer->interval ($interval)
1657		2150
1658	Normally (and when C<$interval> is C<0>), the timer will automatically	2151	By default (and when C<$interval> is C<0>), the timer will automatically
1659	stop after it has fired once. If C<$interval> is non-zero, then the timer	2152	stop after it has fired once. If C<$interval> is non-zero, then the timer
1660	is automatically rescheduled at the given intervals.	2153	is automatically rescheduled at the given intervals.
1661		2154
1662	=item $timer = $timer->start	2155	=item $timer = $timer->start
1663		2156
1664	Start the timer.	2157	Start the timer.
1665		2158
1666	=item $timer = $timer->start ($tstamp)	2159	=item $timer = $timer->start ($tstamp[, $interval])
1667		2160
1668	Set the event trigger time to C<$tstamp> and start the timer.	2161	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2162	also replaces the interval.
1669		2163
1670	=item $timer = $timer->after ($delay)	2164	=item $timer = $timer->after ($delay[, $interval])
1671		2165
1672	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2166	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1673		2167
1674	=item $timer = $timer->stop	2168	=item $timer = $timer->stop
1675		2169
…		…
1683		2177
1684	$term->{socket} = ...	2178	$term->{socket} = ...
1685	$term->{iow} = urxvt::iow	2179	$term->{iow} = urxvt::iow
1686	->new	2180	->new
1687	->fd (fileno $term->{socket})	2181	->fd (fileno $term->{socket})
1688	->events (urxvt::EVENT_READ)	2182	->events (urxvt::EV_READ)
1689	->start	2183	->start
1690	->cb (sub {	2184	->cb (sub {
1691	my ($iow, $revents) = @_;	2185	my ($iow, $revents) = @_;
1692	# $revents must be 1 here, no need to check	2186	# $revents must be 1 here, no need to check
1693	sysread $term->{socket}, my $buf, 8192	2187	sysread $term->{socket}, my $buf, 8192
…		…
1706	Set the callback to be called when io events are triggered. C<$reventmask>	2200	Set the callback to be called when io events are triggered. C<$reventmask>
1707	is a bitset as described in the C<events> method.	2201	is a bitset as described in the C<events> method.
1708		2202
1709	=item $iow = $iow->fd ($fd)	2203	=item $iow = $iow->fd ($fd)
1710		2204
1711	Set the filedescriptor (not handle) to watch.	2205	Set the file descriptor (not handle) to watch.
1712		2206
1713	=item $iow = $iow->events ($eventmask)	2207	=item $iow = $iow->events ($eventmask)
1714		2208
1715	Set the event mask to watch. The only allowed values are	2209	Set the event mask to watch. The only allowed values are
1716	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2210	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1717	together, or C<urxvt::EVENT_NONE>.	2211	together, or C<urxvt::EV_NONE>.
1718		2212
1719	=item $iow = $iow->start	2213	=item $iow = $iow->start
1720		2214
1721	Start watching for requested events on the given handle.	2215	Start watching for requested events on the given handle.
1722		2216
1723	=item $iow = $iow->stop	2217	=item $iow = $iow->stop
1724		2218
1725	Stop watching for events on the given filehandle.	2219	Stop watching for events on the given file handle.
		2220
		2221	=back
		2222
		2223	=head2 The C<urxvt::iw> Class
		2224
		2225	This class implements idle watchers, that get called automatically when
		2226	the process is idle. They should return as fast as possible, after doing
		2227	some useful work.
		2228
		2229	=over 4
		2230
		2231	=item $iw = new urxvt::iw
		2232
		2233	Create a new idle watcher object in stopped state.
		2234
		2235	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2236
		2237	Set the callback to be called when the watcher triggers.
		2238
		2239	=item $timer = $timer->start
		2240
		2241	Start the watcher.
		2242
		2243	=item $timer = $timer->stop
		2244
		2245	Stop the watcher.
		2246
		2247	=back
		2248
		2249	=head2 The C<urxvt::pw> Class
		2250
		2251	This class implements process watchers. They create an event whenever a
		2252	process exits, after which they stop automatically.
		2253
		2254	my $pid = fork;
		2255	...
		2256	$term->{pw} = urxvt::pw
		2257	->new
		2258	->start ($pid)
		2259	->cb (sub {
		2260	my ($pw, $exit_status) = @_;
		2261	...
		2262	});
		2263
		2264	=over 4
		2265
		2266	=item $pw = new urxvt::pw
		2267
		2268	Create a new process watcher in stopped state.
		2269
		2270	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2271
		2272	Set the callback to be called when the timer triggers.
		2273
		2274	=item $pw = $timer->start ($pid)
		2275
		2276	Tells the watcher to start watching for process C<$pid>.
		2277
		2278	=item $pw = $pw->stop
		2279
		2280	Stop the watcher.
1726		2281
1727	=back	2282	=back
1728		2283
1729	=head1 ENVIRONMENT	2284	=head1 ENVIRONMENT
1730		2285
…		…
1739		2294
1740	=item >= 3 - script loading and management	2295	=item >= 3 - script loading and management
1741		2296
1742	=item >=10 - all called hooks	2297	=item >=10 - all called hooks
1743		2298
1744	=item >=11 - hook reutrn values	2299	=item >=11 - hook return values
1745		2300
1746	=back	2301	=back
1747		2302
1748	=head1 AUTHOR	2303	=head1 AUTHOR
1749		2304
1750	Marc Lehmann <pcg@goof.com>	2305	Marc Lehmann <schmorp@schmorp.de>
1751	http://software.schmorp.de/pkg/rxvt-unicode	2306	http://software.schmorp.de/pkg/rxvt-unicode
1752		2307
1753	=cut	2308	=cut
1754		2309
1755	1	2310	1
		2311
		2312	# vim: sw=3:

Diff Legend

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