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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.126 by root, Tue Jan 24 19:14:36 2006 UTC vs.
Revision 1.185 by sf-exg, Fri Jul 2 12:44:45 2010 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
…		…
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.
216		258
217	=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.
218		263
219	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 from the keyboard.
220	to the window position, in effect creating the same effect as pseudo transparency with	265	Simply bind a keysym to "perl:matcher" as seen in the example below.
221	a custom pixmap. No scaling is supported in this mode. Exmaple:
222		266
223	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
224		313
225	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
226		315
227	A not very useful example of filtering all text output to the terminal,	316	A not very useful example of filtering all text output to the terminal
228	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
229	similar-looking ascii character.	318	similar-looking ascii character.
230		319
231	=item digital-clock	320	=item digital-clock
232		321
233	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
		323
		324	=item remote-clipboard
		325
		326	Somewhat of a misnomer, this extension adds two menu entries to the
		327	selection popup that allows one to run external commands to store the
		328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		343
		344	=item selection-pastebin
		345
		346	This is a little rarely useful extension that uploads the selection as
		347	textfile to a remote site (or does other things). (The implementation is
		348	not currently secure for use in a multiuser environment as it writes to
		349	F</tmp> directly.).
		350
		351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		352	i.e.
		353
		354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		355
		356	Pressing this combination runs a command with C<%> replaced by the name of
		357	the textfile. This command can be set via a resource:
		358
		359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		360
		361	And the default is likely not useful to anybody but the few people around
		362	here :)
		363
		364	The name of the textfile is the hex encoded md5 sum of the selection, so
		365	the same content should lead to the same filename.
		366
		367	After a successful upload the selection will be replaced by the text given
		368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		369	for the filename):
		370
		371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of whether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
234		391
235	=item example-refresh-hooks	392	=item example-refresh-hooks
236		393
237	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
238	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
239	overlays or changes.	396	overlays or changes.
240
241	=item selection-pastebin
242
243	This is a little rarely useful extension that Uploads the selection as
244	textfile to a remote site (or does other things). (The implementation is
245	not currently secure for use in a multiuser environment as it writes to
246	F</tmp> directly.).
247
248	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
249	i.e.
250
251	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
252
253	Pressing this combination runs a command with C<%> replaced by the name of
254	the textfile. This command can be set via a resource:
255
256	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
257
258	And the default is likely not useful to anybody but the few people around
259	here :)
260
261	The name of the textfile is the hex encoded md5 sum of the selection, so
262	the same content should lead to the same filename.
263
264	After a successful upload the selection will be replaced by the text given
265	in the C<selection-pastebin-url> resource (again, the % is the placeholder
266	for the filename):
267
268	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
269		397
270	=back	398	=back
271		399
272	=head1 API DOCUMENTATION	400	=head1 API DOCUMENTATION
273		401
…		…
289		417
290	=over 4	418	=over 4
291		419
292	=item $text	420	=item $text
293		421
294	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
295	always represents one screen cell. See L<ROW_t> for a discussion of this format.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
296		424
297	=item $string	425	=item $string
298		426
299	A perl text string, with an emphasis on I<text>. It can store all unicode	427	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
307		435
308	=back	436	=back
309		437
310	=head2 Extension Objects	438	=head2 Extension Objects
311		439
312	Very perl extension is a perl class. A separate perl object is created	440	Every perl extension is a perl class. A separate perl object is created
313	for each terminal and each extension and passed as the first parameter to	441	for each terminal, and each terminal has its own set of extenion objects,
314	hooks. So extensions can use their C<$self> object without having to think	442	which are passed as the first parameter to hooks. So extensions can use
315	about other extensions, with the exception of methods and members that	443	their C<$self> object without having to think about clashes with other
		444	extensions or other terminals, with the exception of methods and members
316	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
317	use.	446	internal use.
318		447
319	Although it isn't a C<urxvt::term> object, you can call all methods of the	448	Although it isn't a C<urxvt::term> object, you can call all methods of the
320	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
321		450
322	It has the following methods and data members:	451	It has the following methods and data members:
…		…
343	=head2 Hooks	472	=head2 Hooks
344		473
345	The following subroutines can be declared in extension files, and will be	474	The following subroutines can be declared in extension files, and will be
346	called whenever the relevant event happens.	475	called whenever the relevant event happens.
347		476
348	The first argument passed to them is an extension oject as described in	477	The first argument passed to them is an extension object as described in
349	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
350		479
351	B<All> of these hooks must return a boolean value. If any of the called	480	B<All> of these hooks must return a boolean value. If any of the called
352	hooks returns true, then the event counts as being I<consumed>, and the	481	hooks returns true, then the event counts as being I<consumed>, and the
353	relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
…		…
366	place.	495	place.
367		496
368	=item on_start $term	497	=item on_start $term
369		498
370	Called at the very end of initialisation of a new terminal, just before	499	Called at the very end of initialisation of a new terminal, just before
371	trying to map (display) the toplevel and returning to the mainloop.	500	trying to map (display) the toplevel and returning to the main loop.
372		501
373	=item on_destroy $term	502	=item on_destroy $term
374		503
375	Called whenever something tries to destroy terminal, before doing anything	504	Called whenever something tries to destroy terminal, when the terminal is
376	yet. If this hook returns true, then destruction is skipped, but this is	505	still fully functional (not for long, though).
377	rarely a good idea.
378		506
379	=item on_reset $term	507	=item on_reset $term
380		508
381	Called after the screen is "reset" for any reason, such as resizing or	509	Called after the screen is "reset" for any reason, such as resizing or
382	control sequences. Here is where you can react on changes to size-related	510	control sequences. Here is where you can react on changes to size-related
…		…
404		532
405	Called whenever a selection has been copied, but before the selection is	533	Called whenever a selection has been copied, but before the selection is
406	requested from the server. The selection text can be queried and changed	534	requested from the server. The selection text can be queried and changed
407	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
408		536
409	Returning a true value aborts selection grabbing. It will still be hilighted.	537	Returning a true value aborts selection grabbing. It will still be highlighted.
410		538
411	=item on_sel_extend $term	539	=item on_sel_extend $term
412		540
413	Called whenever the user tries to extend the selection (e.g. with a double	541	Called whenever the user tries to extend the selection (e.g. with a double
414	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
415	should extend the selection itelf and return true to suppress the built-in	543	should extend the selection itself and return true to suppress the built-in
416	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
417	returns true, it will be called on every further click by the user and is	545	returns true, it will be called on every further click by the user and is
418	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
419		547
420	See the F<selection> example extension.	548	See the F<selection> example extension.
421		549
422	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
423		551
424	Called whenever the view offset changes, i..e the user or program	552	Called whenever the view offset changes, i.e. the user or program
425	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
426	show this many lines of scrollback.	554	show this many lines of scrollback.
427		555
428	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
429		557
…		…
433		561
434	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
435	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
436	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
437		565
438	=item on_osc_seq $term, $string	566	=item on_osc_seq $term, $op, $args, $resp
		567
		568	Called on every OSC sequence and can be used to suppress it or modify its
		569	behaviour. The default should be to return an empty list. A true value
		570	suppresses execution of the request completely. Make sure you don't get
		571	confused by recursive invocations when you output an OSC sequence within
		572	this callback.
		573
		574	C<on_osc_seq_perl> should be used for new behaviour.
		575
		576	=item on_osc_seq_perl $term, $args, $resp
439		577
440	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
441	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
442	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
443	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
444	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
445	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
446		594
447	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
448	as its source can not easily be controleld (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
449	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
450		601
451	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
452		603
453	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
454	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
…		…
475	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
476	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
477		628
478	=item on_refresh_begin $term	629	=item on_refresh_begin $term
479		630
480	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
481	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
482	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
483	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
484		635
485	=item on_refresh_end $term	636	=item on_refresh_end $term
486		637
487	Called just after the screen gets redrawn. See C<on_refresh_begin>.	638	Called just after the screen gets redrawn. See C<on_refresh_begin>.
488		639
489	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
490		641
491	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
492	C<perl:string> action bound to it (see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
493	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
		645
		646	The event is simply the action string. This interface is assumed to change
		647	slightly in the future.
		648
		649	=item on_resize_all_windows $tern, $new_width, $new_height
		650
		651	Called just after the new window size has been calculated, but before
		652	windows are actually being resized or hints are being set. If this hook
		653	returns TRUE, setting of the window hints is being skipped.
494		654
495	=item on_x_event $term, $event	655	=item on_x_event $term, $event
496		656
497	Called on every X event received on the vt window (and possibly other	657	Called on every X event received on the vt window (and possibly other
498	windows). Should only be used as a last resort. Most event structure	658	windows). Should only be used as a last resort. Most event structure
499	members are not passed.	659	members are not passed.
500		660
		661	=item on_root_event $term, $event
		662
		663	Like C<on_x_event>, but is called for events on the root window.
		664
501	=item on_focus_in $term	665	=item on_focus_in $term
502		666
503	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
504	does focus in processing.	668	does focus in processing.
505		669
506	=item on_focus_out $term	670	=item on_focus_out $term
507		671
508	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
509	focus out processing.	673	focus out processing.
510		674
511	=item on_configure_notify $term, $event	675	=item on_configure_notify $term, $event
512		676
513	=item on_property_notify $term, $event	677	=item on_property_notify $term, $event
…		…
524		688
525	=item on_map_notify $term, $event	689	=item on_map_notify $term, $event
526		690
527	=item on_unmap_notify $term, $event	691	=item on_unmap_notify $term, $event
528		692
529	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal. If
530	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the event will be ignored by rxvt-unicode.
531		695
532	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
533	manpage), with the additional members C<row> and C<col>, which are the	697	manpage), with the additional members C<row> and C<col>, which are the
534	(real, not screen-based) row and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
535		699
…		…
544		708
545	=item on_wm_delete_window $term, $event	709	=item on_wm_delete_window $term, $event
546		710
547	Called when various types of ClientMessage events are received (all with	711	Called when various types of ClientMessage events are received (all with
548	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		713
		714	=item on_bell $term
		715
		716	Called on receipt of a bell character.
549		717
550	=back	718	=back
551		719
552	=cut	720	=cut
553		721
…		…
596	The current terminal. This variable stores the current C<urxvt::term>	764	The current terminal. This variable stores the current C<urxvt::term>
597	object, whenever a callback/hook is executing.	765	object, whenever a callback/hook is executing.
598		766
599	=item @urxvt::TERM_INIT	767	=item @urxvt::TERM_INIT
600		768
601	All coderefs in this array will be called as methods of the next newly	769	All code references in this array will be called as methods of the next newly
602	created C<urxvt::term> object (during the C<on_init> phase). The array	770	created C<urxvt::term> object (during the C<on_init> phase). The array
603	gets cleared before the codereferences that were in it are being executed,	771	gets cleared before the code references that were in it are being executed,
604	so coderefs can push themselves onto it again if they so desire.	772	so references can push themselves onto it again if they so desire.
605		773
606	This complements to the perl-eval commandline option, but gets executed	774	This complements to the perl-eval command line option, but gets executed
607	first.	775	first.
608		776
609	=item @urxvt::TERM_EXT	777	=item @urxvt::TERM_EXT
610		778
611	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	779	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
632		800
633	Using this function has the advantage that its output ends up in the	801	Using this function has the advantage that its output ends up in the
634	correct place, e.g. on stderr of the connecting urxvtc client.	802	correct place, e.g. on stderr of the connecting urxvtc client.
635		803
636	Messages have a size limit of 1023 bytes currently.	804	Messages have a size limit of 1023 bytes currently.
		805
		806	=item @terms = urxvt::termlist
		807
		808	Returns all urxvt::term objects that exist in this process, regardless of
		809	whether they are started, being destroyed etc., so be careful. Only term
		810	objects that have perl extensions attached will be returned (because there
		811	is no urxvt::term objet associated with others).
637		812
638	=item $time = urxvt::NOW	813	=item $time = urxvt::NOW
639		814
640	Returns the "current time" (as per the event loop).	815	Returns the "current time" (as per the event loop).
641		816
…		…
699	Return the foreground/background colour index, respectively.	874	Return the foreground/background colour index, respectively.
700		875
701	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	876	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
702		877
703	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	878	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		879
		880	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
704		881
705	Replace the foreground/background colour in the rendition mask with the	882	Replace the foreground/background colour in the rendition mask with the
706	specified one.	883	specified one.
707		884
708	=item $value = urxvt::GET_CUSTOM $rend	885	=item $value = urxvt::GET_CUSTOM $rend
…		…
775	local $TERM = shift;	952	local $TERM = shift;
776	my $htype = shift;	953	my $htype = shift;
777		954
778	if ($htype == 0) { # INIT	955	if ($htype == 0) { # INIT
779	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	956	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
780		957
781	my %ext_arg;	958	my %ext_arg;
782		959
783	{	960	{
784	my @init = @TERM_INIT;	961	my @init = @TERM_INIT;
785	@TERM_INIT = ();	962	@TERM_INIT = ();
…		…
799	} else {	976	} else {
800	$ext_arg{$_} \|\|= [];	977	$ext_arg{$_} \|\|= [];
801	}	978	}
802	}	979	}
803		980
804	while (my ($ext, $argv) = each %ext_arg) {	981	for my $ext (sort keys %ext_arg) {
805	my @files = grep -f $_, map "$_/$ext", @dirs;	982	my @files = grep -f $_, map "$_/$ext", @dirs;
806		983
807	if (@files) {	984	if (@files) {
808	$TERM->register_package (extension_package $files[0], $argv);	985	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
809	} else {	986	} else {
810	warn "perl extension '$ext' not found in perl library search path\n";	987	warn "perl extension '$ext' not found in perl library search path\n";
811	}	988	}
812	}	989	}
813		990
…		…
819		996
820	if (my $cb = $TERM->{_hook}[$htype]) {	997	if (my $cb = $TERM->{_hook}[$htype]) {
821	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	998	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
822	if $verbosity >= 10;	999	if $verbosity >= 10;
823		1000
824	keys %$cb;	1001	for my $pkg (keys %$cb) {
825
826	while (my ($pkg, $cb) = each %$cb) {
827	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1002	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
828	$retval \|\|= $retval_;	1003	$retval \|\|= $retval_;
829		1004
830	if ($@) {	1005	if ($@) {
831	$TERM->ungrab; # better to lose the grab than the session	1006	$TERM->ungrab; # better to lose the grab than the session
832	warn $@;	1007	warn $@;
…		…
844	# clear package	1019	# clear package
845	%$TERM = ();	1020	%$TERM = ();
846	}	1021	}
847		1022
848	$retval	1023	$retval
		1024	}
		1025
		1026	sub SET_COLOR($$$) {
		1027	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1028	}
		1029
		1030	sub rend2mask {
		1031	no strict 'refs';
		1032	my ($str, $mask) = (@_, 0);
		1033	my %color = ( fg => undef, bg => undef );
		1034	my @failed;
		1035	for my $spec ( split /\s+/, $str ) {
		1036	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1037	$color{lc($1)} = $2;
		1038	} else {
		1039	my $neg = $spec =~ s/^[-^]//;
		1040	unless ( exists &{"RS_$spec"} ) {
		1041	push @failed, $spec;
		1042	next;
		1043	}
		1044	my $cur = &{"RS_$spec"};
		1045	if ( $neg ) {
		1046	$mask &= ~$cur;
		1047	} else {
		1048	$mask \|= $cur;
		1049	}
		1050	}
		1051	}
		1052	($mask, @color{qw(fg bg)}, \@failed)
849	}	1053	}
850		1054
851	# urxvt::term::extension	1055	# urxvt::term::extension
852		1056
853	package urxvt::term::extension;	1057	package urxvt::term::extension;
…		…
924	is that you cannot use blocking APIs, but the non-blocking variant should	1128	is that you cannot use blocking APIs, but the non-blocking variant should
925	work.	1129	work.
926		1130
927	=cut	1131	=cut
928		1132
929	our $VERSION = 1;	1133	our $VERSION = '5.23';
930		1134
931	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1135	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
932	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1136	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
933		1137
934	sub timer {	1138	sub timer {
…		…
936		1140
937	my $cb = $arg{cb};	1141	my $cb = $arg{cb};
938		1142
939	urxvt::timer	1143	urxvt::timer
940	->new	1144	->new
941	->start (urxvt::NOW + $arg{after})	1145	->after ($arg{after}, $arg{interval})
942	->cb (sub {	1146	->cb ($arg{interval} ? $cb : sub {
943	$_[0]->stop; # need to cancel manually	1147	$_[0]->stop; # need to cancel manually
944	$cb->();	1148	$cb->();
945	})	1149	})
946	}	1150	}
947		1151
948	sub io {	1152	sub io {
949	my ($class, %arg) = @_;	1153	my ($class, %arg) = @_;
950		1154
951	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
		1156	my $fd = fileno $arg{fh};
		1157	defined $fd or $fd = $arg{fh};
952		1158
953	bless [$arg{fh}, urxvt::iow	1159	bless [$arg{fh}, urxvt::iow
954	->new	1160	->new
955	->fd (fileno $arg{fh})	1161	->fd ($fd)
956	->events (($arg{poll} =~ /r/ ? 1 : 0)	1162	->events (($arg{poll} =~ /r/ ? 1 : 0)
957	\| ($arg{poll} =~ /w/ ? 2 : 0))	1163	\| ($arg{poll} =~ /w/ ? 2 : 0))
958	->start	1164	->start
959	->cb (sub {	1165	->cb ($cb)
960	$cb->(($_[1] & 1 ? 'r' : '')
961	. ($_[1] & 2 ? 'w' : ''));
962	})],
963	urxvt::anyevent::	1166	], urxvt::anyevent::
		1167	}
		1168
		1169	sub idle {
		1170	my ($class, %arg) = @_;
		1171
		1172	my $cb = $arg{cb};
		1173
		1174	urxvt::iw
		1175	->new
		1176	->start
		1177	->cb ($cb)
		1178	}
		1179
		1180	sub child {
		1181	my ($class, %arg) = @_;
		1182
		1183	my $cb = $arg{cb};
		1184
		1185	urxvt::pw
		1186	->new
		1187	->start ($arg{pid})
		1188	->cb (sub {
		1189	$_[0]->stop; # need to cancel manually
		1190	$cb->($_[0]->rpid, $_[0]->rstatus);
		1191	})
964	}	1192	}
965		1193
966	sub DESTROY {	1194	sub DESTROY {
967	$_[0][1]->stop;	1195	$_[0][1]->stop;
968	}	1196	}
969		1197
970	sub condvar {	1198	sub one_event {
971	bless \my $flag, urxvt::anyevent::condvar::
972	}
973
974	sub urxvt::anyevent::condvar::broadcast {
975	${$_[0]}++;
976	}
977
978	sub urxvt::anyevent::condvar::wait {
979	unless (${$_[0]}) {
980	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1199	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
981	}
982	}	1200	}
983		1201
984	package urxvt::term;	1202	package urxvt::term;
985		1203
986	=head2 The C<urxvt::term> Class	1204	=head2 The C<urxvt::term> Class
…		…
1022	hash which defines the environment of the new terminal.	1240	hash which defines the environment of the new terminal.
1023		1241
1024	Croaks (and probably outputs an error message) if the new instance	1242	Croaks (and probably outputs an error message) if the new instance
1025	couldn't be created. Returns C<undef> if the new instance didn't	1243	couldn't be created. Returns C<undef> if the new instance didn't
1026	initialise perl, and the terminal object otherwise. The C<init> and	1244	initialise perl, and the terminal object otherwise. The C<init> and
1027	C<start> hooks will be called during this call.	1245	C<start> hooks will be called before this call returns, and are free to
		1246	refer to global data (which is race free).
1028		1247
1029	=cut	1248	=cut
1030		1249
1031	sub new {	1250	sub new {
1032	my ($class, $env, @args) = @_;	1251	my ($class, $env, @args) = @_;
1033		1252
		1253	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1254	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1255
1034	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1256	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1035	}	1257	}
1036		1258
1037	=item $term->destroy	1259	=item $term->destroy
1038		1260
1039	Destroy the terminal object (close the window, free resources	1261	Destroy the terminal object (close the window, free resources
…		…
1069		1291
1070	Returns true if the option specified by C<$optval> is enabled, and	1292	Returns true if the option specified by C<$optval> is enabled, and
1071	optionally change it. All option values are stored by name in the hash	1293	optionally change it. All option values are stored by name in the hash
1072	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1294	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1073		1295
1074	Here is a a likely non-exhaustive list of option names, please see the	1296	Here is a likely non-exhaustive list of option names, please see the
1075	source file F</src/optinc.h> to see the actual list:	1297	source file F</src/optinc.h> to see the actual list:
1076		1298
1077	borderLess console cursorBlink cursorUnderline hold iconic insecure	1299	borderLess console cursorBlink cursorUnderline hold iconic insecure
1078	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1300	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1079	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1301	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1096	likely change).	1318	likely change).
1097		1319
1098	Please note that resource strings will currently only be freed when the	1320	Please note that resource strings will currently only be freed when the
1099	terminal is destroyed, so changing options frequently will eat memory.	1321	terminal is destroyed, so changing options frequently will eat memory.
1100		1322
1101	Here is a a likely non-exhaustive list of resource names, not all of which	1323	Here is a likely non-exhaustive list of resource names, not all of which
1102	are supported in every build, please see the source file F</src/rsinc.h>	1324	are supported in every build, please see the source file F</src/rsinc.h>
1103	to see the actual list:	1325	to see the actual list:
1104		1326
1105	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1327	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1106	borderLess color cursorBlink cursorUnderline cutchars delete_key	1328	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1107	display_name embed ext_bwidth fade font geometry hold iconName	1329	display_name embed ext_bwidth fade font geometry hold iconName
1108	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1330	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1109	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1331	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1110	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1332	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1111	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1333	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1112	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1334	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1113	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1335	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1114	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1336	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1115	secondaryScreen secondaryScroll selectstyle shade term_name title	1337	secondaryScreen secondaryScroll shade term_name title
1116	transient_for transparent transparent_all tripleclickwords utmpInhibit	1338	transient_for transparent transparent_all tripleclickwords utmpInhibit
1117	visualBell	1339	visualBell
1118		1340
1119	=cut	1341	=cut
1120		1342
1121	sub resource($$;$) {	1343	sub resource($$;$) {
1122	my ($self, $name) = (shift, shift);	1344	my ($self, $name) = (shift, shift);
1123	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1345	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1124	&urxvt::term::_resource	1346	goto &urxvt::term::_resource
1125	}	1347	}
1126		1348
1127	=item $value = $term->x_resource ($pattern)	1349	=item $value = $term->x_resource ($pattern)
1128		1350
1129	Returns the X-Resource for the given pattern, excluding the program or	1351	Returns the X-Resource for the given pattern, excluding the program or
…		…
1154		1376
1155	=item ($row, $col) = $term->selection_beg ([$row, $col])	1377	=item ($row, $col) = $term->selection_beg ([$row, $col])
1156		1378
1157	=item ($row, $col) = $term->selection_end ([$row, $col])	1379	=item ($row, $col) = $term->selection_end ([$row, $col])
1158		1380
1159	Return the current values of the selection mark, begin or end positions,	1381	Return the current values of the selection mark, begin or end positions.
1160	and optionally set them to new values.	1382
		1383	When arguments are given, then the selection coordinates are set to
		1384	C<$row> and C<$col>, and the selection screen is set to the current
		1385	screen.
		1386
		1387	=item $screen = $term->selection_screen ([$screen])
		1388
		1389	Returns the current selection screen, and then optionally sets it.
1161		1390
1162	=item $term->selection_make ($eventtime[, $rectangular])	1391	=item $term->selection_make ($eventtime[, $rectangular])
1163		1392
1164	Tries to make a selection as set by C<selection_beg> and	1393	Tries to make a selection as set by C<selection_beg> and
1165	C<selection_end>. If C<$rectangular> is true (default: false), a	1394	C<selection_end>. If C<$rectangular> is true (default: false), a
1166	rectangular selection will be made. This is the prefered function to make	1395	rectangular selection will be made. This is the preferred function to make
1167	a selection.	1396	a selection.
1168		1397
1169	=item $success = $term->selection_grab ($eventtime)	1398	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1170		1399
1171	Try to request the primary selection text from the server (for example, as	1400	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1401	true) selection from the server. The corresponding text can be set
1172	set by the next method). No visual feedback will be given. This function	1402	with the next method. No visual feedback will be given. This function
1173	is mostly useful from within C<on_sel_grab> hooks.	1403	is mostly useful from within C<on_sel_grab> hooks.
1174		1404
1175	=item $oldtext = $term->selection ([$newtext])	1405	=item $oldtext = $term->selection ([$newtext, $clipboard])
1176		1406
1177	Return the current selection text and optionally replace it by C<$newtext>.	1407	Return the current selection (clipboard if C<$clipboard> is true) text
		1408	and optionally replace it by C<$newtext>.
		1409
		1410	=item $term->selection_clear ([$clipboard])
		1411
		1412	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1178		1413
1179	=item $term->overlay_simple ($x, $y, $text)	1414	=item $term->overlay_simple ($x, $y, $text)
1180		1415
1181	Create a simple multi-line overlay box. See the next method for details.	1416	Create a simple multi-line overlay box. See the next method for details.
1182		1417
…		…
1212		1447
1213	The methods currently supported on C<urxvt::overlay> objects are:	1448	The methods currently supported on C<urxvt::overlay> objects are:
1214		1449
1215	=over 4	1450	=over 4
1216		1451
1217	=item $overlay->set ($x, $y, $text, $rend)	1452	=item $overlay->set ($x, $y, $text[, $rend])
1218		1453
1219	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1454	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1220	text in rxvt-unicode's special encoding and an array of rendition values	1455	text in rxvt-unicode's special encoding and an array of rendition values
1221	at a specific position inside the overlay.	1456	at a specific position inside the overlay.
		1457
		1458	If C<$rend> is missing, then the rendition will not be changed.
1222		1459
1223	=item $overlay->hide	1460	=item $overlay->hide
1224		1461
1225	If visible, hide the overlay, but do not destroy it.	1462	If visible, hide the overlay, but do not destroy it.
1226		1463
…		…
1339	Adds the specified events to the vt event mask. Useful e.g. when you want	1576	Adds the specified events to the vt event mask. Useful e.g. when you want
1340	to receive pointer events all the times:	1577	to receive pointer events all the times:
1341		1578
1342	$term->vt_emask_add (urxvt::PointerMotionMask);	1579	$term->vt_emask_add (urxvt::PointerMotionMask);
1343		1580
		1581	=item $term->focus_in
		1582
		1583	=item $term->focus_out
		1584
		1585	=item $term->key_press ($state, $keycode[, $time])
		1586
		1587	=item $term->key_release ($state, $keycode[, $time])
		1588
		1589	Deliver various fake events to to terminal.
		1590
1344	=item $window_width = $term->width	1591	=item $window_width = $term->width
1345		1592
1346	=item $window_height = $term->height	1593	=item $window_height = $term->height
1347		1594
1348	=item $font_width = $term->fwidth	1595	=item $font_width = $term->fwidth
…		…
1378	=item $env = $term->env	1625	=item $env = $term->env
1379		1626
1380	Returns a copy of the environment in effect for the terminal as a hashref	1627	Returns a copy of the environment in effect for the terminal as a hashref
1381	similar to C<\%ENV>.	1628	similar to C<\%ENV>.
1382		1629
		1630	=item @envv = $term->envv
		1631
		1632	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1633
		1634	=item @argv = $term->argv
		1635
		1636	Return the argument vector as this terminal, similar to @ARGV, but
		1637	includes the program name as first element.
		1638
1383	=cut	1639	=cut
1384		1640
1385	sub env {	1641	sub env {
1386	if (my $env = $_[0]->_env) {
1387	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1642	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1388	} else {
1389	+{ %ENV }
1390	}
1391	}	1643	}
1392		1644
1393	=item $modifiermask = $term->ModLevel3Mask	1645	=item $modifiermask = $term->ModLevel3Mask
1394		1646
1395	=item $modifiermask = $term->ModMetaMask	1647	=item $modifiermask = $term->ModMetaMask
…		…
1403		1655
1404	Returns the currently displayed screen (0 primary, 1 secondary).	1656	Returns the currently displayed screen (0 primary, 1 secondary).
1405		1657
1406	=item $cursor_is_hidden = $term->hidden_cursor	1658	=item $cursor_is_hidden = $term->hidden_cursor
1407		1659
1408	Returns wether the cursor is currently hidden or not.	1660	Returns whether the cursor is currently hidden or not.
1409		1661
1410	=item $view_start = $term->view_start ([$newvalue])	1662	=item $view_start = $term->view_start ([$newvalue])
1411		1663
1412	Returns the row number of the topmost displayed line. Maximum value is	1664	Returns the row number of the topmost displayed line. Maximum value is
1413	C<0>, which displays the normal terminal contents. Lower values scroll	1665	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1421		1673
1422	Used after changing terminal contents to display them.	1674	Used after changing terminal contents to display them.
1423		1675
1424	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1676	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1425		1677
1426	Returns the text of the entire row with number C<$row_number>. Row C<0>	1678	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1427	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1679	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1428	terminal line. The scrollback buffer starts at line C<-1> and extends to
1429	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1680	terminal line. Nothing will be returned if a nonexistent line
1430	is requested.	1681	is requested.
1431		1682
1432	If C<$new_text> is specified, it will replace characters in the current	1683	If C<$new_text> is specified, it will replace characters in the current
1433	line, starting at column C<$start_col> (default C<0>), which is useful	1684	line, starting at column C<$start_col> (default C<0>), which is useful
1434	to replace only parts of a line. The font index in the rendition will	1685	to replace only parts of a line. The font index in the rendition will
1435	automatically be updated.	1686	automatically be updated.
1436		1687
1437	C<$text> is in a special encoding: tabs and wide characters that use more	1688	C<$text> is in a special encoding: tabs and wide characters that use more
1438	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1689	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1439	characters. Characters with combining characters and other characters that	1690	characters. Characters with combining characters and other characters that
1440	do not fit into the normal tetx encoding will be replaced with characters	1691	do not fit into the normal text encoding will be replaced with characters
1441	in the private use area.	1692	in the private use area.
1442		1693
1443	You have to obey this encoding when changing text. The advantage is	1694	You have to obey this encoding when changing text. The advantage is
1444	that C<substr> and similar functions work on screen cells and not on	1695	that C<substr> and similar functions work on screen cells and not on
1445	characters.	1696	characters.
…		…
1590	where one character corresponds to one screen cell. See	1841	where one character corresponds to one screen cell. See
1591	C<< $term->ROW_t >> for details.	1842	C<< $term->ROW_t >> for details.
1592		1843
1593	=item $string = $term->special_decode $text	1844	=item $string = $term->special_decode $text
1594		1845
1595	Converts rxvt-unicodes text reprsentation into a perl string. See	1846	Converts rxvt-unicodes text representation into a perl string. See
1596	C<< $term->ROW_t >> for details.	1847	C<< $term->ROW_t >> for details.
1597		1848
1598	=item $success = $term->grab_button ($button, $modifiermask)	1849	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1599		1850
		1851	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1852
1600	Registers a synchronous button grab. See the XGrabButton manpage.	1853	Register/unregister a synchronous button grab. See the XGrabButton
		1854	manpage.
1601		1855
1602	=item $success = $term->grab ($eventtime[, $sync])	1856	=item $success = $term->grab ($eventtime[, $sync])
1603		1857
1604	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1858	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1605	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1859	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1606		1860
1607	=item $term->allow_events_async	1861	=item $term->allow_events_async
1608		1862
1609	Calls XAllowEvents with AsyncBoth for the most recent grab.	1863	Calls XAllowEvents with AsyncBoth for the most recent grab.
1610		1864
…		…
1617	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1871	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1618	recent grab.	1872	recent grab.
1619		1873
1620	=item $term->ungrab	1874	=item $term->ungrab
1621		1875
1622	Calls XUngrab for the most recent grab. Is called automatically on	1876	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1623	evaluation errors, as it is better to lose the grab in the error case as	1877	evaluation errors, as it is better to lose the grab in the error case as
1624	the session.	1878	the session.
1625		1879
1626	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1880	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1627		1881
…		…
1629		1883
1630	=item @atoms = $term->XListProperties ($window)	1884	=item @atoms = $term->XListProperties ($window)
1631		1885
1632	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1886	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1633		1887
1634	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1888	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1635		1889
1636	=item $term->XDeleteProperty ($window, $property)	1890	=item $term->XDeleteProperty ($window, $property)
1637		1891
1638	=item $window = $term->DefaultRootWindow	1892	=item $window = $term->DefaultRootWindow
1639		1893
…		…
1649		1903
1650	=item $term->XChangeInput ($window, $add_events[, $del_events])	1904	=item $term->XChangeInput ($window, $add_events[, $del_events])
1651		1905
1652	Various X or X-related functions. The C<$term> object only serves as	1906	Various X or X-related functions. The C<$term> object only serves as
1653	the source of the display, otherwise those functions map more-or-less	1907	the source of the display, otherwise those functions map more-or-less
1654	directory onto the X functions of the same name.	1908	directly onto the X functions of the same name.
1655		1909
1656	=back	1910	=back
1657		1911
1658	=cut	1912	=cut
1659		1913
…		…
1723	my ($self, $text, $cb) = @_;	1977	my ($self, $text, $cb) = @_;
1724		1978
1725	$self->add_item ({ type => "button", text => $text, activate => $cb});	1979	$self->add_item ({ type => "button", text => $text, activate => $cb});
1726	}	1980	}
1727		1981
1728	=item $popup->add_toggle ($text, $cb, $initial_value)	1982	=item $popup->add_toggle ($text, $initial_value, $cb)
1729		1983
1730	Adds a toggle/checkbox item to the popup. Teh callback gets called	1984	Adds a toggle/checkbox item to the popup. The callback gets called
1731	whenever it gets toggled, with a boolean indicating its value as its first	1985	whenever it gets toggled, with a boolean indicating its new value as its
1732	argument.	1986	first argument.
1733		1987
1734	=cut	1988	=cut
1735		1989
1736	sub add_toggle {	1990	sub add_toggle {
1737	my ($self, $text, $cb, $value) = @_;	1991	my ($self, $text, $value, $cb) = @_;
1738		1992
1739	my $item; $item = {	1993	my $item; $item = {
1740	type => "button",	1994	type => "button",
1741	text => " $text",	1995	text => " $text",
1742	value => $value,	1996	value => $value,
…		…
1761	my $env = $self->{term}->env;	2015	my $env = $self->{term}->env;
1762	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2016	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1763	delete $env->{LC_ALL};	2017	delete $env->{LC_ALL};
1764	$env->{LC_CTYPE} = $self->{term}->locale;	2018	$env->{LC_CTYPE} = $self->{term}->locale;
1765		2019
1766	urxvt::term->new ($env, "popup",	2020	my $term = urxvt::term->new (
		2021	$env, "popup",
1767	"--perl-lib" => "", "--perl-ext-common" => "",	2022	"--perl-lib" => "", "--perl-ext-common" => "",
1768	"-pty-fd" => -1, "-sl" => 0,	2023	"-pty-fd" => -1, "-sl" => 0,
1769	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2024	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1770	"--transient-for" => $self->{term}->parent,	2025	"--transient-for" => $self->{term}->parent,
1771	"-display" => $self->{term}->display_id,	2026	"-display" => $self->{term}->display_id,
1772	"-pe" => "urxvt-popup")	2027	"-pe" => "urxvt-popup",
1773	or die "unable to create popup window\n";	2028	) or die "unable to create popup window\n";
		2029
		2030	unless (delete $term->{urxvt_popup_init_done}) {
		2031	$term->ungrab;
		2032	$term->destroy;
		2033	die "unable to initialise popup window\n";
		2034	}
1774	}	2035	}
1775		2036
1776	sub DESTROY {	2037	sub DESTROY {
1777	my ($self) = @_;	2038	my ($self) = @_;
1778		2039
…		…
1783	=back	2044	=back
1784		2045
1785	=cut	2046	=cut
1786		2047
1787	package urxvt::watcher;	2048	package urxvt::watcher;
1788
1789	@urxvt::timer::ISA = __PACKAGE__;
1790	@urxvt::iow::ISA = __PACKAGE__;
1791	@urxvt::pw::ISA = __PACKAGE__;
1792	@urxvt::iw::ISA = __PACKAGE__;
1793		2049
1794	=head2 The C<urxvt::timer> Class	2050	=head2 The C<urxvt::timer> Class
1795		2051
1796	This class implements timer watchers/events. Time is represented as a	2052	This class implements timer watchers/events. Time is represented as a
1797	fractional number of seconds since the epoch. Example:	2053	fractional number of seconds since the epoch. Example:
…		…
1801	->new	2057	->new
1802	->interval (1)	2058	->interval (1)
1803	->cb (sub {	2059	->cb (sub {
1804	$term->{overlay}->set (0, 0,	2060	$term->{overlay}->set (0, 0,
1805	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2061	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1806	});	2062	});
1807		2063
1808	=over 4	2064	=over 4
1809		2065
1810	=item $timer = new urxvt::timer	2066	=item $timer = new urxvt::timer
1811		2067
…		…
1814		2070
1815	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2071	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1816		2072
1817	Set the callback to be called when the timer triggers.	2073	Set the callback to be called when the timer triggers.
1818		2074
1819	=item $tstamp = $timer->at
1820
1821	Return the time this watcher will fire next.
1822
1823	=item $timer = $timer->set ($tstamp)	2075	=item $timer = $timer->set ($tstamp[, $interval])
1824		2076
1825	Set the time the event is generated to $tstamp.	2077	Set the time the event is generated to $tstamp (and optionally specifies a
		2078	new $interval).
1826		2079
1827	=item $timer = $timer->interval ($interval)	2080	=item $timer = $timer->interval ($interval)
1828		2081
1829	Normally (and when C<$interval> is C<0>), the timer will automatically	2082	By default (and when C<$interval> is C<0>), the timer will automatically
1830	stop after it has fired once. If C<$interval> is non-zero, then the timer	2083	stop after it has fired once. If C<$interval> is non-zero, then the timer
1831	is automatically rescheduled at the given intervals.	2084	is automatically rescheduled at the given intervals.
1832		2085
1833	=item $timer = $timer->start	2086	=item $timer = $timer->start
1834		2087
1835	Start the timer.	2088	Start the timer.
1836		2089
1837	=item $timer = $timer->start ($tstamp)	2090	=item $timer = $timer->start ($tstamp[, $interval])
1838		2091
1839	Set the event trigger time to C<$tstamp> and start the timer.	2092	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2093	also replaces the interval.
1840		2094
1841	=item $timer = $timer->after ($delay)	2095	=item $timer = $timer->after ($delay[, $interval])
1842		2096
1843	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2097	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1844		2098
1845	=item $timer = $timer->stop	2099	=item $timer = $timer->stop
1846		2100
…		…
1854		2108
1855	$term->{socket} = ...	2109	$term->{socket} = ...
1856	$term->{iow} = urxvt::iow	2110	$term->{iow} = urxvt::iow
1857	->new	2111	->new
1858	->fd (fileno $term->{socket})	2112	->fd (fileno $term->{socket})
1859	->events (urxvt::EVENT_READ)	2113	->events (urxvt::EV_READ)
1860	->start	2114	->start
1861	->cb (sub {	2115	->cb (sub {
1862	my ($iow, $revents) = @_;	2116	my ($iow, $revents) = @_;
1863	# $revents must be 1 here, no need to check	2117	# $revents must be 1 here, no need to check
1864	sysread $term->{socket}, my $buf, 8192	2118	sysread $term->{socket}, my $buf, 8192
…		…
1877	Set the callback to be called when io events are triggered. C<$reventmask>	2131	Set the callback to be called when io events are triggered. C<$reventmask>
1878	is a bitset as described in the C<events> method.	2132	is a bitset as described in the C<events> method.
1879		2133
1880	=item $iow = $iow->fd ($fd)	2134	=item $iow = $iow->fd ($fd)
1881		2135
1882	Set the filedescriptor (not handle) to watch.	2136	Set the file descriptor (not handle) to watch.
1883		2137
1884	=item $iow = $iow->events ($eventmask)	2138	=item $iow = $iow->events ($eventmask)
1885		2139
1886	Set the event mask to watch. The only allowed values are	2140	Set the event mask to watch. The only allowed values are
1887	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2141	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1888	together, or C<urxvt::EVENT_NONE>.	2142	together, or C<urxvt::EV_NONE>.
1889		2143
1890	=item $iow = $iow->start	2144	=item $iow = $iow->start
1891		2145
1892	Start watching for requested events on the given handle.	2146	Start watching for requested events on the given handle.
1893		2147
1894	=item $iow = $iow->stop	2148	=item $iow = $iow->stop
1895		2149
1896	Stop watching for events on the given filehandle.	2150	Stop watching for events on the given file handle.
1897		2151
1898	=back	2152	=back
1899		2153
1900	=head2 The C<urxvt::iw> Class	2154	=head2 The C<urxvt::iw> Class
1901		2155
…		…
1934	->new	2188	->new
1935	->start ($pid)	2189	->start ($pid)
1936	->cb (sub {	2190	->cb (sub {
1937	my ($pw, $exit_status) = @_;	2191	my ($pw, $exit_status) = @_;
1938	...	2192	...
1939	});	2193	});
1940		2194
1941	=over 4	2195	=over 4
1942		2196
1943	=item $pw = new urxvt::pw	2197	=item $pw = new urxvt::pw
1944		2198
…		…
1948		2202
1949	Set the callback to be called when the timer triggers.	2203	Set the callback to be called when the timer triggers.
1950		2204
1951	=item $pw = $timer->start ($pid)	2205	=item $pw = $timer->start ($pid)
1952		2206
1953	Tells the wqtcher to start watching for process C<$pid>.	2207	Tells the watcher to start watching for process C<$pid>.
1954		2208
1955	=item $pw = $pw->stop	2209	=item $pw = $pw->stop
1956		2210
1957	Stop the watcher.	2211	Stop the watcher.
1958		2212
…		…
1971		2225
1972	=item >= 3 - script loading and management	2226	=item >= 3 - script loading and management
1973		2227
1974	=item >=10 - all called hooks	2228	=item >=10 - all called hooks
1975		2229
1976	=item >=11 - hook reutrn values	2230	=item >=11 - hook return values
1977		2231
1978	=back	2232	=back
1979		2233
1980	=head1 AUTHOR	2234	=head1 AUTHOR
1981		2235
…		…
1983	http://software.schmorp.de/pkg/rxvt-unicode	2237	http://software.schmorp.de/pkg/rxvt-unicode
1984		2238
1985	=cut	2239	=cut
1986		2240
1987	1	2241	1
		2242
		2243	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.126 by root, Tue Jan 24 19:14:36 2006 UTC vs. Revision 1.185 by sf-exg, Fri Jul 2 12:44:45 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.126 by root, Tue Jan 24 19:14:36 2006 UTC vs.
Revision 1.185 by sf-exg, Fri Jul 2 12:44:45 2010 UTC