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.128 by root, Wed Jan 25 00:57:57 2006 UTC vs.
Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:	71	between two vertical bars:
69		72
70	URxvt.selection.pattern-0: \\|([^|]+)\\|	73	URxvt.selection.pattern-0: \\|([^|]+)\\|
71		74
72	Another example: Programs I use often output "absolute path: " at the	75	Another example: Programs I use often output "absolute path: " at the
…		…
94	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
95		98
96	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
97	runtime.	100	runtime.
98		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
99	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
100		120
101	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
102	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
103	evaluation, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
104		124
105	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
107	popup is displayed.	127	popup is being displayed.
108		128
109	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
110	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.
111	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
112	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
113	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
114		134
115	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
116	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
117	C<a>s:	137	C<a>s:
118		138
119	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
120	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
121	: ()	141	: ()
122	};	142	};
123		143
124	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
125		145
…		…
132	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>
133	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
134	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
135	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
136	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
137	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.
138		164
139	=item readline (enabled by default)	165	=item readline (enabled by default)
140		166
141	A support package that tries to make editing with readline easier. At the	167	A support package that tries to make editing with readline easier. At
142	moment, it reacts to clicking with the left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
143	move the text cursor to this position. It does so by generating as many	169	move the text cursor to this position. It does so by generating as many
144	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
145	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
146		172
147	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
148		174
149	=over 4	175	=over 4
…		…
197	the message into vi commands to load the file.	223	the message into vi commands to load the file.
198		224
199	=item tabbed	225	=item tabbed
200		226
201	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one	229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204	button per tab.	230	button per tab.
205		231
206	Clicking a button will activate that tab. Pressing B<Shift-Left> and	232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
207	B<Shift-Right> will switch to the tab left or right of the current one,	233	B<Shift-Right> will switch to the tab left or right of the current one,
208	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
209		235
210	=item mark-urls	236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
211		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
212	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
213	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
214	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
215	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.
		258
		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.
		263
		264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
		266	"perl:matcher:list" as seen in the example below.
		267
		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
216		278
217	=item xim-onthespot	279	=item xim-onthespot
218		280
219	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
220	not work perfectly, and some input methods don't seem to work well with	282	not work perfectly, and some input methods don't seem to work well with
221	OnTheSpot editing in general, but it seems to work at leats for SCIM and	283	OnTheSpot editing in general, but it seems to work at least for SCIM and
222	kinput2.	284	kinput2.
223		285
224	You enable it by specifying this extension and a preedit style of	286	You enable it by specifying this extension and a preedit style of
225	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
226		288
227	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
228		290
229	=item automove-background	291	=item kuake<hotkey>
230		292
231	This is basically a one-line extension that dynamically changes the background pixmap offset	293	A very primitive quake-console-like extension. It was inspired by a
232	to the window position, in effect creating the same effect as pseudo transparency with	294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
233	a custom pixmap. No scaling is supported in this mode. Exmaple:	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.
234		298
235	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	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.
236		315
237	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
238		317
239	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
240	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
241	similar-looking ascii character.	320	similar-looking ascii character.
242		321
243	=item digital-clock	322	=item digital-clock
244		323
245	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.
246		393
247	=item example-refresh-hooks	394	=item example-refresh-hooks
248		395
249	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
250	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
251	overlays or changes.	398	overlays or changes.
252		399
253	=item selection-pastebin	400	=item confirm-paste
254		401
255	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
256	textfile to a remote site (or does other things). (The implementation is	403	line is detected.
257	not currently secure for use in a multiuser environment as it writes to
258	F</tmp> directly.).
259		404
260	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	405	=item bell-command
261	i.e.
262		406
263	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:
264		410
265	Pressing this combination runs a command with C<%> replaced by the name of	411	URxvt.bell-command: notify-send "Beep, Beep"
266	the textfile. This command can be set via a resource:
267
268	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
269
270	And the default is likely not useful to anybody but the few people around
271	here :)
272
273	The name of the textfile is the hex encoded md5 sum of the selection, so
274	the same content should lead to the same filename.
275
276	After a successful upload the selection will be replaced by the text given
277	in the C<selection-pastebin-url> resource (again, the % is the placeholder
278	for the filename):
279
280	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
281		412
282	=back	413	=back
283		414
284	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
285		416
…		…
301		432
302	=over 4	433	=over 4
303		434
304	=item $text	435	=item $text
305		436
306	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
307	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.
308		439
309	=item $string	440	=item $string
310		441
311	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
…		…
315	=item $octets	446	=item $octets
316		447
317	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
318	locale-specific way.	449	locale-specific way.
319		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
320	=back	457	=back
321		458
322	=head2 Extension Objects	459	=head2 Extension Objects
323		460
324	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
325	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,
326	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
327	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
328	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
329	use.	467	internal use.
330		468
331	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
332	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
333		471
334	It has the following methods and data members:	472	It has the following methods and data members:
…		…
355	=head2 Hooks	493	=head2 Hooks
356		494
357	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
358	called whenever the relevant event happens.	496	called whenever the relevant event happens.
359		497
360	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
361	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
362		500
363	B<All> of these hooks must return a boolean value. If any of the called	501	B<All> of these hooks must return a boolean value. If any of the called
364	hooks returns true, then the event counts as being I<consumed>, and the	502	hooks returns true, then the event counts as being I<consumed>, and the
365	relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
…		…
378	place.	516	place.
379		517
380	=item on_start $term	518	=item on_start $term
381		519
382	Called at the very end of initialisation of a new terminal, just before	520	Called at the very end of initialisation of a new terminal, just before
383	trying to map (display) the toplevel and returning to the mainloop.	521	trying to map (display) the toplevel and returning to the main loop.
384		522
385	=item on_destroy $term	523	=item on_destroy $term
386		524
387	Called whenever something tries to destroy terminal, when the terminal is	525	Called whenever something tries to destroy terminal, when the terminal is
388	still fully functional (not for long, though).	526	still fully functional (not for long, though).
…		…
415		553
416	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
417	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
418	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
419		557
420	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.
421		559
422	=item on_sel_extend $term	560	=item on_sel_extend $term
423		561
424	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
425	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
426	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
427	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
428	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
429	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
430		568
431	See the F<selection> example extension.	569	See the F<selection> example extension.
432		570
433	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
434		572
435	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
436	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
437	show this many lines of scrollback.	575	show this many lines of scrollback.
438		576
439	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
440		578
…		…
444		582
445	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,
446	$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
447	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
448		586
449	=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
450		598
451	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
452	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
453	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
454	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,
455	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
456	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	}
457		615
458	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,
459	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
460	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.
461		622
462	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
463		624
464	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
465	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
…		…
470	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
471		632
472	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
473	suppress or filter tty input.	634	suppress or filter tty input.
474		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
475	=item on_line_update $term, $row	643	=item on_line_update $term, $row
476		644
477	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
478	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
479	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,
…		…
486	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
487	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
488		656
489	=item on_refresh_begin $term	657	=item on_refresh_begin $term
490		658
491	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
492	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
493	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
494	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
495		663
496	=item on_refresh_end $term	664	=item on_refresh_end $term
497		665
498	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>.
499		667
500	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
501		669
502	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
503	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>
504	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.
505		689
506	=item on_x_event $term, $event	690	=item on_x_event $term, $event
507		691
508	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
509	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
510	members are not passed.	694	members are not passed.
511		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
512	=item on_focus_in $term	700	=item on_focus_in $term
513		701
514	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
515	does focus in processing.	703	does focus in processing.
516		704
517	=item on_focus_out $term	705	=item on_focus_out $term
518		706
519	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
520	focus out processing.	708	focus out processing.
521		709
522	=item on_configure_notify $term, $event	710	=item on_configure_notify $term, $event
523		711
524	=item on_property_notify $term, $event	712	=item on_property_notify $term, $event
…		…
535		723
536	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
537		725
538	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
539		727
540	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
541	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.
542		730
543	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
544	manpage), with the additional members C<row> and C<col>, which are the	732	manpage), with the additional members C<row> and C<col>, which are the
545	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
546		734
…		…
556	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
557		745
558	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
559	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
560		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
		752
561	=back	753	=back
562		754
563	=cut	755	=cut
564		756
565	package urxvt;	757	package urxvt;
566		758
567	use utf8;	759	use utf8;
568	use strict;	760	use strict 'vars';
569	use Carp ();	761	use Carp ();
570	use Scalar::Util ();	762	use Scalar::Util ();
571	use List::Util ();	763	use List::Util ();
572		764
573	our $VERSION = 1;	765	our $VERSION = 1;
574	our $TERM;	766	our $TERM;
575	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
576	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
577	our @HOOKNAME;	769	our @HOOKNAME;
578	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
579	our %OPTION;	771	our %OPTION;
580		772
581	our $LIBDIR;	773	our $LIBDIR;
…		…
607	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
608	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
609		801
610	=item @urxvt::TERM_INIT	802	=item @urxvt::TERM_INIT
611		803
612	All coderefs in this array will be called as methods of the next newly	804	All code references in this array will be called as methods of the next newly
613	created C<urxvt::term> object (during the C<on_init> phase). The array	805	created C<urxvt::term> object (during the C<on_init> phase). The array
614	gets cleared before the codereferences that were in it are being executed,	806	gets cleared before the code references that were in it are being executed,
615	so coderefs can push themselves onto it again if they so desire.	807	so references can push themselves onto it again if they so desire.
616		808
617	This complements to the perl-eval commandline option, but gets executed	809	This complements to the perl-eval command line option, but gets executed
618	first.	810	first.
619		811
620	=item @urxvt::TERM_EXT	812	=item @urxvt::TERM_EXT
621		813
622	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	814	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
629		821
630	=over 4	822	=over 4
631		823
632	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
633		825
634	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
635	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
636	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
637		830
638	=item urxvt::warn $string	831	=item urxvt::warn $string
639		832
640	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
641	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
642	that calls this function.	835	that calls this function.
643		836
644	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
645	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
646		839
647	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).
648		848
649	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
650		850
651	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
652		852
…		…
695		895
696	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
697		897
698	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
699		899
700	=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
701		902
702	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
703	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
704	the bitset.	905	the bitset.
705		906
…		…
710	Return the foreground/background colour index, respectively.	911	Return the foreground/background colour index, respectively.
711		912
712	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
713		914
714	=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
715		918
716	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
717	specified one.	920	specified one.
718		921
719	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
…		…
740	};	943	};
741	}	944	}
742		945
743	no warnings 'utf8';	946	no warnings 'utf8';
744		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$name =~ y/-/./ if $isarg;
		952
		953	$term->scan_meta;
		954
		955	my $r = $term->{meta}{resource};
		956	keys %$r; # reste iterator
		957	while (my ($pattern, $v) = each %$r) {
		958	if (
		959	$pattern =~ /\.$/
		960	? $pattern eq substr $name, 0, length $pattern
		961	: $pattern eq $name
		962	) {
		963	$name = "$urxvt::RESCLASS.$name";
		964
		965	push @{ $term->{perl_ext_3} }, $v->[0];
		966
		967	if ($v->[1] eq "boolean") {
		968	$term->put_option_db ($name, $flag ? "true" : "false");
		969	return 1;
		970	} else {
		971	$term->put_option_db ($name, $value);
		972	return 1 + 2;
		973	}
		974	}
		975	}
		976
		977	0
		978	}
		979
		980	sub usage {
		981	my ($term, $usage_type) = @_;
		982
		983	$term->scan_meta;
		984
		985	my $r = $term->{meta}{resource};
		986
		987	for my $pattern (sort keys %$r) {
		988	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		989
		990	$desc .= " (-pe $ext)";
		991
		992	if ($usage_type == 1) {
		993	$pattern =~ y/./-/;
		994	$pattern =~ s/-$/-.../g;
		995
		996	if ($type eq "boolean") {
		997	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		998	} else {
		999	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		1000	}
		1001	} else {
		1002	$pattern =~ s/\.$/.*/g;
		1003	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1004	}
		1005	}
		1006	}
		1007
745	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1008	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
746		1009
747	sub verbose {	1010	sub verbose {
748	my ($level, $msg) = @_;	1011	my ($level, $msg) = @_;
749	warn "$msg\n" if $level <= $verbosity;	1012	warn "$msg\n" if $level <= $verbosity;
…		…
761	$pkg =~ s/[^[:word:]]/_/g;	1024	$pkg =~ s/[^[:word:]]/_/g;
762	$pkg = "urxvt::ext::$pkg";	1025	$pkg = "urxvt::ext::$pkg";
763		1026
764	verbose 3, "loading extension '$path' into package '$pkg'";	1027	verbose 3, "loading extension '$path' into package '$pkg'";
765		1028
		1029	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		1030
766	open my $fh, "<:raw", $path	1031	open my $fh, "<:raw", $path
767	or die "$path: $!";	1032	or die "$path: $!";
768		1033
769	my $source =	1034	my $source =
770	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	1035	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
771	. "#line 1 \"$path\"\n{\n"	1036	. "#line 1 \"$path\"\n{\n"
772	. (do { local $/; <$fh> })	1037	. (do { local $/; <$fh> })
773	. "\n};\n1";	1038	. "\n};\n1";
774		1039
775	eval $source	1040	eval $source
…		…
785	sub invoke {	1050	sub invoke {
786	local $TERM = shift;	1051	local $TERM = shift;
787	my $htype = shift;	1052	my $htype = shift;
788		1053
789	if ($htype == 0) { # INIT	1054	if ($htype == 0) { # INIT
790	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1055	my @dirs = $TERM->perl_libdirs;
791		1056
792	my %ext_arg;	1057	my %ext_arg;
793		1058
794	{	1059	{
795	my @init = @TERM_INIT;	1060	my @init = @TERM_INIT;
796	@TERM_INIT = ();	1061	@TERM_INIT = ();
…		…
798	my @pkg = @TERM_EXT;	1063	my @pkg = @TERM_EXT;
799	@TERM_EXT = ();	1064	@TERM_EXT = ();
800	$TERM->register_package ($_) for @pkg;	1065	$TERM->register_package ($_) for @pkg;
801	}	1066	}
802		1067
		1068	for (
		1069	@{ delete $TERM->{perl_ext_3} },
803	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1070	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1071	) {
804	if ($_ eq "default") {	1072	if ($_ eq "default") {
805	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	1073	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
806	} elsif (/^-(.*)$/) {	1074	} elsif (/^-(.*)$/) {
807	delete $ext_arg{$1};	1075	delete $ext_arg{$1};
808	} elsif (/^([^<]+)<(.*)>$/) {	1076	} elsif (/^([^<]+)<(.*)>$/) {
…		…
810	} else {	1078	} else {
811	$ext_arg{$_} ||= [];	1079	$ext_arg{$_} ||= [];
812	}	1080	}
813	}	1081	}
814		1082
815	while (my ($ext, $argv) = each %ext_arg) {	1083	for my $ext (sort keys %ext_arg) {
816	my @files = grep -f $_, map "$_/$ext", @dirs;	1084	my @files = grep -f $_, map "$_/$ext", @dirs;
817		1085
818	if (@files) {	1086	if (@files) {
819	$TERM->register_package (extension_package $files[0], $argv);	1087	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
820	} else {	1088	} else {
821	warn "perl extension '$ext' not found in perl library search path\n";	1089	warn "perl extension '$ext' not found in perl library search path\n";
822	}	1090	}
823	}	1091	}
824		1092
…		…
830		1098
831	if (my $cb = $TERM->{_hook}[$htype]) {	1099	if (my $cb = $TERM->{_hook}[$htype]) {
832	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1100	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
833	if $verbosity >= 10;	1101	if $verbosity >= 10;
834		1102
835	keys %$cb;	1103	for my $pkg (keys %$cb) {
836
837	while (my ($pkg, $cb) = each %$cb) {
838	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1104	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
839	$retval ||= $retval_;	1105	$retval ||= $retval_;
840		1106
841	if ($@) {	1107	if ($@) {
842	$TERM->ungrab; # better to lose the grab than the session	1108	$TERM->ungrab; # better to lose the grab than the session
843	warn $@;	1109	warn $@;
…		…
857	}	1123	}
858		1124
859	$retval	1125	$retval
860	}	1126	}
861		1127
862	# urxvt::term::extension	1128	sub SET_COLOR($$$) {
		1129	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1130	}
		1131
		1132	sub rend2mask {
		1133	no strict 'refs';
		1134	my ($str, $mask) = (@_, 0);
		1135	my %color = ( fg => undef, bg => undef );
		1136	my @failed;
		1137	for my $spec ( split /\s+/, $str ) {
		1138	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1139	$color{lc($1)} = $2;
		1140	} else {
		1141	my $neg = $spec =~ s/^[-^]//;
		1142	unless ( exists &{"RS_$spec"} ) {
		1143	push @failed, $spec;
		1144	next;
		1145	}
		1146	my $cur = &{"RS_$spec"};
		1147	if ( $neg ) {
		1148	$mask &= ~$cur;
		1149	} else {
		1150	$mask |= $cur;
		1151	}
		1152	}
		1153	}
		1154	($mask, @color{qw(fg bg)}, \@failed)
		1155	}
863		1156
864	package urxvt::term::extension;	1157	package urxvt::term::extension;
865		1158
866	sub enable {	1159	sub enable {
867	my ($self, %hook) = @_;	1160	my ($self, %hook) = @_;
…		…
922		1215
923	sub urxvt::destroy_hook(&) {	1216	sub urxvt::destroy_hook(&) {
924	bless \shift, urxvt::destroy_hook::	1217	bless \shift, urxvt::destroy_hook::
925	}	1218	}
926		1219
		1220	sub x_resource {
		1221	my ($self, $name) = @_;
		1222	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1223	$self->{term}->x_resource ($name)
		1224	}
		1225
		1226	sub x_resource_boolean {
		1227	my ($self, $name) = @_;
		1228	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1229	$self->{term}->x_resource_boolean ($name)
		1230	}
		1231
927	package urxvt::anyevent;	1232	package urxvt::anyevent;
928		1233
929	=head2 The C<urxvt::anyevent> Class	1234	=head2 The C<urxvt::anyevent> Class
930		1235
931	The sole purpose of this class is to deliver an interface to the	1236	The sole purpose of this class is to deliver an interface to the
932	C<AnyEvent> module - any module using it will work inside urxvt without	1237	C<AnyEvent> module - any module using it will work inside urxvt without
933	further programming. The only exception is that you cannot wait on	1238	further programming. The only exception is that you cannot wait on
934	condition variables, but non-blocking condvar use is ok. What this means	1239	condition variables, but non-blocking condvar use is ok.
935	is that you cannot use blocking APIs, but the non-blocking variant should	1240
936	work.	1241	In practical terms this means is that you cannot use blocking APIs, but
		1242	the non-blocking variant should work.
937		1243
938	=cut	1244	=cut
939		1245
940	our $VERSION = 1;	1246	our $VERSION = '5.23';
941		1247
942	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1248	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
943	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1249	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
944		1250
945	sub timer {	1251	sub timer {
…		…
947		1253
948	my $cb = $arg{cb};	1254	my $cb = $arg{cb};
949		1255
950	urxvt::timer	1256	urxvt::timer
951	->new	1257	->new
952	->start (urxvt::NOW + $arg{after})	1258	->after ($arg{after}, $arg{interval})
953	->cb (sub {	1259	->cb ($arg{interval} ? $cb : sub {
954	$_[0]->stop; # need to cancel manually	1260	$_[0]->stop; # need to cancel manually
955	$cb->();	1261	$cb->();
956	})	1262	})
957	}	1263	}
958		1264
959	sub io {	1265	sub io {
960	my ($class, %arg) = @_;	1266	my ($class, %arg) = @_;
961		1267
962	my $cb = $arg{cb};	1268	my $cb = $arg{cb};
		1269	my $fd = fileno $arg{fh};
		1270	defined $fd or $fd = $arg{fh};
963		1271
964	bless [$arg{fh}, urxvt::iow	1272	bless [$arg{fh}, urxvt::iow
965	->new	1273	->new
966	->fd (fileno $arg{fh})	1274	->fd ($fd)
967	->events (($arg{poll} =~ /r/ ? 1 : 0)	1275	->events (($arg{poll} =~ /r/ ? 1 : 0)
968	| ($arg{poll} =~ /w/ ? 2 : 0))	1276	| ($arg{poll} =~ /w/ ? 2 : 0))
969	->start	1277	->start
970	->cb (sub {	1278	->cb ($cb)
971	$cb->(($_[1] & 1 ? 'r' : '')
972	. ($_[1] & 2 ? 'w' : ''));
973	})],
974	urxvt::anyevent::	1279	], urxvt::anyevent::
		1280	}
		1281
		1282	sub idle {
		1283	my ($class, %arg) = @_;
		1284
		1285	my $cb = $arg{cb};
		1286
		1287	urxvt::iw
		1288	->new
		1289	->start
		1290	->cb ($cb)
		1291	}
		1292
		1293	sub child {
		1294	my ($class, %arg) = @_;
		1295
		1296	my $cb = $arg{cb};
		1297
		1298	urxvt::pw
		1299	->new
		1300	->start ($arg{pid})
		1301	->cb (sub {
		1302	$_[0]->stop; # need to cancel manually
		1303	$cb->($_[0]->rpid, $_[0]->rstatus);
		1304	})
975	}	1305	}
976		1306
977	sub DESTROY {	1307	sub DESTROY {
978	$_[0][1]->stop;	1308	$_[0][1]->stop;
979	}	1309	}
980		1310
981	sub condvar {	1311	# only needed for AnyEvent < 6 compatibility
982	bless \my $flag, urxvt::anyevent::condvar::	1312	sub one_event {
983	}
984
985	sub urxvt::anyevent::condvar::broadcast {
986	${$_[0]}++;
987	}
988
989	sub urxvt::anyevent::condvar::wait {
990	unless (${$_[0]}) {
991	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1313	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
992	}
993	}	1314	}
994		1315
995	package urxvt::term;	1316	package urxvt::term;
996		1317
997	=head2 The C<urxvt::term> Class	1318	=head2 The C<urxvt::term> Class
…		…
1010	urxvt::verbose 6, "register package $pkg to $self";	1331	urxvt::verbose 6, "register package $pkg to $self";
1011		1332
1012	@{"$pkg\::ISA"} = urxvt::term::extension::;	1333	@{"$pkg\::ISA"} = urxvt::term::extension::;
1013		1334
1014	my $proxy = bless {	1335	my $proxy = bless {
1015	_pkg => $pkg,	1336	_pkg => $pkg,
		1337	_name => ${"$pkg\::_NAME"}, # hackish
1016	argv => $argv,	1338	argv => $argv,
1017	}, $pkg;	1339	}, $pkg;
1018	Scalar::Util::weaken ($proxy->{term} = $self);	1340	Scalar::Util::weaken ($proxy->{term} = $self);
1019		1341
1020	$self->{_pkg}{$pkg} = $proxy;	1342	$self->{_pkg}{$pkg} = $proxy;
1021		1343
…		…
1024	$proxy->enable ($name => $ref);	1346	$proxy->enable ($name => $ref);
1025	}	1347	}
1026	}	1348	}
1027	}	1349	}
1028		1350
		1351	sub perl_libdirs {
		1352	map { split /:/ }
		1353	$_[0]->resource ("perl_lib"),
		1354	$ENV{URXVT_PERL_LIB},
		1355	"$ENV{HOME}/.urxvt/ext",
		1356	"$LIBDIR/perl"
		1357	}
		1358
		1359	sub scan_meta {
		1360	my ($self) = @_;
		1361	my @libdirs = perl_libdirs $self;
		1362
		1363	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1364
		1365	my %meta;
		1366
		1367	$self->{meta_libdirs} = join "\x00", @libdirs;
		1368	$self->{meta} = \%meta;
		1369
		1370	for my $dir (reverse @libdirs) {
		1371	opendir my $fh, $dir
		1372	or next;
		1373	for my $ext (readdir $fh) {
		1374	$ext ne "."
		1375	and $ext ne ".."
		1376	and open my $fh, "<", "$dir/$ext"
		1377	or next;
		1378
		1379	while (<$fh>) {
		1380	if (/^#:META:X_RESOURCE:(.*)/) {
		1381	my ($pattern, $type, $desc) = split /:/, $1;
		1382	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1383	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1384	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1385	} else {
		1386	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1387	}
		1388	} elsif (/^\s*(?:#|$)/) {
		1389	# skip other comments and empty lines
		1390	} else {
		1391	last; # stop parsing on first non-empty non-comment line
		1392	}
		1393	}
		1394	}
		1395	}
		1396	}
		1397
1029	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1398	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1030		1399
1031	Creates a new terminal, very similar as if you had started it with system	1400	Creates a new terminal, very similar as if you had started it with system
1032	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1401	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1033	hash which defines the environment of the new terminal.	1402	hash which defines the environment of the new terminal.
1034		1403
1035	Croaks (and probably outputs an error message) if the new instance	1404	Croaks (and probably outputs an error message) if the new instance
1036	couldn't be created. Returns C<undef> if the new instance didn't	1405	couldn't be created. Returns C<undef> if the new instance didn't
1037	initialise perl, and the terminal object otherwise. The C<init> and	1406	initialise perl, and the terminal object otherwise. The C<init> and
1038	C<start> hooks will be called during this call.	1407	C<start> hooks will be called before this call returns, and are free to
		1408	refer to global data (which is race free).
1039		1409
1040	=cut	1410	=cut
1041		1411
1042	sub new {	1412	sub new {
1043	my ($class, $env, @args) = @_;	1413	my ($class, $env, @args) = @_;
1044		1414
		1415	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1416	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1417
1045	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1418	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1046	}	1419	}
1047		1420
1048	=item $term->destroy	1421	=item $term->destroy
1049		1422
1050	Destroy the terminal object (close the window, free resources	1423	Destroy the terminal object (close the window, free resources
…		…
1080		1453
1081	Returns true if the option specified by C<$optval> is enabled, and	1454	Returns true if the option specified by C<$optval> is enabled, and
1082	optionally change it. All option values are stored by name in the hash	1455	optionally change it. All option values are stored by name in the hash
1083	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1456	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1084		1457
1085	Here is a a likely non-exhaustive list of option names, please see the	1458	Here is a likely non-exhaustive list of option names, please see the
1086	source file F</src/optinc.h> to see the actual list:	1459	source file F</src/optinc.h> to see the actual list:
1087		1460
1088	borderLess console cursorBlink cursorUnderline hold iconic insecure	1461	borderLess buffered console cursorBlink cursorUnderline hold iconic
1089	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1462	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1090	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1463	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1091	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1464	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1092	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1465	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1093	transparent tripleclickwords utmpInhibit visualBell	1466	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1467	urgentOnBell utmpInhibit visualBell
1094		1468
1095	=item $value = $term->resource ($name[, $newval])	1469	=item $value = $term->resource ($name[, $newval])
1096		1470
1097	Returns the current resource value associated with a given name and	1471	Returns the current resource value associated with a given name and
1098	optionally sets a new value. Setting values is most useful in the C<init>	1472	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1107	likely change).	1481	likely change).
1108		1482
1109	Please note that resource strings will currently only be freed when the	1483	Please note that resource strings will currently only be freed when the
1110	terminal is destroyed, so changing options frequently will eat memory.	1484	terminal is destroyed, so changing options frequently will eat memory.
1111		1485
1112	Here is a a likely non-exhaustive list of resource names, not all of which	1486	Here is a likely non-exhaustive list of resource names, not all of which
1113	are supported in every build, please see the source file F</src/rsinc.h>	1487	are supported in every build, please see the source file F</src/rsinc.h>
1114	to see the actual list:	1488	to see the actual list:
1115		1489
1116	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1490	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1117	borderLess color cursorBlink cursorUnderline cutchars delete_key	1491	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1118	display_name embed ext_bwidth fade font geometry hold iconName	1492	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1119	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1493	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1494	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1120	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1495	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1121	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1496	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1122	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1497	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1123	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1498	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1124	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1499	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1125	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1500	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1126	secondaryScreen secondaryScroll selectstyle shade term_name title	1501	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1127	transient_for transparent transparent_all tripleclickwords utmpInhibit	1502	term_name title transient_for transparent tripleclickwords urgentOnBell
1128	visualBell	1503	utmpInhibit visualBell
1129		1504
1130	=cut	1505	=cut
1131		1506
1132	sub resource($$;$) {	1507	sub resource($$;$) {
1133	my ($self, $name) = (shift, shift);	1508	my ($self, $name) = (shift, shift);
1134	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1509	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1135	&urxvt::term::_resource	1510	goto &urxvt::term::_resource
1136	}	1511	}
1137		1512
1138	=item $value = $term->x_resource ($pattern)	1513	=item $value = $term->x_resource ($pattern)
1139		1514
1140	Returns the X-Resource for the given pattern, excluding the program or	1515	Returns the X-Resource for the given pattern, excluding the program or
1141	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1516	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1142	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1517	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1143	resource with that pattern exists.	1518	resource with that pattern exists.
1144		1519
		1520	Extensions that define extra resource or command line arguments also need
		1521	to call this method to access their values.
		1522
		1523	If the method is called on an extension object (basically, from an
		1524	extension), then the special prefix C<%.> will be replaced by the name of
		1525	the extension and a dot, and the lone string C<%> will be replcaed by the
		1526	extension name itself. This makes it possible to code extensions so you
		1527	can rename them and get a new set of commandline switches and resources
		1528	without having to change the actual code.
		1529
1145	This method should only be called during the C<on_start> hook, as there is	1530	This method should only be called during the C<on_start> hook, as there is
1146	only one resource database per display, and later invocations might return	1531	only one resource database per display, and later invocations might return
1147	the wrong resources.	1532	the wrong resources.
1148		1533
1149	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1534	=item $value = $term->x_resource_boolean ($pattern)
1150		1535
		1536	Like C<x_resource>, above, but interprets the string value as a boolean
		1537	and returns C<1> for true values, C<0> for false values and C<undef> if
		1538	the resource or option isn't specified.
		1539
		1540	You should always use this method to parse boolean resources.
		1541
		1542	=cut
		1543
		1544	sub x_resource_boolean {
		1545	my $res = &x_resource;
		1546
		1547	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1548	}
		1549
		1550	=item $success = $term->parse_keysym ($key, $octets)
		1551
1151	Adds a keymap translation exactly as specified via a resource. See the	1552	Adds a key binding exactly as specified via a resource. See the
1152	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1553	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1554
		1555	=item $term->register_command ($keysym, $modifiermask, $string)
		1556
		1557	Adds a key binding. This is a lower level api compared to
		1558	C<parse_keysym>, as it expects a parsed key description, and can be
		1559	used only inside either the C<on_init> hook, to add a binding, or the
		1560	C<on_register_command> hook, to modify a parsed binding.
1153		1561
1154	=item $rend = $term->rstyle ([$new_rstyle])	1562	=item $rend = $term->rstyle ([$new_rstyle])
1155		1563
1156	Return and optionally change the current rendition. Text that is output by	1564	Return and optionally change the current rendition. Text that is output by
1157	the terminal application will use this style.	1565	the terminal application will use this style.
…		…
1165		1573
1166	=item ($row, $col) = $term->selection_beg ([$row, $col])	1574	=item ($row, $col) = $term->selection_beg ([$row, $col])
1167		1575
1168	=item ($row, $col) = $term->selection_end ([$row, $col])	1576	=item ($row, $col) = $term->selection_end ([$row, $col])
1169		1577
1170	Return the current values of the selection mark, begin or end positions,	1578	Return the current values of the selection mark, begin or end positions.
1171	and optionally set them to new values.	1579
		1580	When arguments are given, then the selection coordinates are set to
		1581	C<$row> and C<$col>, and the selection screen is set to the current
		1582	screen.
		1583
		1584	=item $screen = $term->selection_screen ([$screen])
		1585
		1586	Returns the current selection screen, and then optionally sets it.
1172		1587
1173	=item $term->selection_make ($eventtime[, $rectangular])	1588	=item $term->selection_make ($eventtime[, $rectangular])
1174		1589
1175	Tries to make a selection as set by C<selection_beg> and	1590	Tries to make a selection as set by C<selection_beg> and
1176	C<selection_end>. If C<$rectangular> is true (default: false), a	1591	C<selection_end>. If C<$rectangular> is true (default: false), a
1177	rectangular selection will be made. This is the prefered function to make	1592	rectangular selection will be made. This is the preferred function to make
1178	a selection.	1593	a selection.
1179		1594
1180	=item $success = $term->selection_grab ($eventtime)	1595	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1181		1596
1182	Try to request the primary selection text from the server (for example, as	1597	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1598	true) selection from the server. The corresponding text can be set
1183	set by the next method). No visual feedback will be given. This function	1599	with the next method. No visual feedback will be given. This function
1184	is mostly useful from within C<on_sel_grab> hooks.	1600	is mostly useful from within C<on_sel_grab> hooks.
1185		1601
1186	=item $oldtext = $term->selection ([$newtext])	1602	=item $oldtext = $term->selection ([$newtext, $clipboard])
1187		1603
1188	Return the current selection text and optionally replace it by C<$newtext>.	1604	Return the current selection (clipboard if C<$clipboard> is true) text
		1605	and optionally replace it by C<$newtext>.
		1606
		1607	=item $term->selection_clear ([$clipboard])
		1608
		1609	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1189		1610
1190	=item $term->overlay_simple ($x, $y, $text)	1611	=item $term->overlay_simple ($x, $y, $text)
1191		1612
1192	Create a simple multi-line overlay box. See the next method for details.	1613	Create a simple multi-line overlay box. See the next method for details.
1193		1614
…		…
1223		1644
1224	The methods currently supported on C<urxvt::overlay> objects are:	1645	The methods currently supported on C<urxvt::overlay> objects are:
1225		1646
1226	=over 4	1647	=over 4
1227		1648
1228	=item $overlay->set ($x, $y, $text, $rend)	1649	=item $overlay->set ($x, $y, $text[, $rend])
1229		1650
1230	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1651	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1231	text in rxvt-unicode's special encoding and an array of rendition values	1652	text in rxvt-unicode's special encoding and an array of rendition values
1232	at a specific position inside the overlay.	1653	at a specific position inside the overlay.
		1654
		1655	If C<$rend> is missing, then the rendition will not be changed.
1233		1656
1234	=item $overlay->hide	1657	=item $overlay->hide
1235		1658
1236	If visible, hide the overlay, but do not destroy it.	1659	If visible, hide the overlay, but do not destroy it.
1237		1660
…		…
1319	locale-specific encoding of the terminal and can contain command sequences	1742	locale-specific encoding of the terminal and can contain command sequences
1320	(escape codes) that will be interpreted.	1743	(escape codes) that will be interpreted.
1321		1744
1322	=item $term->tt_write ($octets)	1745	=item $term->tt_write ($octets)
1323		1746
1324	Write the octets given in C<$data> to the tty (i.e. as program input). To	1747	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1325	pass characters instead of octets, you should convert your strings first	1748	pass characters instead of octets, you should convert your strings first
1326	to the locale-specific encoding using C<< $term->locale_encode >>.	1749	to the locale-specific encoding using C<< $term->locale_encode >>.
		1750
		1751	=item $term->tt_paste ($octets)
		1752
		1753	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1754	CR and bracketing the data with control sequences if bracketed paste mode
		1755	is set.
1327		1756
1328	=item $old_events = $term->pty_ev_events ([$new_events])	1757	=item $old_events = $term->pty_ev_events ([$new_events])
1329		1758
1330	Replaces the event mask of the pty watcher by the given event mask. Can	1759	Replaces the event mask of the pty watcher by the given event mask. Can
1331	be used to suppress input and output handling to the pty/tty. See the	1760	be used to suppress input and output handling to the pty/tty. See the
…		…
1350	Adds the specified events to the vt event mask. Useful e.g. when you want	1779	Adds the specified events to the vt event mask. Useful e.g. when you want
1351	to receive pointer events all the times:	1780	to receive pointer events all the times:
1352		1781
1353	$term->vt_emask_add (urxvt::PointerMotionMask);	1782	$term->vt_emask_add (urxvt::PointerMotionMask);
1354		1783
		1784	=item $term->set_urgency ($set)
		1785
		1786	Enable/disable the urgency hint on the toplevel window.
		1787
		1788	=item $term->focus_in
		1789
		1790	=item $term->focus_out
		1791
		1792	=item $term->key_press ($state, $keycode[, $time])
		1793
		1794	=item $term->key_release ($state, $keycode[, $time])
		1795
		1796	Deliver various fake events to to terminal.
		1797
1355	=item $window_width = $term->width	1798	=item $window_width = $term->width
1356		1799
1357	=item $window_height = $term->height	1800	=item $window_height = $term->height
1358		1801
1359	=item $font_width = $term->fwidth	1802	=item $font_width = $term->fwidth
…		…
1389	=item $env = $term->env	1832	=item $env = $term->env
1390		1833
1391	Returns a copy of the environment in effect for the terminal as a hashref	1834	Returns a copy of the environment in effect for the terminal as a hashref
1392	similar to C<\%ENV>.	1835	similar to C<\%ENV>.
1393		1836
		1837	=item @envv = $term->envv
		1838
		1839	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1840
		1841	=item @argv = $term->argv
		1842
		1843	Return the argument vector as this terminal, similar to @ARGV, but
		1844	includes the program name as first element.
		1845
1394	=cut	1846	=cut
1395		1847
1396	sub env {	1848	sub env {
1397	if (my $env = $_[0]->_env) {
1398	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1849	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1399	} else {
1400	+{ %ENV }
1401	}
1402	}	1850	}
1403		1851
1404	=item $modifiermask = $term->ModLevel3Mask	1852	=item $modifiermask = $term->ModLevel3Mask
1405		1853
1406	=item $modifiermask = $term->ModMetaMask	1854	=item $modifiermask = $term->ModMetaMask
…		…
1414		1862
1415	Returns the currently displayed screen (0 primary, 1 secondary).	1863	Returns the currently displayed screen (0 primary, 1 secondary).
1416		1864
1417	=item $cursor_is_hidden = $term->hidden_cursor	1865	=item $cursor_is_hidden = $term->hidden_cursor
1418		1866
1419	Returns wether the cursor is currently hidden or not.	1867	Returns whether the cursor is currently hidden or not.
1420		1868
1421	=item $view_start = $term->view_start ([$newvalue])	1869	=item $view_start = $term->view_start ([$newvalue])
1422		1870
1423	Returns the row number of the topmost displayed line. Maximum value is	1871	Returns the row number of the topmost displayed line. Maximum value is
1424	C<0>, which displays the normal terminal contents. Lower values scroll	1872	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1432		1880
1433	Used after changing terminal contents to display them.	1881	Used after changing terminal contents to display them.
1434		1882
1435	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1883	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1436		1884
1437	Returns the text of the entire row with number C<$row_number>. Row C<0>	1885	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1438	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1886	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1439	terminal line. The scrollback buffer starts at line C<-1> and extends to
1440	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1887	terminal line. Nothing will be returned if a nonexistent line
1441	is requested.	1888	is requested.
1442		1889
1443	If C<$new_text> is specified, it will replace characters in the current	1890	If C<$new_text> is specified, it will replace characters in the current
1444	line, starting at column C<$start_col> (default C<0>), which is useful	1891	line, starting at column C<$start_col> (default C<0>), which is useful
1445	to replace only parts of a line. The font index in the rendition will	1892	to replace only parts of a line. The font index in the rendition will
1446	automatically be updated.	1893	automatically be updated.
1447		1894
1448	C<$text> is in a special encoding: tabs and wide characters that use more	1895	C<$text> is in a special encoding: tabs and wide characters that use more
1449	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1896	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1450	characters. Characters with combining characters and other characters that	1897	characters. Characters with combining characters and other characters that
1451	do not fit into the normal tetx encoding will be replaced with characters	1898	do not fit into the normal text encoding will be replaced with characters
1452	in the private use area.	1899	in the private use area.
1453		1900
1454	You have to obey this encoding when changing text. The advantage is	1901	You have to obey this encoding when changing text. The advantage is
1455	that C<substr> and similar functions work on screen cells and not on	1902	that C<substr> and similar functions work on screen cells and not on
1456	characters.	1903	characters.
…		…
1601	where one character corresponds to one screen cell. See	2048	where one character corresponds to one screen cell. See
1602	C<< $term->ROW_t >> for details.	2049	C<< $term->ROW_t >> for details.
1603		2050
1604	=item $string = $term->special_decode $text	2051	=item $string = $term->special_decode $text
1605		2052
1606	Converts rxvt-unicodes text reprsentation into a perl string. See	2053	Converts rxvt-unicodes text representation into a perl string. See
1607	C<< $term->ROW_t >> for details.	2054	C<< $term->ROW_t >> for details.
1608		2055
1609	=item $success = $term->grab_button ($button, $modifiermask)	2056	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1610		2057
		2058	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2059
1611	Registers a synchronous button grab. See the XGrabButton manpage.	2060	Register/unregister a synchronous button grab. See the XGrabButton
		2061	manpage.
1612		2062
1613	=item $success = $term->grab ($eventtime[, $sync])	2063	=item $success = $term->grab ($eventtime[, $sync])
1614		2064
1615	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2065	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1616	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2066	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1617		2067
1618	=item $term->allow_events_async	2068	=item $term->allow_events_async
1619		2069
1620	Calls XAllowEvents with AsyncBoth for the most recent grab.	2070	Calls XAllowEvents with AsyncBoth for the most recent grab.
1621		2071
…		…
1628	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2078	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1629	recent grab.	2079	recent grab.
1630		2080
1631	=item $term->ungrab	2081	=item $term->ungrab
1632		2082
1633	Calls XUngrab for the most recent grab. Is called automatically on	2083	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1634	evaluation errors, as it is better to lose the grab in the error case as	2084	evaluation errors, as it is better to lose the grab in the error case as
1635	the session.	2085	the session.
1636		2086
1637	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2087	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1638		2088
…		…
1640		2090
1641	=item @atoms = $term->XListProperties ($window)	2091	=item @atoms = $term->XListProperties ($window)
1642		2092
1643	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2093	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1644		2094
1645	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2095	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1646		2096
1647	=item $term->XDeleteProperty ($window, $property)	2097	=item $term->XDeleteProperty ($window, $property)
1648		2098
1649	=item $window = $term->DefaultRootWindow	2099	=item $window = $term->DefaultRootWindow
1650		2100
…		…
1657	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2107	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1658		2108
1659	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2109	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1660		2110
1661	=item $term->XChangeInput ($window, $add_events[, $del_events])	2111	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2112
		2113	=item $keysym = $term->XStringToKeysym ($string)
		2114
		2115	=item $string = $term->XKeysymToString ($keysym)
1662		2116
1663	Various X or X-related functions. The C<$term> object only serves as	2117	Various X or X-related functions. The C<$term> object only serves as
1664	the source of the display, otherwise those functions map more-or-less	2118	the source of the display, otherwise those functions map more-or-less
1665	directory onto the X functions of the same name.	2119	directly onto the X functions of the same name.
1666		2120
1667	=back	2121	=back
1668		2122
1669	=cut	2123	=cut
1670		2124
…		…
1734	my ($self, $text, $cb) = @_;	2188	my ($self, $text, $cb) = @_;
1735		2189
1736	$self->add_item ({ type => "button", text => $text, activate => $cb});	2190	$self->add_item ({ type => "button", text => $text, activate => $cb});
1737	}	2191	}
1738		2192
1739	=item $popup->add_toggle ($text, $cb, $initial_value)	2193	=item $popup->add_toggle ($text, $initial_value, $cb)
1740		2194
1741	Adds a toggle/checkbox item to the popup. Teh callback gets called	2195	Adds a toggle/checkbox item to the popup. The callback gets called
1742	whenever it gets toggled, with a boolean indicating its value as its first	2196	whenever it gets toggled, with a boolean indicating its new value as its
1743	argument.	2197	first argument.
1744		2198
1745	=cut	2199	=cut
1746		2200
1747	sub add_toggle {	2201	sub add_toggle {
1748	my ($self, $text, $cb, $value) = @_;	2202	my ($self, $text, $value, $cb) = @_;
1749		2203
1750	my $item; $item = {	2204	my $item; $item = {
1751	type => "button",	2205	type => "button",
1752	text => " $text",	2206	text => " $text",
1753	value => $value,	2207	value => $value,
…		…
1772	my $env = $self->{term}->env;	2226	my $env = $self->{term}->env;
1773	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2227	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1774	delete $env->{LC_ALL};	2228	delete $env->{LC_ALL};
1775	$env->{LC_CTYPE} = $self->{term}->locale;	2229	$env->{LC_CTYPE} = $self->{term}->locale;
1776		2230
1777	urxvt::term->new ($env, "popup",	2231	my $term = urxvt::term->new (
		2232	$env, "popup",
1778	"--perl-lib" => "", "--perl-ext-common" => "",	2233	"--perl-lib" => "", "--perl-ext-common" => "",
1779	"-pty-fd" => -1, "-sl" => 0,	2234	"-pty-fd" => -1, "-sl" => 0,
1780	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2235	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1781	"--transient-for" => $self->{term}->parent,	2236	"--transient-for" => $self->{term}->parent,
1782	"-display" => $self->{term}->display_id,	2237	"-display" => $self->{term}->display_id,
1783	"-pe" => "urxvt-popup")	2238	"-pe" => "urxvt-popup",
1784	or die "unable to create popup window\n";	2239	) or die "unable to create popup window\n";
		2240
		2241	unless (delete $term->{urxvt_popup_init_done}) {
		2242	$term->ungrab;
		2243	$term->destroy;
		2244	die "unable to initialise popup window\n";
		2245	}
1785	}	2246	}
1786		2247
1787	sub DESTROY {	2248	sub DESTROY {
1788	my ($self) = @_;	2249	my ($self) = @_;
1789		2250
…		…
1794	=back	2255	=back
1795		2256
1796	=cut	2257	=cut
1797		2258
1798	package urxvt::watcher;	2259	package urxvt::watcher;
1799
1800	@urxvt::timer::ISA = __PACKAGE__;
1801	@urxvt::iow::ISA = __PACKAGE__;
1802	@urxvt::pw::ISA = __PACKAGE__;
1803	@urxvt::iw::ISA = __PACKAGE__;
1804		2260
1805	=head2 The C<urxvt::timer> Class	2261	=head2 The C<urxvt::timer> Class
1806		2262
1807	This class implements timer watchers/events. Time is represented as a	2263	This class implements timer watchers/events. Time is represented as a
1808	fractional number of seconds since the epoch. Example:	2264	fractional number of seconds since the epoch. Example:
…		…
1812	->new	2268	->new
1813	->interval (1)	2269	->interval (1)
1814	->cb (sub {	2270	->cb (sub {
1815	$term->{overlay}->set (0, 0,	2271	$term->{overlay}->set (0, 0,
1816	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2272	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1817	});	2273	});
1818		2274
1819	=over 4	2275	=over 4
1820		2276
1821	=item $timer = new urxvt::timer	2277	=item $timer = new urxvt::timer
1822		2278
…		…
1825		2281
1826	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2282	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1827		2283
1828	Set the callback to be called when the timer triggers.	2284	Set the callback to be called when the timer triggers.
1829		2285
1830	=item $tstamp = $timer->at
1831
1832	Return the time this watcher will fire next.
1833
1834	=item $timer = $timer->set ($tstamp)	2286	=item $timer = $timer->set ($tstamp[, $interval])
1835		2287
1836	Set the time the event is generated to $tstamp.	2288	Set the time the event is generated to $tstamp (and optionally specifies a
		2289	new $interval).
1837		2290
1838	=item $timer = $timer->interval ($interval)	2291	=item $timer = $timer->interval ($interval)
1839		2292
1840	Normally (and when C<$interval> is C<0>), the timer will automatically	2293	By default (and when C<$interval> is C<0>), the timer will automatically
1841	stop after it has fired once. If C<$interval> is non-zero, then the timer	2294	stop after it has fired once. If C<$interval> is non-zero, then the timer
1842	is automatically rescheduled at the given intervals.	2295	is automatically rescheduled at the given intervals.
1843		2296
1844	=item $timer = $timer->start	2297	=item $timer = $timer->start
1845		2298
1846	Start the timer.	2299	Start the timer.
1847		2300
1848	=item $timer = $timer->start ($tstamp)	2301	=item $timer = $timer->start ($tstamp[, $interval])
1849		2302
1850	Set the event trigger time to C<$tstamp> and start the timer.	2303	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2304	also replaces the interval.
1851		2305
1852	=item $timer = $timer->after ($delay)	2306	=item $timer = $timer->after ($delay[, $interval])
1853		2307
1854	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2308	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1855		2309
1856	=item $timer = $timer->stop	2310	=item $timer = $timer->stop
1857		2311
…		…
1865		2319
1866	$term->{socket} = ...	2320	$term->{socket} = ...
1867	$term->{iow} = urxvt::iow	2321	$term->{iow} = urxvt::iow
1868	->new	2322	->new
1869	->fd (fileno $term->{socket})	2323	->fd (fileno $term->{socket})
1870	->events (urxvt::EVENT_READ)	2324	->events (urxvt::EV_READ)
1871	->start	2325	->start
1872	->cb (sub {	2326	->cb (sub {
1873	my ($iow, $revents) = @_;	2327	my ($iow, $revents) = @_;
1874	# $revents must be 1 here, no need to check	2328	# $revents must be 1 here, no need to check
1875	sysread $term->{socket}, my $buf, 8192	2329	sysread $term->{socket}, my $buf, 8192
…		…
1888	Set the callback to be called when io events are triggered. C<$reventmask>	2342	Set the callback to be called when io events are triggered. C<$reventmask>
1889	is a bitset as described in the C<events> method.	2343	is a bitset as described in the C<events> method.
1890		2344
1891	=item $iow = $iow->fd ($fd)	2345	=item $iow = $iow->fd ($fd)
1892		2346
1893	Set the filedescriptor (not handle) to watch.	2347	Set the file descriptor (not handle) to watch.
1894		2348
1895	=item $iow = $iow->events ($eventmask)	2349	=item $iow = $iow->events ($eventmask)
1896		2350
1897	Set the event mask to watch. The only allowed values are	2351	Set the event mask to watch. The only allowed values are
1898	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2352	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1899	together, or C<urxvt::EVENT_NONE>.	2353	together, or C<urxvt::EV_NONE>.
1900		2354
1901	=item $iow = $iow->start	2355	=item $iow = $iow->start
1902		2356
1903	Start watching for requested events on the given handle.	2357	Start watching for requested events on the given handle.
1904		2358
1905	=item $iow = $iow->stop	2359	=item $iow = $iow->stop
1906		2360
1907	Stop watching for events on the given filehandle.	2361	Stop watching for events on the given file handle.
1908		2362
1909	=back	2363	=back
1910		2364
1911	=head2 The C<urxvt::iw> Class	2365	=head2 The C<urxvt::iw> Class
1912		2366
…		…
1945	->new	2399	->new
1946	->start ($pid)	2400	->start ($pid)
1947	->cb (sub {	2401	->cb (sub {
1948	my ($pw, $exit_status) = @_;	2402	my ($pw, $exit_status) = @_;
1949	...	2403	...
1950	});	2404	});
1951		2405
1952	=over 4	2406	=over 4
1953		2407
1954	=item $pw = new urxvt::pw	2408	=item $pw = new urxvt::pw
1955		2409
…		…
1959		2413
1960	Set the callback to be called when the timer triggers.	2414	Set the callback to be called when the timer triggers.
1961		2415
1962	=item $pw = $timer->start ($pid)	2416	=item $pw = $timer->start ($pid)
1963		2417
1964	Tells the wqtcher to start watching for process C<$pid>.	2418	Tells the watcher to start watching for process C<$pid>.
1965		2419
1966	=item $pw = $pw->stop	2420	=item $pw = $pw->stop
1967		2421
1968	Stop the watcher.	2422	Stop the watcher.
1969		2423
…		…
1982		2436
1983	=item >= 3 - script loading and management	2437	=item >= 3 - script loading and management
1984		2438
1985	=item >=10 - all called hooks	2439	=item >=10 - all called hooks
1986		2440
1987	=item >=11 - hook reutrn values	2441	=item >=11 - hook return values
1988		2442
1989	=back	2443	=back
1990		2444
1991	=head1 AUTHOR	2445	=head1 AUTHOR
1992		2446
1993	Marc Lehmann <pcg@goof.com>	2447	Marc Lehmann <schmorp@schmorp.de>
1994	http://software.schmorp.de/pkg/rxvt-unicode	2448	http://software.schmorp.de/pkg/rxvt-unicode
1995		2449
1996	=cut	2450	=cut
1997		2451
1998	1	2452	1
		2453
		2454	# vim: sw=3:

Diff Legend

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