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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.153 by root, Sat Jun 2 05:23:11 2007 UTC vs.
Revision 1.216 by root, Sun Jun 10 13:32:55 2012 UTC

…		…
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Every time a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
98		101
99	Other extensions can extend this popup menu by pushing a code reference	102	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the	103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.	104	popup is being displayed.
102		105
103	It's sole argument is the popup menu, which can be modified. It should	106	Its sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code	107	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference	108	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as	109	will be called when the toggle changes, with the new boolean value as
107	first argument.	110	first argument.
108		111
109	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
111		114
112	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};	117	};
115		118
…		…
121		124
122	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
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.	127	popup is being displayed.
125		128
126	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
127	is in C<$_>, which can be used to decide whether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
128	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
129	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
130	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
131		134
132	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
133	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
134	C<a>s:	137	C<a>s:
135		138
136	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
138	: ()	141	: ()
139	};	142	};
140		143
141	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
142		145
…		…
149	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>
150	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
151	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
152	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
153	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
154	selection.	157	selection if the C<Shift> modifier is active.
155		158
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To	159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>	160	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.	161	or simply use an uppercase character which removes the "(?i)" prefix.
159		162
…		…
162	=item readline (enabled by default)	165	=item readline (enabled by default)
163		166
164	A support package that tries to make editing with readline easier. At	167	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
166	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
167	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
168	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
169		172
170	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
171		174
172	=over 4	175	=over 4
…		…
256	The default pattern to match URLs can be overridden with the	259	The default pattern to match URLs can be overridden with the
257	C<matcher.pattern.0> resource, and additional patterns can be specified	260	C<matcher.pattern.0> resource, and additional patterns can be specified
258	with numbered patterns, in a manner similar to the "selection" extension.	261	with numbered patterns, in a manner similar to the "selection" extension.
259	The launcher can also be overridden on a per-pattern basis.	262	The launcher can also be overridden on a per-pattern basis.
260		263
		264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
		266	"perl:matcher:list" as seen in the example below.
		267
261	Example configuration:	268	Example configuration:
262		269
263	URxvt.perl-ext: default,matcher	270	URxvt.perl-ext: default,matcher
264	URxvt.urlLauncher: sensible-browser	271	URxvt.urlLauncher: sensible-browser
265	URxvt.keysym.C-Delete: perl:matcher	272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
266	URxvt.matcher.button: 1	274	URxvt.matcher.button: 1
267	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]	275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
268	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)	276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
269	URxvt.matcher.launcher.2: gvim +$2 $1	277	URxvt.matcher.launcher.2: gvim +$2 $1
270		278
271	=item xim-onthespot	279	=item xim-onthespot
272		280
273	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
274	not work perfectly, and some input methods don't seem to work well with	282	not work perfectly, and some input methods don't seem to work well with
275	OnTheSpot editing in general, but it seems to work at leats for SCIM and	283	OnTheSpot editing in general, but it seems to work at least for SCIM and
276	kinput2.	284	kinput2.
277		285
278	You enable it by specifying this extension and a preedit style of	286	You enable it by specifying this extension and a preedit style of
279	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
280		288
…		…
288	will show or hide itself. Another press of the accelerator key will hide	296	will show or hide itself. Another press of the accelerator key will hide
289	or show it again.	297	or show it again.
290		298
291	Initially, the window will not be shown when using this extension.	299	Initially, the window will not be shown when using this extension.
292		300
293	This is useful if you need a single terminal thats not using any desktop	301	This is useful if you need a single terminal that is not using any desktop
294	space most of the time but is quickly available at the press of a key.	302	space most of the time but is quickly available at the press of a key.
295		303
296	The accelerator key is grabbed regardless of any modifiers, so this	304	The accelerator key is grabbed regardless of any modifiers, so this
297	extension will actually grab a physical key just for this function.	305	extension will actually grab a physical key just for this function.
298		306
299	If you want a quake-like animation, tell your window manager to do so	307	If you want a quake-like animation, tell your window manager to do so
300	(fvwm can do it).	308	(fvwm can do it).
301		309
302	=item automove-background	310	=item overlay-osc
303		311
304	This is basically a very small extension that dynamically changes the	312	This extension implements some OSC commands to display timed popups on the
305	background pixmap offset to the window position, in effect creating the	313	screen - useful for status displays from within scripts. You have to read
306	same effect as pseudo transparency with a custom pixmap. No scaling is	314	the sources for more info.
307	supported in this mode. Example:
308
309	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
310
311	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
312	shows how this extension can be used to implement an automatically blurred
313	transparent background.
314		315
315	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
316		317
317	A not very useful example of filtering all text output to the terminal	318	A not very useful example of filtering all text output to the terminal
318	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
323	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
324		325
325	=item remote-clipboard	326	=item remote-clipboard
326		327
327	Somewhat of a misnomer, this extension adds two menu entries to the	328	Somewhat of a misnomer, this extension adds two menu entries to the
328	selection popup that allows one ti run external commands to store the	329	selection popup that allows one to run external commands to store the
329	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
330		331
331	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
332	means that one command uploads the file to a remote server, and another	333	means that one command uploads the file to a remote server, and another
333	reads it.	334	reads it.
…		…
342	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
343	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
344		345
345	=item selection-pastebin	346	=item selection-pastebin
346		347
347	This is a little rarely useful extension that Uploads the selection as	348	This is a little rarely useful extension that uploads the selection as
348	textfile to a remote site (or does other things). (The implementation is	349	textfile to a remote site (or does other things). (The implementation is
349	not currently secure for use in a multiuser environment as it writes to	350	not currently secure for use in a multiuser environment as it writes to
350	F</tmp> directly.).	351	F</tmp> directly.).
351		352
352	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
371		372
372	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
373		374
374	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
375	the double C</> characters as comment start. Use C<\057\057> instead,	376	the double C</> characters as comment start. Use C<\057\057> instead,
376	which works regardless of wether xrdb is used to parse the resource file	377	which works regardless of whether xrdb is used to parse the resource file
377	or not.	378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
378		393
379	=item example-refresh-hooks	394	=item example-refresh-hooks
380		395
381	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
382	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
383	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
384		412
385	=back	413	=back
386		414
387	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
388		416
…		…
404		432
405	=over 4	433	=over 4
406		434
407	=item $text	435	=item $text
408		436
409	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
410	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
411		439
412	=item $string	440	=item $string
413		441
414	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
418	=item $octets	446	=item $octets
419		447
420	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
421	locale-specific way.	449	locale-specific way.
422		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
423	=back	457	=back
424		458
425	=head2 Extension Objects	459	=head2 Extension Objects
426		460
427	Every perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
428	for each terminal, and each terminal has its own set of extenion objects,	462	for each terminal, and each terminal has its own set of extension objects,
429	which are passed as the first parameter to hooks. So extensions can use	463	which are passed as the first parameter to hooks. So extensions can use
430	their C<$self> object without having to think about clashes with other	464	their C<$self> object without having to think about clashes with other
431	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
432	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
433	internal use.	467	internal use.
…		…
548		582
549	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	583	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
550	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	584	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
551	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
552		586
553	=item on_osc_seq $term, $op, $args	587	=item on_osc_seq $term, $op, $args, $resp
554		588
555	Called on every OSC sequence and can be used to suppress it or modify its	589	Called on every OSC sequence and can be used to suppress it or modify its
556	behaviour. The default should be to return an empty list. A true value	590	behaviour. The default should be to return an empty list. A true value
557	suppresses execution of the request completely. Make sure you don't get	591	suppresses execution of the request completely. Make sure you don't get
558	confused by recursive invocations when you output an osc sequence within	592	confused by recursive invocations when you output an OSC sequence within
559	this callback.	593	this callback.
560		594
561	C<on_osc_seq_perl> should be used for new behaviour.	595	C<on_osc_seq_perl> should be used for new behaviour.
562		596
563	=item on_osc_seq_perl $term, $string	597	=item on_osc_seq_perl $term, $args, $resp
564		598
565	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
566	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
567	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
568	string should start with the extension name and a colon, to distinguish	602	string should start with the extension name (sans -osc) and a semicolon,
569	it from commands for other extensions, and this might be enforced in the	603	to distinguish it from commands for other extensions, and this might be
570	future.	604	enforced in the future.
		605
		606	For example, C<overlay-osc> uses this:
		607
		608	sub on_osc_seq_perl {
		609	my ($self, $osc, $resp) = @_;
		610
		611	return unless $osc =~ s/^overlay;//;
		612
		613	... process remaining $osc string
		614	}
571		615
572	Be careful not ever to trust (in a security sense) the data you receive,	616	Be careful not ever to trust (in a security sense) the data you receive,
573	as its source can not easily be controlled (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
574	other users on the same system etc.).	618	other users on the same system etc.).
		619
		620	For responses, C<$resp> contains the end-of-args separator used by the
		621	sender.
575		622
576	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
577		624
578	Called whenever text is about to be output, with the text as argument. You	625	Called whenever text is about to be output, with the text as argument. You
579	can filter/change and output the text yourself by returning a true value	626	can filter/change and output the text yourself by returning a true value
…		…
584	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
585		632
586	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
587	suppress or filter tty input.	634	suppress or filter tty input.
588		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
589	=item on_line_update $term, $row	643	=item on_line_update $term, $row
590		644
591	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
592	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
593	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
600	later with the already-modified line (e.g. if unrelated parts change), so	654	later with the already-modified line (e.g. if unrelated parts change), so
601	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
602		656
603	=item on_refresh_begin $term	657	=item on_refresh_begin $term
604		658
605	Called just before the screen gets redrawn. Can be used for overlay	659	Called just before the screen gets redrawn. Can be used for overlay or
606	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
607	restoring them in refresh_end. The built-in overlay and selection display	661	restoring them in refresh_end. The built-in overlay and selection display
608	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
609		663
610	=item on_refresh_end $term	664	=item on_refresh_end $term
611		665
…		…
618	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
619		673
620	The event is simply the action string. This interface is assumed to change	674	The event is simply the action string. This interface is assumed to change
621	slightly in the future.	675	slightly in the future.
622		676
		677	=item on_register_command $term, $keysym, $modifiermask, $string
		678
		679	Called after parsing a keysym resource but before registering the
		680	associated binding. If this hook returns TRUE the binding is not
		681	registered. It can be used to modify a binding by calling
		682	C<register_command>.
		683
623	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
624		685
625	Called just after the new window size has been calculated, but before	686	Called just after the new window size has been calculated, but before
626	windows are actually being resized or hints are being set. If this hook	687	windows are actually being resized or hints are being set. If this hook
627	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
628		689
…		…
662		723
663	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
664		725
665	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
666		727
667	Called whenever the corresponding X event is received for the terminal If	728	Called whenever the corresponding X event is received for the terminal. If
668	the hook returns true, then the even will be ignored by rxvt-unicode.	729	the hook returns true, then the event will be ignored by rxvt-unicode.
669		730
670	The event is a hash with most values as named by Xlib (see the XEvent	731	The event is a hash with most values as named by Xlib (see the XEvent
671	manpage), with the additional members C<row> and C<col>, which are the	732	manpage), with the additional members C<row> and C<col>, which are the
672	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
673		734
…		…
683	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
684		745
685	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
686	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
687		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
		752
688	=back	753	=back
689		754
690	=cut	755	=cut
691		756
692	package urxvt;	757	package urxvt;
693		758
694	use utf8;	759	use utf8;
695	use strict;	760	use strict 'vars';
696	use Carp ();	761	use Carp ();
697	use Scalar::Util ();	762	use Scalar::Util ();
698	use List::Util ();	763	use List::Util ();
699		764
700	our $VERSION = 1;	765	our $VERSION = 1;
701	our $TERM;	766	our $TERM;
702	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
703	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
704	our @HOOKNAME;	769	our @HOOKNAME;
705	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
706	our %OPTION;	771	our %OPTION;
707		772
708	our $LIBDIR;	773	our $LIBDIR;
…		…
756		821
757	=over 4	822	=over 4
758		823
759	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
760		825
761	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
762	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
763	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
764		830
765	=item urxvt::warn $string	831	=item urxvt::warn $string
766		832
767	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
768	newline. The module also overwrites the C<warn> builtin with a function	834	newline. The module also overwrites the C<warn> builtin with a function
769	that calls this function.	835	that calls this function.
770		836
771	Using this function has the advantage that its output ends up in the	837	Using this function has the advantage that its output ends up in the
772	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
776	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
777		843
778	Returns all urxvt::term objects that exist in this process, regardless of	844	Returns all urxvt::term objects that exist in this process, regardless of
779	whether they are started, being destroyed etc., so be careful. Only term	845	whether they are started, being destroyed etc., so be careful. Only term
780	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
781	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
782		848
783	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
784		850
785	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
786		852
…		…
829		895
830	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
831		897
832	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
833		899
834	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
835		902
836	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
837	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
838	the bitset.	905	the bitset.
839		906
…		…
876	};	943	};
877	}	944	}
878		945
879	no warnings 'utf8';	946	no warnings 'utf8';
880		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$name =~ y/-/./ if $isarg;
		952
		953	$term->scan_meta;
		954
		955	my $r = $term->{meta}{resource};
		956	keys %$r; # reste iterator
		957	while (my ($pattern, $v) = each %$r) {
		958	if (
		959	$pattern =~ /\.$/
		960	? $pattern eq substr $name, 0, length $pattern
		961	: $pattern eq $name
		962	) {
		963	$name = "$urxvt::RESCLASS.$name";
		964
		965	push @{ $term->{perl_ext_3} }, $v->[0];
		966
		967	if ($v->[1] eq "boolean") {
		968	$term->put_option_db ($name, $flag ? "true" : "false");
		969	return 1;
		970	} else {
		971	$term->put_option_db ($name, $value);
		972	return 1 + 2;
		973	}
		974	}
		975	}
		976
		977	0
		978	}
		979
		980	sub usage {
		981	my ($term, $usage_type) = @_;
		982
		983	$term->scan_meta;
		984
		985	my $r = $term->{meta}{resource};
		986
		987	for my $pattern (sort keys %$r) {
		988	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		989
		990	$desc .= " (-pe $ext)";
		991
		992	if ($usage_type == 1) {
		993	$pattern =~ y/./-/;
		994	$pattern =~ s/-$/-.../g;
		995
		996	if ($type eq "boolean") {
		997	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		998	} else {
		999	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		1000	}
		1001	} else {
		1002	$pattern =~ s/\.$/.*/g;
		1003	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1004	}
		1005	}
		1006	}
		1007
881	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1008	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
882		1009
883	sub verbose {	1010	sub verbose {
884	my ($level, $msg) = @_;	1011	my ($level, $msg) = @_;
885	warn "$msg\n" if $level <= $verbosity;	1012	warn "$msg\n" if $level <= $verbosity;
…		…
901		1028
902	open my $fh, "<:raw", $path	1029	open my $fh, "<:raw", $path
903	or die "$path: $!";	1030	or die "$path: $!";
904		1031
905	my $source =	1032	my $source =
906	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	1033	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
907	. "#line 1 \"$path\"\n{\n"	1034	. "#line 1 \"$path\"\n{\n"
908	. (do { local $/; <$fh> })	1035	. (do { local $/; <$fh> })
909	. "\n};\n1";	1036	. "\n};\n1";
910		1037
911	eval $source	1038	eval $source
…		…
921	sub invoke {	1048	sub invoke {
922	local $TERM = shift;	1049	local $TERM = shift;
923	my $htype = shift;	1050	my $htype = shift;
924		1051
925	if ($htype == 0) { # INIT	1052	if ($htype == 0) { # INIT
926	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1053	my @dirs = $TERM->perl_libdirs;
927		1054
928	my %ext_arg;	1055	my %ext_arg;
929		1056
930	{	1057	{
931	my @init = @TERM_INIT;	1058	my @init = @TERM_INIT;
932	@TERM_INIT = ();	1059	@TERM_INIT = ();
…		…
934	my @pkg = @TERM_EXT;	1061	my @pkg = @TERM_EXT;
935	@TERM_EXT = ();	1062	@TERM_EXT = ();
936	$TERM->register_package ($_) for @pkg;	1063	$TERM->register_package ($_) for @pkg;
937	}	1064	}
938		1065
		1066	for (
		1067	@{ delete $TERM->{perl_ext_3} },
939	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1068	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1069	) {
940	if ($_ eq "default") {	1070	if ($_ eq "default") {
941	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	1071	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
942	} elsif (/^-(.*)$/) {	1072	} elsif (/^-(.*)$/) {
943	delete $ext_arg{$1};	1073	delete $ext_arg{$1};
944	} elsif (/^([^<]+)<(.*)>$/) {	1074	} elsif (/^([^<]+)<(.*)>$/) {
…		…
1092	=head2 The C<urxvt::anyevent> Class	1222	=head2 The C<urxvt::anyevent> Class
1093		1223
1094	The sole purpose of this class is to deliver an interface to the	1224	The sole purpose of this class is to deliver an interface to the
1095	C<AnyEvent> module - any module using it will work inside urxvt without	1225	C<AnyEvent> module - any module using it will work inside urxvt without
1096	further programming. The only exception is that you cannot wait on	1226	further programming. The only exception is that you cannot wait on
1097	condition variables, but non-blocking condvar use is ok. What this means	1227	condition variables, but non-blocking condvar use is ok.
1098	is that you cannot use blocking APIs, but the non-blocking variant should	1228
1099	work.	1229	In practical terms this means is that you cannot use blocking APIs, but
		1230	the non-blocking variant should work.
1100		1231
1101	=cut	1232	=cut
1102		1233
1103	our $VERSION = 1;	1234	our $VERSION = '5.23';
1104		1235
1105	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1236	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1106	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1237	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1107		1238
1108	sub timer {	1239	sub timer {
…		…
1110		1241
1111	my $cb = $arg{cb};	1242	my $cb = $arg{cb};
1112		1243
1113	urxvt::timer	1244	urxvt::timer
1114	->new	1245	->new
1115	->start (urxvt::NOW + $arg{after})	1246	->after ($arg{after}, $arg{interval})
1116	->cb (sub {	1247	->cb ($arg{interval} ? $cb : sub {
1117	$_[0]->stop; # need to cancel manually	1248	$_[0]->stop; # need to cancel manually
1118	$cb->();	1249	$cb->();
1119	})	1250	})
1120	}	1251	}
1121		1252
1122	sub io {	1253	sub io {
1123	my ($class, %arg) = @_;	1254	my ($class, %arg) = @_;
1124		1255
1125	my $cb = $arg{cb};	1256	my $cb = $arg{cb};
		1257	my $fd = fileno $arg{fh};
		1258	defined $fd or $fd = $arg{fh};
1126		1259
1127	bless [$arg{fh}, urxvt::iow	1260	bless [$arg{fh}, urxvt::iow
1128	->new	1261	->new
1129	->fd (fileno $arg{fh})	1262	->fd ($fd)
1130	->events (($arg{poll} =~ /r/ ? 1 : 0)	1263	->events (($arg{poll} =~ /r/ ? 1 : 0)
1131	\| ($arg{poll} =~ /w/ ? 2 : 0))	1264	\| ($arg{poll} =~ /w/ ? 2 : 0))
1132	->start	1265	->start
1133	->cb (sub {	1266	->cb ($cb)
1134	$cb->(($_[1] & 1 ? 'r' : '')
1135	. ($_[1] & 2 ? 'w' : ''));
1136	})],
1137	urxvt::anyevent::	1267	], urxvt::anyevent::
		1268	}
		1269
		1270	sub idle {
		1271	my ($class, %arg) = @_;
		1272
		1273	my $cb = $arg{cb};
		1274
		1275	urxvt::iw
		1276	->new
		1277	->start
		1278	->cb ($cb)
		1279	}
		1280
		1281	sub child {
		1282	my ($class, %arg) = @_;
		1283
		1284	my $cb = $arg{cb};
		1285
		1286	urxvt::pw
		1287	->new
		1288	->start ($arg{pid})
		1289	->cb (sub {
		1290	$_[0]->stop; # need to cancel manually
		1291	$cb->($_[0]->rpid, $_[0]->rstatus);
		1292	})
1138	}	1293	}
1139		1294
1140	sub DESTROY {	1295	sub DESTROY {
1141	$_[0][1]->stop;	1296	$_[0][1]->stop;
1142	}	1297	}
1143		1298
1144	sub condvar {	1299	# only needed for AnyEvent < 6 compatibility
1145	bless \my $flag, urxvt::anyevent::
1146	}
1147
1148	sub broadcast {
1149	${$_[0]}++;
1150	}
1151
1152	sub wait {
1153	unless (${$_[0]}) {
1154	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1155	}
1156	}
1157
1158	sub one_event {	1300	sub one_event {
1159	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1301	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1160	}	1302	}
1161		1303
1162	package urxvt::term;	1304	package urxvt::term;
…		…
1191	$proxy->enable ($name => $ref);	1333	$proxy->enable ($name => $ref);
1192	}	1334	}
1193	}	1335	}
1194	}	1336	}
1195		1337
		1338	sub perl_libdirs {
		1339	map { split /:/ }
		1340	$_[0]->resource ("perl_lib"),
		1341	$ENV{URXVT_PERL_LIB},
		1342	"$ENV{HOME}/.urxvt/ext",
		1343	"$LIBDIR/perl"
		1344	}
		1345
		1346	sub scan_meta {
		1347	my ($self) = @_;
		1348	my @libdirs = perl_libdirs $self;
		1349
		1350	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1351
		1352	my %meta;
		1353
		1354	$self->{meta_libdirs} = join "\x00", @libdirs;
		1355	$self->{meta} = \%meta;
		1356
		1357	for my $dir (reverse @libdirs) {
		1358	opendir my $fh, $dir
		1359	or next;
		1360	for my $ext (readdir $fh) {
		1361	$ext ne "."
		1362	and $ext ne ".."
		1363	and open my $fh, "<", "$dir/$ext"
		1364	or next;
		1365
		1366	while (<$fh>) {
		1367	if (/^#:META:X_RESOURCE:(.*)/) {
		1368	my ($pattern, $type, $desc) = split /:/, $1;
		1369	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1370	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1371	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1372	} else {
		1373	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1374	}
		1375	} elsif (/^\s*(?:#\|$)/) {
		1376	# skip other comments and empty lines
		1377	} else {
		1378	last; # stop parsing on first non-empty non-comment line
		1379	}
		1380	}
		1381	}
		1382	}
		1383	}
		1384
1196	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1385	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1197		1386
1198	Creates a new terminal, very similar as if you had started it with system	1387	Creates a new terminal, very similar as if you had started it with system
1199	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1388	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1200	hash which defines the environment of the new terminal.	1389	hash which defines the environment of the new terminal.
…		…
1254	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1443	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1255		1444
1256	Here is a likely non-exhaustive list of option names, please see the	1445	Here is a likely non-exhaustive list of option names, please see the
1257	source file F</src/optinc.h> to see the actual list:	1446	source file F</src/optinc.h> to see the actual list:
1258		1447
1259	borderLess console cursorBlink cursorUnderline hold iconic insecure	1448	borderLess buffered console cursorBlink cursorUnderline hold iconic
1260	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1449	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1261	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1450	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1262	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1451	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1263	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1452	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1264	transparent tripleclickwords utmpInhibit visualBell	1453	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1454	urgentOnBell utmpInhibit visualBell
1265		1455
1266	=item $value = $term->resource ($name[, $newval])	1456	=item $value = $term->resource ($name[, $newval])
1267		1457
1268	Returns the current resource value associated with a given name and	1458	Returns the current resource value associated with a given name and
1269	optionally sets a new value. Setting values is most useful in the C<init>	1459	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1282		1472
1283	Here is a likely non-exhaustive list of resource names, not all of which	1473	Here is a likely non-exhaustive list of resource names, not all of which
1284	are supported in every build, please see the source file F</src/rsinc.h>	1474	are supported in every build, please see the source file F</src/rsinc.h>
1285	to see the actual list:	1475	to see the actual list:
1286		1476
1287	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1477	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1288	borderLess color cursorBlink cursorUnderline cutchars delete_key	1478	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1289	display_name embed ext_bwidth fade font geometry hold iconName	1479	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1290	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1480	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1481	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1291	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1482	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1292	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1483	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1293	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1484	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1294	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1485	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1295	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1486	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1296	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1487	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1297	secondaryScreen secondaryScroll selectstyle shade term_name title	1488	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1298	transient_for transparent transparent_all tripleclickwords utmpInhibit	1489	term_name title transient_for transparent tripleclickwords urgentOnBell
1299	visualBell	1490	utmpInhibit visualBell
1300		1491
1301	=cut	1492	=cut
1302		1493
1303	sub resource($$;$) {	1494	sub resource($$;$) {
1304	my ($self, $name) = (shift, shift);	1495	my ($self, $name) = (shift, shift);
1305	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1496	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1306	&urxvt::term::_resource	1497	goto &urxvt::term::_resource
1307	}	1498	}
1308		1499
1309	=item $value = $term->x_resource ($pattern)	1500	=item $value = $term->x_resource ($pattern)
1310		1501
1311	Returns the X-Resource for the given pattern, excluding the program or	1502	Returns the X-Resource for the given pattern, excluding the program or
…		…
1315		1506
1316	This method should only be called during the C<on_start> hook, as there is	1507	This method should only be called during the C<on_start> hook, as there is
1317	only one resource database per display, and later invocations might return	1508	only one resource database per display, and later invocations might return
1318	the wrong resources.	1509	the wrong resources.
1319		1510
1320	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1511	=item $value = $term->x_resource_boolean ($pattern)
1321		1512
		1513	Like C<x_resource>, above, but interprets the string value as a boolean
		1514	and returns C<1> for true values, C<0> for false values and C<undef> if
		1515	the resource or option isn't specified.
		1516
		1517	You should always use this method to parse boolean resources.
		1518
		1519	=cut
		1520
		1521	sub x_resource_boolean {
		1522	my $res = &x_resource;
		1523
		1524	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1525	}
		1526
		1527	=item $success = $term->parse_keysym ($key, $octets)
		1528
1322	Adds a keymap translation exactly as specified via a resource. See the	1529	Adds a key binding exactly as specified via a resource. See the
1323	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1530	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1531
		1532	=item $term->register_command ($keysym, $modifiermask, $string)
		1533
		1534	Adds a key binding. This is a lower level api compared to
		1535	C<parse_keysym>, as it expects a parsed key description, and can be
		1536	used only inside either the C<on_init> hook, to add a binding, or the
		1537	C<on_register_command> hook, to modify a parsed binding.
1324		1538
1325	=item $rend = $term->rstyle ([$new_rstyle])	1539	=item $rend = $term->rstyle ([$new_rstyle])
1326		1540
1327	Return and optionally change the current rendition. Text that is output by	1541	Return and optionally change the current rendition. Text that is output by
1328	the terminal application will use this style.	1542	the terminal application will use this style.
…		…
1336		1550
1337	=item ($row, $col) = $term->selection_beg ([$row, $col])	1551	=item ($row, $col) = $term->selection_beg ([$row, $col])
1338		1552
1339	=item ($row, $col) = $term->selection_end ([$row, $col])	1553	=item ($row, $col) = $term->selection_end ([$row, $col])
1340		1554
1341	Return the current values of the selection mark, begin or end positions,	1555	Return the current values of the selection mark, begin or end positions.
1342	and optionally set them to new values.	1556
		1557	When arguments are given, then the selection coordinates are set to
		1558	C<$row> and C<$col>, and the selection screen is set to the current
		1559	screen.
		1560
		1561	=item $screen = $term->selection_screen ([$screen])
		1562
		1563	Returns the current selection screen, and then optionally sets it.
1343		1564
1344	=item $term->selection_make ($eventtime[, $rectangular])	1565	=item $term->selection_make ($eventtime[, $rectangular])
1345		1566
1346	Tries to make a selection as set by C<selection_beg> and	1567	Tries to make a selection as set by C<selection_beg> and
1347	C<selection_end>. If C<$rectangular> is true (default: false), a	1568	C<selection_end>. If C<$rectangular> is true (default: false), a
1348	rectangular selection will be made. This is the prefered function to make	1569	rectangular selection will be made. This is the preferred function to make
1349	a selection.	1570	a selection.
1350		1571
1351	=item $success = $term->selection_grab ($eventtime)	1572	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1352		1573
1353	Try to request the primary selection text from the server (for example, as	1574	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1575	true) selection from the server. The corresponding text can be set
1354	set by the next method). No visual feedback will be given. This function	1576	with the next method. No visual feedback will be given. This function
1355	is mostly useful from within C<on_sel_grab> hooks.	1577	is mostly useful from within C<on_sel_grab> hooks.
1356		1578
1357	=item $oldtext = $term->selection ([$newtext])	1579	=item $oldtext = $term->selection ([$newtext, $clipboard])
1358		1580
1359	Return the current selection text and optionally replace it by C<$newtext>.	1581	Return the current selection (clipboard if C<$clipboard> is true) text
		1582	and optionally replace it by C<$newtext>.
		1583
		1584	=item $term->selection_clear ([$clipboard])
		1585
		1586	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1360		1587
1361	=item $term->overlay_simple ($x, $y, $text)	1588	=item $term->overlay_simple ($x, $y, $text)
1362		1589
1363	Create a simple multi-line overlay box. See the next method for details.	1590	Create a simple multi-line overlay box. See the next method for details.
1364		1591
…		…
1394		1621
1395	The methods currently supported on C<urxvt::overlay> objects are:	1622	The methods currently supported on C<urxvt::overlay> objects are:
1396		1623
1397	=over 4	1624	=over 4
1398		1625
1399	=item $overlay->set ($x, $y, $text, $rend)	1626	=item $overlay->set ($x, $y, $text[, $rend])
1400		1627
1401	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1628	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1402	text in rxvt-unicode's special encoding and an array of rendition values	1629	text in rxvt-unicode's special encoding and an array of rendition values
1403	at a specific position inside the overlay.	1630	at a specific position inside the overlay.
		1631
		1632	If C<$rend> is missing, then the rendition will not be changed.
1404		1633
1405	=item $overlay->hide	1634	=item $overlay->hide
1406		1635
1407	If visible, hide the overlay, but do not destroy it.	1636	If visible, hide the overlay, but do not destroy it.
1408		1637
…		…
1490	locale-specific encoding of the terminal and can contain command sequences	1719	locale-specific encoding of the terminal and can contain command sequences
1491	(escape codes) that will be interpreted.	1720	(escape codes) that will be interpreted.
1492		1721
1493	=item $term->tt_write ($octets)	1722	=item $term->tt_write ($octets)
1494		1723
1495	Write the octets given in C<$data> to the tty (i.e. as program input). To	1724	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1496	pass characters instead of octets, you should convert your strings first	1725	pass characters instead of octets, you should convert your strings first
1497	to the locale-specific encoding using C<< $term->locale_encode >>.	1726	to the locale-specific encoding using C<< $term->locale_encode >>.
		1727
		1728	=item $term->tt_paste ($octets)
		1729
		1730	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1731	CR and bracketing the data with control sequences if bracketed paste mode
		1732	is set.
1498		1733
1499	=item $old_events = $term->pty_ev_events ([$new_events])	1734	=item $old_events = $term->pty_ev_events ([$new_events])
1500		1735
1501	Replaces the event mask of the pty watcher by the given event mask. Can	1736	Replaces the event mask of the pty watcher by the given event mask. Can
1502	be used to suppress input and output handling to the pty/tty. See the	1737	be used to suppress input and output handling to the pty/tty. See the
…		…
1521	Adds the specified events to the vt event mask. Useful e.g. when you want	1756	Adds the specified events to the vt event mask. Useful e.g. when you want
1522	to receive pointer events all the times:	1757	to receive pointer events all the times:
1523		1758
1524	$term->vt_emask_add (urxvt::PointerMotionMask);	1759	$term->vt_emask_add (urxvt::PointerMotionMask);
1525		1760
		1761	=item $term->set_urgency ($set)
		1762
		1763	Enable/disable the urgency hint on the toplevel window.
		1764
1526	=item $term->focus_in	1765	=item $term->focus_in
1527		1766
1528	=item $term->focus_out	1767	=item $term->focus_out
1529		1768
1530	=item $term->key_press ($state, $keycode[, $time])	1769	=item $term->key_press ($state, $keycode[, $time])
…		…
1618		1857
1619	Used after changing terminal contents to display them.	1858	Used after changing terminal contents to display them.
1620		1859
1621	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1860	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1622		1861
1623	Returns the text of the entire row with number C<$row_number>. Row C<0>	1862	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1624	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1863	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1625	terminal line. The scrollback buffer starts at line C<-1> and extends to
1626	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1864	terminal line. Nothing will be returned if a nonexistent line
1627	is requested.	1865	is requested.
1628		1866
1629	If C<$new_text> is specified, it will replace characters in the current	1867	If C<$new_text> is specified, it will replace characters in the current
1630	line, starting at column C<$start_col> (default C<0>), which is useful	1868	line, starting at column C<$start_col> (default C<0>), which is useful
1631	to replace only parts of a line. The font index in the rendition will	1869	to replace only parts of a line. The font index in the rendition will
1632	automatically be updated.	1870	automatically be updated.
1633		1871
1634	C<$text> is in a special encoding: tabs and wide characters that use more	1872	C<$text> is in a special encoding: tabs and wide characters that use more
1635	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1873	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1636	characters. Characters with combining characters and other characters that	1874	characters. Characters with combining characters and other characters that
1637	do not fit into the normal tetx encoding will be replaced with characters	1875	do not fit into the normal text encoding will be replaced with characters
1638	in the private use area.	1876	in the private use area.
1639		1877
1640	You have to obey this encoding when changing text. The advantage is	1878	You have to obey this encoding when changing text. The advantage is
1641	that C<substr> and similar functions work on screen cells and not on	1879	that C<substr> and similar functions work on screen cells and not on
1642	characters.	1880	characters.
…		…
1817	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2055	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1818	recent grab.	2056	recent grab.
1819		2057
1820	=item $term->ungrab	2058	=item $term->ungrab
1821		2059
1822	Calls XUngrab for the most recent grab. Is called automatically on	2060	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1823	evaluation errors, as it is better to lose the grab in the error case as	2061	evaluation errors, as it is better to lose the grab in the error case as
1824	the session.	2062	the session.
1825		2063
1826	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2064	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1827		2065
…		…
1829		2067
1830	=item @atoms = $term->XListProperties ($window)	2068	=item @atoms = $term->XListProperties ($window)
1831		2069
1832	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2070	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1833		2071
1834	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2072	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1835		2073
1836	=item $term->XDeleteProperty ($window, $property)	2074	=item $term->XDeleteProperty ($window, $property)
1837		2075
1838	=item $window = $term->DefaultRootWindow	2076	=item $window = $term->DefaultRootWindow
1839		2077
…		…
1846	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2084	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1847		2085
1848	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2086	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1849		2087
1850	=item $term->XChangeInput ($window, $add_events[, $del_events])	2088	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2089
		2090	=item $keysym = $term->XStringToKeysym ($string)
		2091
		2092	=item $string = $term->XKeysymToString ($keysym)
1851		2093
1852	Various X or X-related functions. The C<$term> object only serves as	2094	Various X or X-related functions. The C<$term> object only serves as
1853	the source of the display, otherwise those functions map more-or-less	2095	the source of the display, otherwise those functions map more-or-less
1854	directory onto the X functions of the same name.	2096	directly onto the X functions of the same name.
1855		2097
1856	=back	2098	=back
1857		2099
1858	=cut	2100	=cut
1859		2101
…		…
1961	my $env = $self->{term}->env;	2203	my $env = $self->{term}->env;
1962	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2204	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1963	delete $env->{LC_ALL};	2205	delete $env->{LC_ALL};
1964	$env->{LC_CTYPE} = $self->{term}->locale;	2206	$env->{LC_CTYPE} = $self->{term}->locale;
1965		2207
1966	urxvt::term->new ($env, "popup",	2208	my $term = urxvt::term->new (
		2209	$env, "popup",
1967	"--perl-lib" => "", "--perl-ext-common" => "",	2210	"--perl-lib" => "", "--perl-ext-common" => "",
1968	"-pty-fd" => -1, "-sl" => 0,	2211	"-pty-fd" => -1, "-sl" => 0,
1969	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2212	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1970	"--transient-for" => $self->{term}->parent,	2213	"--transient-for" => $self->{term}->parent,
1971	"-display" => $self->{term}->display_id,	2214	"-display" => $self->{term}->display_id,
1972	"-pe" => "urxvt-popup")	2215	"-pe" => "urxvt-popup",
1973	or die "unable to create popup window\n";	2216	) or die "unable to create popup window\n";
		2217
		2218	unless (delete $term->{urxvt_popup_init_done}) {
		2219	$term->ungrab;
		2220	$term->destroy;
		2221	die "unable to initialise popup window\n";
		2222	}
1974	}	2223	}
1975		2224
1976	sub DESTROY {	2225	sub DESTROY {
1977	my ($self) = @_;	2226	my ($self) = @_;
1978		2227
…		…
1996	->new	2245	->new
1997	->interval (1)	2246	->interval (1)
1998	->cb (sub {	2247	->cb (sub {
1999	$term->{overlay}->set (0, 0,	2248	$term->{overlay}->set (0, 0,
2000	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2249	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2001	});	2250	});
2002		2251
2003	=over 4	2252	=over 4
2004		2253
2005	=item $timer = new urxvt::timer	2254	=item $timer = new urxvt::timer
2006		2255
…		…
2009		2258
2010	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2259	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2011		2260
2012	Set the callback to be called when the timer triggers.	2261	Set the callback to be called when the timer triggers.
2013		2262
2014	=item $tstamp = $timer->at
2015
2016	Return the time this watcher will fire next.
2017
2018	=item $timer = $timer->set ($tstamp)	2263	=item $timer = $timer->set ($tstamp[, $interval])
2019		2264
2020	Set the time the event is generated to $tstamp.	2265	Set the time the event is generated to $tstamp (and optionally specifies a
		2266	new $interval).
2021		2267
2022	=item $timer = $timer->interval ($interval)	2268	=item $timer = $timer->interval ($interval)
2023		2269
2024	Normally (and when C<$interval> is C<0>), the timer will automatically	2270	By default (and when C<$interval> is C<0>), the timer will automatically
2025	stop after it has fired once. If C<$interval> is non-zero, then the timer	2271	stop after it has fired once. If C<$interval> is non-zero, then the timer
2026	is automatically rescheduled at the given intervals.	2272	is automatically rescheduled at the given intervals.
2027		2273
2028	=item $timer = $timer->start	2274	=item $timer = $timer->start
2029		2275
2030	Start the timer.	2276	Start the timer.
2031		2277
2032	=item $timer = $timer->start ($tstamp)	2278	=item $timer = $timer->start ($tstamp[, $interval])
2033		2279
2034	Set the event trigger time to C<$tstamp> and start the timer.	2280	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2281	also replaces the interval.
2035		2282
2036	=item $timer = $timer->after ($delay)	2283	=item $timer = $timer->after ($delay[, $interval])
2037		2284
2038	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2285	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2039		2286
2040	=item $timer = $timer->stop	2287	=item $timer = $timer->stop
2041		2288
…		…
2049		2296
2050	$term->{socket} = ...	2297	$term->{socket} = ...
2051	$term->{iow} = urxvt::iow	2298	$term->{iow} = urxvt::iow
2052	->new	2299	->new
2053	->fd (fileno $term->{socket})	2300	->fd (fileno $term->{socket})
2054	->events (urxvt::EVENT_READ)	2301	->events (urxvt::EV_READ)
2055	->start	2302	->start
2056	->cb (sub {	2303	->cb (sub {
2057	my ($iow, $revents) = @_;	2304	my ($iow, $revents) = @_;
2058	# $revents must be 1 here, no need to check	2305	# $revents must be 1 here, no need to check
2059	sysread $term->{socket}, my $buf, 8192	2306	sysread $term->{socket}, my $buf, 8192
…		…
2077	Set the file descriptor (not handle) to watch.	2324	Set the file descriptor (not handle) to watch.
2078		2325
2079	=item $iow = $iow->events ($eventmask)	2326	=item $iow = $iow->events ($eventmask)
2080		2327
2081	Set the event mask to watch. The only allowed values are	2328	Set the event mask to watch. The only allowed values are
2082	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2329	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2083	together, or C<urxvt::EVENT_NONE>.	2330	together, or C<urxvt::EV_NONE>.
2084		2331
2085	=item $iow = $iow->start	2332	=item $iow = $iow->start
2086		2333
2087	Start watching for requested events on the given handle.	2334	Start watching for requested events on the given handle.
2088		2335
…		…
2129	->new	2376	->new
2130	->start ($pid)	2377	->start ($pid)
2131	->cb (sub {	2378	->cb (sub {
2132	my ($pw, $exit_status) = @_;	2379	my ($pw, $exit_status) = @_;
2133	...	2380	...
2134	});	2381	});
2135		2382
2136	=over 4	2383	=over 4
2137		2384
2138	=item $pw = new urxvt::pw	2385	=item $pw = new urxvt::pw
2139		2386
…		…
2172		2419
2173	=back	2420	=back
2174		2421
2175	=head1 AUTHOR	2422	=head1 AUTHOR
2176		2423
2177	Marc Lehmann <pcg@goof.com>	2424	Marc Lehmann <schmorp@schmorp.de>
2178	http://software.schmorp.de/pkg/rxvt-unicode	2425	http://software.schmorp.de/pkg/rxvt-unicode
2179		2426
2180	=cut	2427	=cut
2181		2428
2182	1	2429	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.153 by root, Sat Jun 2 05:23:11 2007 UTC vs. Revision 1.216 by root, Sun Jun 10 13:32:55 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.153 by root, Sat Jun 2 05:23:11 2007 UTC vs.
Revision 1.216 by root, Sun Jun 10 13:32:55 2012 UTC