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

Diff Legend

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