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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.127 by root, Wed Jan 25 00:42:21 2006 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 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, when the terminal is	504	Called whenever something tries to destroy terminal, when the terminal is
376	still fully functional (not for long, though).	505	still fully functional (not for long, though).
…		…
403		532
404	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
405	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
406	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
407		536
408	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.
409		538
410	=item on_sel_extend $term	539	=item on_sel_extend $term
411		540
412	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
413	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
414	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
415	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
416	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
417	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
418		547
419	See the F<selection> example extension.	548	See the F<selection> example extension.
420		549
421	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
422		551
423	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
424	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
425	show this many lines of scrollback.	554	show this many lines of scrollback.
426		555
427	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
428		557
…		…
432		561
433	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,
434	$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
435	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
436		565
437	=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
438		577
439	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
440	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
441	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
442	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,
443	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
444	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	}
445		594
446	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,
447	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
448	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.
449		601
450	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
451		603
452	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
453	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
…		…
458	=item on_tt_write $term, $octets	610	=item on_tt_write $term, $octets
459		611
460	Called whenever some data is written to the tty/pty and can be used to	612	Called whenever some data is written to the tty/pty and can be used to
461	suppress or filter tty input.	613	suppress or filter tty input.
462		614
		615	=item on_tt_paste $term, $octets
		616
		617	Called whenever text is about to be pasted, with the text as argument. You
		618	can filter/change and paste the text yourself by returning a true value
		619	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		620	locale-encoded.
		621
463	=item on_line_update $term, $row	622	=item on_line_update $term, $row
464		623
465	Called whenever a line was updated or changed. Can be used to filter	624	Called whenever a line was updated or changed. Can be used to filter
466	screen output (e.g. underline urls or other useless stuff). Only lines	625	screen output (e.g. underline urls or other useless stuff). Only lines
467	that are being shown will be filtered, and, due to performance reasons,	626	that are being shown will be filtered, and, due to performance reasons,
…		…
474	later with the already-modified line (e.g. if unrelated parts change), so	633	later with the already-modified line (e.g. if unrelated parts change), so
475	you cannot just toggle rendition bits, but only set them.	634	you cannot just toggle rendition bits, but only set them.
476		635
477	=item on_refresh_begin $term	636	=item on_refresh_begin $term
478		637
479	Called just before the screen gets redrawn. Can be used for overlay	638	Called just before the screen gets redrawn. Can be used for overlay or
480	or similar effects by modify terminal contents in refresh_begin, and	639	similar effects by modifying the terminal contents in refresh_begin, and
481	restoring them in refresh_end. The built-in overlay and selection display	640	restoring them in refresh_end. The built-in overlay and selection display
482	code is run after this hook, and takes precedence.	641	code is run after this hook, and takes precedence.
483		642
484	=item on_refresh_end $term	643	=item on_refresh_end $term
485		644
486	Called just after the screen gets redrawn. See C<on_refresh_begin>.	645	Called just after the screen gets redrawn. See C<on_refresh_begin>.
487		646
488	=item on_keyboard_command $term, $string	647	=item on_user_command $term, $string
489		648
490	Called whenever the user presses a key combination that has a	649	Called whenever a user-configured event is being activated (e.g. via
491	C<perl:string> action bound to it (see description of the B<keysym>	650	a C<perl:string> action bound to a key, see description of the B<keysym>
492	resource in the @@RXVT_NAME@@(1) manpage).	651	resource in the @@RXVT_NAME@@(1) manpage).
		652
		653	The event is simply the action string. This interface is assumed to change
		654	slightly in the future.
		655
		656	=item on_resize_all_windows $term, $new_width, $new_height
		657
		658	Called just after the new window size has been calculated, but before
		659	windows are actually being resized or hints are being set. If this hook
		660	returns TRUE, setting of the window hints is being skipped.
493		661
494	=item on_x_event $term, $event	662	=item on_x_event $term, $event
495		663
496	Called on every X event received on the vt window (and possibly other	664	Called on every X event received on the vt window (and possibly other
497	windows). Should only be used as a last resort. Most event structure	665	windows). Should only be used as a last resort. Most event structure
498	members are not passed.	666	members are not passed.
499		667
		668	=item on_root_event $term, $event
		669
		670	Like C<on_x_event>, but is called for events on the root window.
		671
500	=item on_focus_in $term	672	=item on_focus_in $term
501		673
502	Called whenever the window gets the keyboard focus, before rxvt-unicode	674	Called whenever the window gets the keyboard focus, before rxvt-unicode
503	does focus in processing.	675	does focus in processing.
504		676
505	=item on_focus_out $term	677	=item on_focus_out $term
506		678
507	Called wheneever the window loses keyboard focus, before rxvt-unicode does	679	Called whenever the window loses keyboard focus, before rxvt-unicode does
508	focus out processing.	680	focus out processing.
509		681
510	=item on_configure_notify $term, $event	682	=item on_configure_notify $term, $event
511		683
512	=item on_property_notify $term, $event	684	=item on_property_notify $term, $event
…		…
523		695
524	=item on_map_notify $term, $event	696	=item on_map_notify $term, $event
525		697
526	=item on_unmap_notify $term, $event	698	=item on_unmap_notify $term, $event
527		699
528	Called whenever the corresponding X event is received for the terminal If	700	Called whenever the corresponding X event is received for the terminal. If
529	the hook returns true, then the even will be ignored by rxvt-unicode.	701	the hook returns true, then the event will be ignored by rxvt-unicode.
530		702
531	The event is a hash with most values as named by Xlib (see the XEvent	703	The event is a hash with most values as named by Xlib (see the XEvent
532	manpage), with the additional members C<row> and C<col>, which are the	704	manpage), with the additional members C<row> and C<col>, which are the
533	(real, not screen-based) row and column under the mouse cursor.	705	(real, not screen-based) row and column under the mouse cursor.
534		706
…		…
543		715
544	=item on_wm_delete_window $term, $event	716	=item on_wm_delete_window $term, $event
545		717
546	Called when various types of ClientMessage events are received (all with	718	Called when various types of ClientMessage events are received (all with
547	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	719	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		720
		721	=item on_bell $term
		722
		723	Called on receipt of a bell character.
548		724
549	=back	725	=back
550		726
551	=cut	727	=cut
552		728
…		…
595	The current terminal. This variable stores the current C<urxvt::term>	771	The current terminal. This variable stores the current C<urxvt::term>
596	object, whenever a callback/hook is executing.	772	object, whenever a callback/hook is executing.
597		773
598	=item @urxvt::TERM_INIT	774	=item @urxvt::TERM_INIT
599		775
600	All coderefs in this array will be called as methods of the next newly	776	All code references in this array will be called as methods of the next newly
601	created C<urxvt::term> object (during the C<on_init> phase). The array	777	created C<urxvt::term> object (during the C<on_init> phase). The array
602	gets cleared before the codereferences that were in it are being executed,	778	gets cleared before the code references that were in it are being executed,
603	so coderefs can push themselves onto it again if they so desire.	779	so references can push themselves onto it again if they so desire.
604		780
605	This complements to the perl-eval commandline option, but gets executed	781	This complements to the perl-eval command line option, but gets executed
606	first.	782	first.
607		783
608	=item @urxvt::TERM_EXT	784	=item @urxvt::TERM_EXT
609		785
610	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	786	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
631		807
632	Using this function has the advantage that its output ends up in the	808	Using this function has the advantage that its output ends up in the
633	correct place, e.g. on stderr of the connecting urxvtc client.	809	correct place, e.g. on stderr of the connecting urxvtc client.
634		810
635	Messages have a size limit of 1023 bytes currently.	811	Messages have a size limit of 1023 bytes currently.
		812
		813	=item @terms = urxvt::termlist
		814
		815	Returns all urxvt::term objects that exist in this process, regardless of
		816	whether they are started, being destroyed etc., so be careful. Only term
		817	objects that have perl extensions attached will be returned (because there
		818	is no urxvt::term objet associated with others).
636		819
637	=item $time = urxvt::NOW	820	=item $time = urxvt::NOW
638		821
639	Returns the "current time" (as per the event loop).	822	Returns the "current time" (as per the event loop).
640		823
…		…
698	Return the foreground/background colour index, respectively.	881	Return the foreground/background colour index, respectively.
699		882
700	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	883	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
701		884
702	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	885	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		886
		887	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
703		888
704	Replace the foreground/background colour in the rendition mask with the	889	Replace the foreground/background colour in the rendition mask with the
705	specified one.	890	specified one.
706		891
707	=item $value = urxvt::GET_CUSTOM $rend	892	=item $value = urxvt::GET_CUSTOM $rend
…		…
774	local $TERM = shift;	959	local $TERM = shift;
775	my $htype = shift;	960	my $htype = shift;
776		961
777	if ($htype == 0) { # INIT	962	if ($htype == 0) { # INIT
778	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	963	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
779		964
780	my %ext_arg;	965	my %ext_arg;
781		966
782	{	967	{
783	my @init = @TERM_INIT;	968	my @init = @TERM_INIT;
784	@TERM_INIT = ();	969	@TERM_INIT = ();
…		…
798	} else {	983	} else {
799	$ext_arg{$_} \|\|= [];	984	$ext_arg{$_} \|\|= [];
800	}	985	}
801	}	986	}
802		987
803	while (my ($ext, $argv) = each %ext_arg) {	988	for my $ext (sort keys %ext_arg) {
804	my @files = grep -f $_, map "$_/$ext", @dirs;	989	my @files = grep -f $_, map "$_/$ext", @dirs;
805		990
806	if (@files) {	991	if (@files) {
807	$TERM->register_package (extension_package $files[0], $argv);	992	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
808	} else {	993	} else {
809	warn "perl extension '$ext' not found in perl library search path\n";	994	warn "perl extension '$ext' not found in perl library search path\n";
810	}	995	}
811	}	996	}
812		997
…		…
818		1003
819	if (my $cb = $TERM->{_hook}[$htype]) {	1004	if (my $cb = $TERM->{_hook}[$htype]) {
820	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1005	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
821	if $verbosity >= 10;	1006	if $verbosity >= 10;
822		1007
823	keys %$cb;	1008	for my $pkg (keys %$cb) {
824
825	while (my ($pkg, $cb) = each %$cb) {
826	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1009	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
827	$retval \|\|= $retval_;	1010	$retval \|\|= $retval_;
828		1011
829	if ($@) {	1012	if ($@) {
830	$TERM->ungrab; # better to lose the grab than the session	1013	$TERM->ungrab; # better to lose the grab than the session
831	warn $@;	1014	warn $@;
…		…
843	# clear package	1026	# clear package
844	%$TERM = ();	1027	%$TERM = ();
845	}	1028	}
846		1029
847	$retval	1030	$retval
		1031	}
		1032
		1033	sub SET_COLOR($$$) {
		1034	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1035	}
		1036
		1037	sub rend2mask {
		1038	no strict 'refs';
		1039	my ($str, $mask) = (@_, 0);
		1040	my %color = ( fg => undef, bg => undef );
		1041	my @failed;
		1042	for my $spec ( split /\s+/, $str ) {
		1043	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1044	$color{lc($1)} = $2;
		1045	} else {
		1046	my $neg = $spec =~ s/^[-^]//;
		1047	unless ( exists &{"RS_$spec"} ) {
		1048	push @failed, $spec;
		1049	next;
		1050	}
		1051	my $cur = &{"RS_$spec"};
		1052	if ( $neg ) {
		1053	$mask &= ~$cur;
		1054	} else {
		1055	$mask \|= $cur;
		1056	}
		1057	}
		1058	}
		1059	($mask, @color{qw(fg bg)}, \@failed)
848	}	1060	}
849		1061
850	# urxvt::term::extension	1062	# urxvt::term::extension
851		1063
852	package urxvt::term::extension;	1064	package urxvt::term::extension;
…		…
923	is that you cannot use blocking APIs, but the non-blocking variant should	1135	is that you cannot use blocking APIs, but the non-blocking variant should
924	work.	1136	work.
925		1137
926	=cut	1138	=cut
927		1139
928	our $VERSION = 1;	1140	our $VERSION = '5.23';
929		1141
930	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1142	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
931	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1143	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
932		1144
933	sub timer {	1145	sub timer {
…		…
935		1147
936	my $cb = $arg{cb};	1148	my $cb = $arg{cb};
937		1149
938	urxvt::timer	1150	urxvt::timer
939	->new	1151	->new
940	->start (urxvt::NOW + $arg{after})	1152	->after ($arg{after}, $arg{interval})
941	->cb (sub {	1153	->cb ($arg{interval} ? $cb : sub {
942	$_[0]->stop; # need to cancel manually	1154	$_[0]->stop; # need to cancel manually
943	$cb->();	1155	$cb->();
944	})	1156	})
945	}	1157	}
946		1158
947	sub io {	1159	sub io {
948	my ($class, %arg) = @_;	1160	my ($class, %arg) = @_;
949		1161
950	my $cb = $arg{cb};	1162	my $cb = $arg{cb};
		1163	my $fd = fileno $arg{fh};
		1164	defined $fd or $fd = $arg{fh};
951		1165
952	bless [$arg{fh}, urxvt::iow	1166	bless [$arg{fh}, urxvt::iow
953	->new	1167	->new
954	->fd (fileno $arg{fh})	1168	->fd ($fd)
955	->events (($arg{poll} =~ /r/ ? 1 : 0)	1169	->events (($arg{poll} =~ /r/ ? 1 : 0)
956	\| ($arg{poll} =~ /w/ ? 2 : 0))	1170	\| ($arg{poll} =~ /w/ ? 2 : 0))
957	->start	1171	->start
958	->cb (sub {	1172	->cb ($cb)
959	$cb->(($_[1] & 1 ? 'r' : '')
960	. ($_[1] & 2 ? 'w' : ''));
961	})],
962	urxvt::anyevent::	1173	], urxvt::anyevent::
		1174	}
		1175
		1176	sub idle {
		1177	my ($class, %arg) = @_;
		1178
		1179	my $cb = $arg{cb};
		1180
		1181	urxvt::iw
		1182	->new
		1183	->start
		1184	->cb ($cb)
		1185	}
		1186
		1187	sub child {
		1188	my ($class, %arg) = @_;
		1189
		1190	my $cb = $arg{cb};
		1191
		1192	urxvt::pw
		1193	->new
		1194	->start ($arg{pid})
		1195	->cb (sub {
		1196	$_[0]->stop; # need to cancel manually
		1197	$cb->($_[0]->rpid, $_[0]->rstatus);
		1198	})
963	}	1199	}
964		1200
965	sub DESTROY {	1201	sub DESTROY {
966	$_[0][1]->stop;	1202	$_[0][1]->stop;
967	}	1203	}
968		1204
969	sub condvar {	1205	sub one_event {
970	bless \my $flag, urxvt::anyevent::condvar::
971	}
972
973	sub urxvt::anyevent::condvar::broadcast {
974	${$_[0]}++;
975	}
976
977	sub urxvt::anyevent::condvar::wait {
978	unless (${$_[0]}) {
979	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1206	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
980	}
981	}	1207	}
982		1208
983	package urxvt::term;	1209	package urxvt::term;
984		1210
985	=head2 The C<urxvt::term> Class	1211	=head2 The C<urxvt::term> Class
…		…
1021	hash which defines the environment of the new terminal.	1247	hash which defines the environment of the new terminal.
1022		1248
1023	Croaks (and probably outputs an error message) if the new instance	1249	Croaks (and probably outputs an error message) if the new instance
1024	couldn't be created. Returns C<undef> if the new instance didn't	1250	couldn't be created. Returns C<undef> if the new instance didn't
1025	initialise perl, and the terminal object otherwise. The C<init> and	1251	initialise perl, and the terminal object otherwise. The C<init> and
1026	C<start> hooks will be called during this call.	1252	C<start> hooks will be called before this call returns, and are free to
		1253	refer to global data (which is race free).
1027		1254
1028	=cut	1255	=cut
1029		1256
1030	sub new {	1257	sub new {
1031	my ($class, $env, @args) = @_;	1258	my ($class, $env, @args) = @_;
1032		1259
		1260	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1261	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1262
1033	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1263	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1034	}	1264	}
1035		1265
1036	=item $term->destroy	1266	=item $term->destroy
1037		1267
1038	Destroy the terminal object (close the window, free resources	1268	Destroy the terminal object (close the window, free resources
…		…
1068		1298
1069	Returns true if the option specified by C<$optval> is enabled, and	1299	Returns true if the option specified by C<$optval> is enabled, and
1070	optionally change it. All option values are stored by name in the hash	1300	optionally change it. All option values are stored by name in the hash
1071	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1301	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1072		1302
1073	Here is a a likely non-exhaustive list of option names, please see the	1303	Here is a likely non-exhaustive list of option names, please see the
1074	source file F</src/optinc.h> to see the actual list:	1304	source file F</src/optinc.h> to see the actual list:
1075		1305
1076	borderLess console cursorBlink cursorUnderline hold iconic insecure	1306	borderLess console cursorBlink cursorUnderline hold iconic insecure
1077	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1307	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1078	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1308	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1095	likely change).	1325	likely change).
1096		1326
1097	Please note that resource strings will currently only be freed when the	1327	Please note that resource strings will currently only be freed when the
1098	terminal is destroyed, so changing options frequently will eat memory.	1328	terminal is destroyed, so changing options frequently will eat memory.
1099		1329
1100	Here is a a likely non-exhaustive list of resource names, not all of which	1330	Here is a likely non-exhaustive list of resource names, not all of which
1101	are supported in every build, please see the source file F</src/rsinc.h>	1331	are supported in every build, please see the source file F</src/rsinc.h>
1102	to see the actual list:	1332	to see the actual list:
1103		1333
1104	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1334	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1105	borderLess color cursorBlink cursorUnderline cutchars delete_key	1335	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1106	display_name embed ext_bwidth fade font geometry hold iconName	1336	display_name embed ext_bwidth fade font geometry hold iconName
1107	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1337	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1108	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1338	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1109	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1339	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1110	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1340	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1111	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1341	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1112	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1342	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1113	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1343	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1114	secondaryScreen secondaryScroll selectstyle shade term_name title	1344	secondaryScreen secondaryScroll shade term_name title
1115	transient_for transparent transparent_all tripleclickwords utmpInhibit	1345	transient_for transparent transparent_all tripleclickwords utmpInhibit
1116	visualBell	1346	visualBell
1117		1347
1118	=cut	1348	=cut
1119		1349
1120	sub resource($$;$) {	1350	sub resource($$;$) {
1121	my ($self, $name) = (shift, shift);	1351	my ($self, $name) = (shift, shift);
1122	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1352	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1123	&urxvt::term::_resource	1353	goto &urxvt::term::_resource
1124	}	1354	}
1125		1355
1126	=item $value = $term->x_resource ($pattern)	1356	=item $value = $term->x_resource ($pattern)
1127		1357
1128	Returns the X-Resource for the given pattern, excluding the program or	1358	Returns the X-Resource for the given pattern, excluding the program or
…		…
1153		1383
1154	=item ($row, $col) = $term->selection_beg ([$row, $col])	1384	=item ($row, $col) = $term->selection_beg ([$row, $col])
1155		1385
1156	=item ($row, $col) = $term->selection_end ([$row, $col])	1386	=item ($row, $col) = $term->selection_end ([$row, $col])
1157		1387
1158	Return the current values of the selection mark, begin or end positions,	1388	Return the current values of the selection mark, begin or end positions.
1159	and optionally set them to new values.	1389
		1390	When arguments are given, then the selection coordinates are set to
		1391	C<$row> and C<$col>, and the selection screen is set to the current
		1392	screen.
		1393
		1394	=item $screen = $term->selection_screen ([$screen])
		1395
		1396	Returns the current selection screen, and then optionally sets it.
1160		1397
1161	=item $term->selection_make ($eventtime[, $rectangular])	1398	=item $term->selection_make ($eventtime[, $rectangular])
1162		1399
1163	Tries to make a selection as set by C<selection_beg> and	1400	Tries to make a selection as set by C<selection_beg> and
1164	C<selection_end>. If C<$rectangular> is true (default: false), a	1401	C<selection_end>. If C<$rectangular> is true (default: false), a
1165	rectangular selection will be made. This is the prefered function to make	1402	rectangular selection will be made. This is the preferred function to make
1166	a selection.	1403	a selection.
1167		1404
1168	=item $success = $term->selection_grab ($eventtime)	1405	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1169		1406
1170	Try to request the primary selection text from the server (for example, as	1407	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1408	true) selection from the server. The corresponding text can be set
1171	set by the next method). No visual feedback will be given. This function	1409	with the next method. No visual feedback will be given. This function
1172	is mostly useful from within C<on_sel_grab> hooks.	1410	is mostly useful from within C<on_sel_grab> hooks.
1173		1411
1174	=item $oldtext = $term->selection ([$newtext])	1412	=item $oldtext = $term->selection ([$newtext, $clipboard])
1175		1413
1176	Return the current selection text and optionally replace it by C<$newtext>.	1414	Return the current selection (clipboard if C<$clipboard> is true) text
		1415	and optionally replace it by C<$newtext>.
		1416
		1417	=item $term->selection_clear ([$clipboard])
		1418
		1419	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1177		1420
1178	=item $term->overlay_simple ($x, $y, $text)	1421	=item $term->overlay_simple ($x, $y, $text)
1179		1422
1180	Create a simple multi-line overlay box. See the next method for details.	1423	Create a simple multi-line overlay box. See the next method for details.
1181		1424
…		…
1211		1454
1212	The methods currently supported on C<urxvt::overlay> objects are:	1455	The methods currently supported on C<urxvt::overlay> objects are:
1213		1456
1214	=over 4	1457	=over 4
1215		1458
1216	=item $overlay->set ($x, $y, $text, $rend)	1459	=item $overlay->set ($x, $y, $text[, $rend])
1217		1460
1218	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1461	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1219	text in rxvt-unicode's special encoding and an array of rendition values	1462	text in rxvt-unicode's special encoding and an array of rendition values
1220	at a specific position inside the overlay.	1463	at a specific position inside the overlay.
		1464
		1465	If C<$rend> is missing, then the rendition will not be changed.
1221		1466
1222	=item $overlay->hide	1467	=item $overlay->hide
1223		1468
1224	If visible, hide the overlay, but do not destroy it.	1469	If visible, hide the overlay, but do not destroy it.
1225		1470
…		…
1307	locale-specific encoding of the terminal and can contain command sequences	1552	locale-specific encoding of the terminal and can contain command sequences
1308	(escape codes) that will be interpreted.	1553	(escape codes) that will be interpreted.
1309		1554
1310	=item $term->tt_write ($octets)	1555	=item $term->tt_write ($octets)
1311		1556
1312	Write the octets given in C<$data> to the tty (i.e. as program input). To	1557	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1313	pass characters instead of octets, you should convert your strings first	1558	pass characters instead of octets, you should convert your strings first
1314	to the locale-specific encoding using C<< $term->locale_encode >>.	1559	to the locale-specific encoding using C<< $term->locale_encode >>.
		1560
		1561	=item $term->tt_paste ($octets)
		1562
		1563	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1564	CR and bracketing the data with control sequences if bracketed paste mode
		1565	is set.
1315		1566
1316	=item $old_events = $term->pty_ev_events ([$new_events])	1567	=item $old_events = $term->pty_ev_events ([$new_events])
1317		1568
1318	Replaces the event mask of the pty watcher by the given event mask. Can	1569	Replaces the event mask of the pty watcher by the given event mask. Can
1319	be used to suppress input and output handling to the pty/tty. See the	1570	be used to suppress input and output handling to the pty/tty. See the
…		…
1338	Adds the specified events to the vt event mask. Useful e.g. when you want	1589	Adds the specified events to the vt event mask. Useful e.g. when you want
1339	to receive pointer events all the times:	1590	to receive pointer events all the times:
1340		1591
1341	$term->vt_emask_add (urxvt::PointerMotionMask);	1592	$term->vt_emask_add (urxvt::PointerMotionMask);
1342		1593
		1594	=item $term->focus_in
		1595
		1596	=item $term->focus_out
		1597
		1598	=item $term->key_press ($state, $keycode[, $time])
		1599
		1600	=item $term->key_release ($state, $keycode[, $time])
		1601
		1602	Deliver various fake events to to terminal.
		1603
1343	=item $window_width = $term->width	1604	=item $window_width = $term->width
1344		1605
1345	=item $window_height = $term->height	1606	=item $window_height = $term->height
1346		1607
1347	=item $font_width = $term->fwidth	1608	=item $font_width = $term->fwidth
…		…
1377	=item $env = $term->env	1638	=item $env = $term->env
1378		1639
1379	Returns a copy of the environment in effect for the terminal as a hashref	1640	Returns a copy of the environment in effect for the terminal as a hashref
1380	similar to C<\%ENV>.	1641	similar to C<\%ENV>.
1381		1642
		1643	=item @envv = $term->envv
		1644
		1645	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1646
		1647	=item @argv = $term->argv
		1648
		1649	Return the argument vector as this terminal, similar to @ARGV, but
		1650	includes the program name as first element.
		1651
1382	=cut	1652	=cut
1383		1653
1384	sub env {	1654	sub env {
1385	if (my $env = $_[0]->_env) {
1386	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1655	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1387	} else {
1388	+{ %ENV }
1389	}
1390	}	1656	}
1391		1657
1392	=item $modifiermask = $term->ModLevel3Mask	1658	=item $modifiermask = $term->ModLevel3Mask
1393		1659
1394	=item $modifiermask = $term->ModMetaMask	1660	=item $modifiermask = $term->ModMetaMask
…		…
1402		1668
1403	Returns the currently displayed screen (0 primary, 1 secondary).	1669	Returns the currently displayed screen (0 primary, 1 secondary).
1404		1670
1405	=item $cursor_is_hidden = $term->hidden_cursor	1671	=item $cursor_is_hidden = $term->hidden_cursor
1406		1672
1407	Returns wether the cursor is currently hidden or not.	1673	Returns whether the cursor is currently hidden or not.
1408		1674
1409	=item $view_start = $term->view_start ([$newvalue])	1675	=item $view_start = $term->view_start ([$newvalue])
1410		1676
1411	Returns the row number of the topmost displayed line. Maximum value is	1677	Returns the row number of the topmost displayed line. Maximum value is
1412	C<0>, which displays the normal terminal contents. Lower values scroll	1678	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1420		1686
1421	Used after changing terminal contents to display them.	1687	Used after changing terminal contents to display them.
1422		1688
1423	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1689	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1424		1690
1425	Returns the text of the entire row with number C<$row_number>. Row C<0>	1691	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1426	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1692	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1427	terminal line. The scrollback buffer starts at line C<-1> and extends to
1428	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1693	terminal line. Nothing will be returned if a nonexistent line
1429	is requested.	1694	is requested.
1430		1695
1431	If C<$new_text> is specified, it will replace characters in the current	1696	If C<$new_text> is specified, it will replace characters in the current
1432	line, starting at column C<$start_col> (default C<0>), which is useful	1697	line, starting at column C<$start_col> (default C<0>), which is useful
1433	to replace only parts of a line. The font index in the rendition will	1698	to replace only parts of a line. The font index in the rendition will
1434	automatically be updated.	1699	automatically be updated.
1435		1700
1436	C<$text> is in a special encoding: tabs and wide characters that use more	1701	C<$text> is in a special encoding: tabs and wide characters that use more
1437	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1702	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1438	characters. Characters with combining characters and other characters that	1703	characters. Characters with combining characters and other characters that
1439	do not fit into the normal tetx encoding will be replaced with characters	1704	do not fit into the normal text encoding will be replaced with characters
1440	in the private use area.	1705	in the private use area.
1441		1706
1442	You have to obey this encoding when changing text. The advantage is	1707	You have to obey this encoding when changing text. The advantage is
1443	that C<substr> and similar functions work on screen cells and not on	1708	that C<substr> and similar functions work on screen cells and not on
1444	characters.	1709	characters.
…		…
1589	where one character corresponds to one screen cell. See	1854	where one character corresponds to one screen cell. See
1590	C<< $term->ROW_t >> for details.	1855	C<< $term->ROW_t >> for details.
1591		1856
1592	=item $string = $term->special_decode $text	1857	=item $string = $term->special_decode $text
1593		1858
1594	Converts rxvt-unicodes text reprsentation into a perl string. See	1859	Converts rxvt-unicodes text representation into a perl string. See
1595	C<< $term->ROW_t >> for details.	1860	C<< $term->ROW_t >> for details.
1596		1861
1597	=item $success = $term->grab_button ($button, $modifiermask)	1862	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1598		1863
		1864	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1865
1599	Registers a synchronous button grab. See the XGrabButton manpage.	1866	Register/unregister a synchronous button grab. See the XGrabButton
		1867	manpage.
1600		1868
1601	=item $success = $term->grab ($eventtime[, $sync])	1869	=item $success = $term->grab ($eventtime[, $sync])
1602		1870
1603	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1871	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1604	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1872	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1605		1873
1606	=item $term->allow_events_async	1874	=item $term->allow_events_async
1607		1875
1608	Calls XAllowEvents with AsyncBoth for the most recent grab.	1876	Calls XAllowEvents with AsyncBoth for the most recent grab.
1609		1877
…		…
1616	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1884	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1617	recent grab.	1885	recent grab.
1618		1886
1619	=item $term->ungrab	1887	=item $term->ungrab
1620		1888
1621	Calls XUngrab for the most recent grab. Is called automatically on	1889	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1622	evaluation errors, as it is better to lose the grab in the error case as	1890	evaluation errors, as it is better to lose the grab in the error case as
1623	the session.	1891	the session.
1624		1892
1625	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1893	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1626		1894
…		…
1628		1896
1629	=item @atoms = $term->XListProperties ($window)	1897	=item @atoms = $term->XListProperties ($window)
1630		1898
1631	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1899	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1632		1900
1633	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1901	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1634		1902
1635	=item $term->XDeleteProperty ($window, $property)	1903	=item $term->XDeleteProperty ($window, $property)
1636		1904
1637	=item $window = $term->DefaultRootWindow	1905	=item $window = $term->DefaultRootWindow
1638		1906
…		…
1648		1916
1649	=item $term->XChangeInput ($window, $add_events[, $del_events])	1917	=item $term->XChangeInput ($window, $add_events[, $del_events])
1650		1918
1651	Various X or X-related functions. The C<$term> object only serves as	1919	Various X or X-related functions. The C<$term> object only serves as
1652	the source of the display, otherwise those functions map more-or-less	1920	the source of the display, otherwise those functions map more-or-less
1653	directory onto the X functions of the same name.	1921	directly onto the X functions of the same name.
1654		1922
1655	=back	1923	=back
1656		1924
1657	=cut	1925	=cut
1658		1926
…		…
1722	my ($self, $text, $cb) = @_;	1990	my ($self, $text, $cb) = @_;
1723		1991
1724	$self->add_item ({ type => "button", text => $text, activate => $cb});	1992	$self->add_item ({ type => "button", text => $text, activate => $cb});
1725	}	1993	}
1726		1994
1727	=item $popup->add_toggle ($text, $cb, $initial_value)	1995	=item $popup->add_toggle ($text, $initial_value, $cb)
1728		1996
1729	Adds a toggle/checkbox item to the popup. Teh callback gets called	1997	Adds a toggle/checkbox item to the popup. The callback gets called
1730	whenever it gets toggled, with a boolean indicating its value as its first	1998	whenever it gets toggled, with a boolean indicating its new value as its
1731	argument.	1999	first argument.
1732		2000
1733	=cut	2001	=cut
1734		2002
1735	sub add_toggle {	2003	sub add_toggle {
1736	my ($self, $text, $cb, $value) = @_;	2004	my ($self, $text, $value, $cb) = @_;
1737		2005
1738	my $item; $item = {	2006	my $item; $item = {
1739	type => "button",	2007	type => "button",
1740	text => " $text",	2008	text => " $text",
1741	value => $value,	2009	value => $value,
…		…
1760	my $env = $self->{term}->env;	2028	my $env = $self->{term}->env;
1761	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2029	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1762	delete $env->{LC_ALL};	2030	delete $env->{LC_ALL};
1763	$env->{LC_CTYPE} = $self->{term}->locale;	2031	$env->{LC_CTYPE} = $self->{term}->locale;
1764		2032
1765	urxvt::term->new ($env, "popup",	2033	my $term = urxvt::term->new (
		2034	$env, "popup",
1766	"--perl-lib" => "", "--perl-ext-common" => "",	2035	"--perl-lib" => "", "--perl-ext-common" => "",
1767	"-pty-fd" => -1, "-sl" => 0,	2036	"-pty-fd" => -1, "-sl" => 0,
1768	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2037	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1769	"--transient-for" => $self->{term}->parent,	2038	"--transient-for" => $self->{term}->parent,
1770	"-display" => $self->{term}->display_id,	2039	"-display" => $self->{term}->display_id,
1771	"-pe" => "urxvt-popup")	2040	"-pe" => "urxvt-popup",
1772	or die "unable to create popup window\n";	2041	) or die "unable to create popup window\n";
		2042
		2043	unless (delete $term->{urxvt_popup_init_done}) {
		2044	$term->ungrab;
		2045	$term->destroy;
		2046	die "unable to initialise popup window\n";
		2047	}
1773	}	2048	}
1774		2049
1775	sub DESTROY {	2050	sub DESTROY {
1776	my ($self) = @_;	2051	my ($self) = @_;
1777		2052
…		…
1782	=back	2057	=back
1783		2058
1784	=cut	2059	=cut
1785		2060
1786	package urxvt::watcher;	2061	package urxvt::watcher;
1787
1788	@urxvt::timer::ISA = __PACKAGE__;
1789	@urxvt::iow::ISA = __PACKAGE__;
1790	@urxvt::pw::ISA = __PACKAGE__;
1791	@urxvt::iw::ISA = __PACKAGE__;
1792		2062
1793	=head2 The C<urxvt::timer> Class	2063	=head2 The C<urxvt::timer> Class
1794		2064
1795	This class implements timer watchers/events. Time is represented as a	2065	This class implements timer watchers/events. Time is represented as a
1796	fractional number of seconds since the epoch. Example:	2066	fractional number of seconds since the epoch. Example:
…		…
1800	->new	2070	->new
1801	->interval (1)	2071	->interval (1)
1802	->cb (sub {	2072	->cb (sub {
1803	$term->{overlay}->set (0, 0,	2073	$term->{overlay}->set (0, 0,
1804	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2074	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1805	});	2075	});
1806		2076
1807	=over 4	2077	=over 4
1808		2078
1809	=item $timer = new urxvt::timer	2079	=item $timer = new urxvt::timer
1810		2080
…		…
1813		2083
1814	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2084	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1815		2085
1816	Set the callback to be called when the timer triggers.	2086	Set the callback to be called when the timer triggers.
1817		2087
1818	=item $tstamp = $timer->at
1819
1820	Return the time this watcher will fire next.
1821
1822	=item $timer = $timer->set ($tstamp)	2088	=item $timer = $timer->set ($tstamp[, $interval])
1823		2089
1824	Set the time the event is generated to $tstamp.	2090	Set the time the event is generated to $tstamp (and optionally specifies a
		2091	new $interval).
1825		2092
1826	=item $timer = $timer->interval ($interval)	2093	=item $timer = $timer->interval ($interval)
1827		2094
1828	Normally (and when C<$interval> is C<0>), the timer will automatically	2095	By default (and when C<$interval> is C<0>), the timer will automatically
1829	stop after it has fired once. If C<$interval> is non-zero, then the timer	2096	stop after it has fired once. If C<$interval> is non-zero, then the timer
1830	is automatically rescheduled at the given intervals.	2097	is automatically rescheduled at the given intervals.
1831		2098
1832	=item $timer = $timer->start	2099	=item $timer = $timer->start
1833		2100
1834	Start the timer.	2101	Start the timer.
1835		2102
1836	=item $timer = $timer->start ($tstamp)	2103	=item $timer = $timer->start ($tstamp[, $interval])
1837		2104
1838	Set the event trigger time to C<$tstamp> and start the timer.	2105	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2106	also replaces the interval.
1839		2107
1840	=item $timer = $timer->after ($delay)	2108	=item $timer = $timer->after ($delay[, $interval])
1841		2109
1842	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2110	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1843		2111
1844	=item $timer = $timer->stop	2112	=item $timer = $timer->stop
1845		2113
…		…
1853		2121
1854	$term->{socket} = ...	2122	$term->{socket} = ...
1855	$term->{iow} = urxvt::iow	2123	$term->{iow} = urxvt::iow
1856	->new	2124	->new
1857	->fd (fileno $term->{socket})	2125	->fd (fileno $term->{socket})
1858	->events (urxvt::EVENT_READ)	2126	->events (urxvt::EV_READ)
1859	->start	2127	->start
1860	->cb (sub {	2128	->cb (sub {
1861	my ($iow, $revents) = @_;	2129	my ($iow, $revents) = @_;
1862	# $revents must be 1 here, no need to check	2130	# $revents must be 1 here, no need to check
1863	sysread $term->{socket}, my $buf, 8192	2131	sysread $term->{socket}, my $buf, 8192
…		…
1876	Set the callback to be called when io events are triggered. C<$reventmask>	2144	Set the callback to be called when io events are triggered. C<$reventmask>
1877	is a bitset as described in the C<events> method.	2145	is a bitset as described in the C<events> method.
1878		2146
1879	=item $iow = $iow->fd ($fd)	2147	=item $iow = $iow->fd ($fd)
1880		2148
1881	Set the filedescriptor (not handle) to watch.	2149	Set the file descriptor (not handle) to watch.
1882		2150
1883	=item $iow = $iow->events ($eventmask)	2151	=item $iow = $iow->events ($eventmask)
1884		2152
1885	Set the event mask to watch. The only allowed values are	2153	Set the event mask to watch. The only allowed values are
1886	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2154	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1887	together, or C<urxvt::EVENT_NONE>.	2155	together, or C<urxvt::EV_NONE>.
1888		2156
1889	=item $iow = $iow->start	2157	=item $iow = $iow->start
1890		2158
1891	Start watching for requested events on the given handle.	2159	Start watching for requested events on the given handle.
1892		2160
1893	=item $iow = $iow->stop	2161	=item $iow = $iow->stop
1894		2162
1895	Stop watching for events on the given filehandle.	2163	Stop watching for events on the given file handle.
1896		2164
1897	=back	2165	=back
1898		2166
1899	=head2 The C<urxvt::iw> Class	2167	=head2 The C<urxvt::iw> Class
1900		2168
…		…
1933	->new	2201	->new
1934	->start ($pid)	2202	->start ($pid)
1935	->cb (sub {	2203	->cb (sub {
1936	my ($pw, $exit_status) = @_;	2204	my ($pw, $exit_status) = @_;
1937	...	2205	...
1938	});	2206	});
1939		2207
1940	=over 4	2208	=over 4
1941		2209
1942	=item $pw = new urxvt::pw	2210	=item $pw = new urxvt::pw
1943		2211
…		…
1947		2215
1948	Set the callback to be called when the timer triggers.	2216	Set the callback to be called when the timer triggers.
1949		2217
1950	=item $pw = $timer->start ($pid)	2218	=item $pw = $timer->start ($pid)
1951		2219
1952	Tells the wqtcher to start watching for process C<$pid>.	2220	Tells the watcher to start watching for process C<$pid>.
1953		2221
1954	=item $pw = $pw->stop	2222	=item $pw = $pw->stop
1955		2223
1956	Stop the watcher.	2224	Stop the watcher.
1957		2225
…		…
1970		2238
1971	=item >= 3 - script loading and management	2239	=item >= 3 - script loading and management
1972		2240
1973	=item >=10 - all called hooks	2241	=item >=10 - all called hooks
1974		2242
1975	=item >=11 - hook reutrn values	2243	=item >=11 - hook return values
1976		2244
1977	=back	2245	=back
1978		2246
1979	=head1 AUTHOR	2247	=head1 AUTHOR
1980		2248
…		…
1982	http://software.schmorp.de/pkg/rxvt-unicode	2250	http://software.schmorp.de/pkg/rxvt-unicode
1983		2251
1984	=cut	2252	=cut
1985		2253
1986	1	2254	1
		2255
		2256	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.127 by root, Wed Jan 25 00:42:21 2006 UTC vs. Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.127 by root, Wed Jan 25 00:42:21 2006 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC