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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.149 by root, Sun Dec 3 23:03:52 2006 UTC vs.
Revision 1.215 by root, Thu Jun 7 16:30:58 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
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
265	URxvt.matcher.button: 1	274	URxvt.matcher.button: 1
266	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]	275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
267	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)	276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
268	URxvt.matcher.launcher.2: gvim +$2 $1	277	URxvt.matcher.launcher.2: gvim +$2 $1
269		278
270	=item xim-onthespot	279	=item xim-onthespot
271		280
272	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
273	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
274	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
275	kinput2.	284	kinput2.
276		285
277	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
278	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
279		288
…		…
287	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
288	or show it again.	297	or show it again.
289		298
290	Initially, the window will not be shown when using this extension.	299	Initially, the window will not be shown when using this extension.
291		300
292	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
293	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.
294		303
295	The accelerator key is grabbed regardless of any modifiers, so this	304	The accelerator key is grabbed regardless of any modifiers, so this
296	extension will actually grab a physical key just for this function.	305	extension will actually grab a physical key just for this function.
297		306
298	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
299	(fvwm can do it).	308	(fvwm can do it).
300		309
301	=item automove-background	310	=item overlay-osc
302		311
303	This is basically a very small extension that dynamically changes the	312	This extension implements some OSC commands to display timed popups on the
304	background pixmap offset to the window position, in effect creating the	313	screen - useful for status displays from within scripts. You have to read
305	same effect as pseudo transparency with a custom pixmap. No scaling is	314	the sources for more info.
306	supported in this mode. Example:
307
308	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
309		315
310	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
311		317
312	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
313	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
…		…
318	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
319		325
320	=item remote-clipboard	326	=item remote-clipboard
321		327
322	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
323	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
324	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
325		331
326	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
327	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
328	reads it.	334	reads it.
…		…
337	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
338	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
339		345
340	=item selection-pastebin	346	=item selection-pastebin
341		347
342	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
343	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
344	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
345	F</tmp> directly.).	351	F</tmp> directly.).
346		352
347	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
366		372
367	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
368		374
369	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
370	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,
371	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
372	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.
373		393
374	=item example-refresh-hooks	394	=item example-refresh-hooks
375		395
376	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
377	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
378	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"
379		412
380	=back	413	=back
381		414
382	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
383		416
…		…
399		432
400	=over 4	433	=over 4
401		434
402	=item $text	435	=item $text
403		436
404	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
405	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.
406		439
407	=item $string	440	=item $string
408		441
409	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
…		…
413	=item $octets	446	=item $octets
414		447
415	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
416	locale-specific way.	449	locale-specific way.
417		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
418	=back	457	=back
419		458
420	=head2 Extension Objects	459	=head2 Extension Objects
421		460
422	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
423	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,
424	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
425	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
426	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
427	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
428	internal use.	467	internal use.
…		…
543		582
544	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,
545	$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
546	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
547		586
548	=item on_osc_seq $term, $op, $args	587	=item on_osc_seq $term, $op, $args, $resp
549		588
550	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
551	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
552	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
553	confused by recursive invocations when you output an osc sequence within	592	confused by recursive invocations when you output an OSC sequence within
554	this callback.	593	this callback.
555		594
556	C<on_osc_seq_perl> should be used for new behaviour.	595	C<on_osc_seq_perl> should be used for new behaviour.
557		596
558	=item on_osc_seq_perl $term, $string	597	=item on_osc_seq_perl $term, $args, $resp
559		598
560	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
561	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
562	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
563	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,
564	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
565	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	}
566		615
567	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,
568	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
569	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.
570		622
571	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
572		624
573	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
574	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
…		…
579	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
580		632
581	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
582	suppress or filter tty input.	634	suppress or filter tty input.
583		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
584	=item on_line_update $term, $row	643	=item on_line_update $term, $row
585		644
586	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
587	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
588	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,
…		…
595	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
596	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
597		656
598	=item on_refresh_begin $term	657	=item on_refresh_begin $term
599		658
600	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
601	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
602	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
603	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
604		663
605	=item on_refresh_end $term	664	=item on_refresh_end $term
606		665
…		…
613	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
614		673
615	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
616	slightly in the future.	675	slightly in the future.
617		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
618	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
619		685
620	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
621	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
622	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
623		689
…		…
657		723
658	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
659		725
660	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
661		727
662	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
663	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.
664		730
665	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
666	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
667	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
668		734
…		…
678	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
679		745
680	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
681	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
682		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
		752
683	=back	753	=back
684		754
685	=cut	755	=cut
686		756
687	package urxvt;	757	package urxvt;
688		758
689	use utf8;	759	use utf8;
690	use strict;	760	use strict 'vars';
691	use Carp ();	761	use Carp ();
692	use Scalar::Util ();	762	use Scalar::Util ();
693	use List::Util ();	763	use List::Util ();
694		764
695	our $VERSION = 1;	765	our $VERSION = 1;
696	our $TERM;	766	our $TERM;
697	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
698	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
699	our @HOOKNAME;	769	our @HOOKNAME;
700	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
701	our %OPTION;	771	our %OPTION;
702		772
703	our $LIBDIR;	773	our $LIBDIR;
…		…
751		821
752	=over 4	822	=over 4
753		823
754	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
755		825
756	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
757	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
758	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
759		830
760	=item urxvt::warn $string	831	=item urxvt::warn $string
761		832
762	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
763	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
764	that calls this function.	835	that calls this function.
765		836
766	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
767	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
771	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
772		843
773	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
774	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
775	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
776	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
777		848
778	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
779		850
780	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
781		852
…		…
824		895
825	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
826		897
827	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
828		899
829	=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
830		902
831	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
832	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
833	the bitset.	905	the bitset.
834		906
…		…
871	};	943	};
872	}	944	}
873		945
874	no warnings 'utf8';	946	no warnings 'utf8';
875		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	my $r = $term->{meta}{resource};
		954	while (my ($pattern, $v) = each %$r) {
		955	$name =~ y/-/./ if $isarg;
		956
		957	if (
		958	$pattern =~ /\.$/
		959	? $pattern eq substr $name, 0, length $pattern
		960	: $pattern eq $name
		961	) {
		962	$name = "$urxvt::RESCLASS.$name";
		963
		964	push @{ $term->{perl_ext_3} }, $v->[0];
		965
		966	if ($v->[1] eq "boolean") {
		967	$term->put_option_db ($name, $flag ? "true" : "false");
		968	return 1;
		969	} else {
		970	$term->put_option_db ($name, $value);
		971	return 1 + 2;
		972	}
		973	}
		974	}
		975
		976	0
		977	}
		978
		979	sub usage {
		980	my ($term, $usage_type) = @_;
		981
		982	$term->scan_meta;
		983
		984	my $r = $term->{meta}{resource};
		985
		986	for my $pattern (sort keys %$r) {
		987	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		988
		989	$desc .= " (-pe $ext)";
		990
		991	if ($usage_type == 1) {
		992	$pattern =~ y/./-/;
		993	$pattern =~ s/-$/-.../g;
		994
		995	if ($type eq "boolean") {
		996	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		997	} else {
		998	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		999	}
		1000	} else {
		1001	$pattern =~ s/\.$/.*/g;
		1002	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1003	}
		1004	}
		1005	}
		1006
876	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1007	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
877		1008
878	sub verbose {	1009	sub verbose {
879	my ($level, $msg) = @_;	1010	my ($level, $msg) = @_;
880	warn "$msg\n" if $level <= $verbosity;	1011	warn "$msg\n" if $level <= $verbosity;
…		…
896		1027
897	open my $fh, "<:raw", $path	1028	open my $fh, "<:raw", $path
898	or die "$path: $!";	1029	or die "$path: $!";
899		1030
900	my $source =	1031	my $source =
901	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	1032	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
902	. "#line 1 \"$path\"\n{\n"	1033	. "#line 1 \"$path\"\n{\n"
903	. (do { local $/; <$fh> })	1034	. (do { local $/; <$fh> })
904	. "\n};\n1";	1035	. "\n};\n1";
905		1036
906	eval $source	1037	eval $source
…		…
916	sub invoke {	1047	sub invoke {
917	local $TERM = shift;	1048	local $TERM = shift;
918	my $htype = shift;	1049	my $htype = shift;
919		1050
920	if ($htype == 0) { # INIT	1051	if ($htype == 0) { # INIT
921	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1052	my @dirs = $TERM->perl_libdirs;
922		1053
923	my %ext_arg;	1054	my %ext_arg;
924		1055
925	{	1056	{
926	my @init = @TERM_INIT;	1057	my @init = @TERM_INIT;
927	@TERM_INIT = ();	1058	@TERM_INIT = ();
…		…
929	my @pkg = @TERM_EXT;	1060	my @pkg = @TERM_EXT;
930	@TERM_EXT = ();	1061	@TERM_EXT = ();
931	$TERM->register_package ($_) for @pkg;	1062	$TERM->register_package ($_) for @pkg;
932	}	1063	}
933		1064
		1065	for (
		1066	@{ delete $TERM->{perl_ext_3} },
934	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1067	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1068	) {
935	if ($_ eq "default") {	1069	if ($_ eq "default") {
936	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	1070	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
937	} elsif (/^-(.*)$/) {	1071	} elsif (/^-(.*)$/) {
938	delete $ext_arg{$1};	1072	delete $ext_arg{$1};
939	} elsif (/^([^<]+)<(.*)>$/) {	1073	} elsif (/^([^<]+)<(.*)>$/) {
…		…
990		1124
991	sub SET_COLOR($$$) {	1125	sub SET_COLOR($$$) {
992	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1126	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
993	}	1127	}
994		1128
		1129	sub rend2mask {
		1130	no strict 'refs';
		1131	my ($str, $mask) = (@_, 0);
		1132	my %color = ( fg => undef, bg => undef );
		1133	my @failed;
		1134	for my $spec ( split /\s+/, $str ) {
		1135	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1136	$color{lc($1)} = $2;
		1137	} else {
		1138	my $neg = $spec =~ s/^[-^]//;
		1139	unless ( exists &{"RS_$spec"} ) {
		1140	push @failed, $spec;
		1141	next;
		1142	}
		1143	my $cur = &{"RS_$spec"};
		1144	if ( $neg ) {
		1145	$mask &= ~$cur;
		1146	} else {
		1147	$mask \|= $cur;
		1148	}
		1149	}
		1150	}
		1151	($mask, @color{qw(fg bg)}, \@failed)
		1152	}
		1153
995	# urxvt::term::extension	1154	# urxvt::term::extension
996		1155
997	package urxvt::term::extension;	1156	package urxvt::term::extension;
998		1157
999	sub enable {	1158	sub enable {
…		…
1062	=head2 The C<urxvt::anyevent> Class	1221	=head2 The C<urxvt::anyevent> Class
1063		1222
1064	The sole purpose of this class is to deliver an interface to the	1223	The sole purpose of this class is to deliver an interface to the
1065	C<AnyEvent> module - any module using it will work inside urxvt without	1224	C<AnyEvent> module - any module using it will work inside urxvt without
1066	further programming. The only exception is that you cannot wait on	1225	further programming. The only exception is that you cannot wait on
1067	condition variables, but non-blocking condvar use is ok. What this means	1226	condition variables, but non-blocking condvar use is ok.
1068	is that you cannot use blocking APIs, but the non-blocking variant should	1227
1069	work.	1228	In practical terms this means is that you cannot use blocking APIs, but
		1229	the non-blocking variant should work.
1070		1230
1071	=cut	1231	=cut
1072		1232
1073	our $VERSION = 1;	1233	our $VERSION = '5.23';
1074		1234
1075	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1235	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1076	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1236	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1077		1237
1078	sub timer {	1238	sub timer {
…		…
1080		1240
1081	my $cb = $arg{cb};	1241	my $cb = $arg{cb};
1082		1242
1083	urxvt::timer	1243	urxvt::timer
1084	->new	1244	->new
1085	->start (urxvt::NOW + $arg{after})	1245	->after ($arg{after}, $arg{interval})
1086	->cb (sub {	1246	->cb ($arg{interval} ? $cb : sub {
1087	$_[0]->stop; # need to cancel manually	1247	$_[0]->stop; # need to cancel manually
1088	$cb->();	1248	$cb->();
1089	})	1249	})
1090	}	1250	}
1091		1251
1092	sub io {	1252	sub io {
1093	my ($class, %arg) = @_;	1253	my ($class, %arg) = @_;
1094		1254
1095	my $cb = $arg{cb};	1255	my $cb = $arg{cb};
		1256	my $fd = fileno $arg{fh};
		1257	defined $fd or $fd = $arg{fh};
1096		1258
1097	bless [$arg{fh}, urxvt::iow	1259	bless [$arg{fh}, urxvt::iow
1098	->new	1260	->new
1099	->fd (fileno $arg{fh})	1261	->fd ($fd)
1100	->events (($arg{poll} =~ /r/ ? 1 : 0)	1262	->events (($arg{poll} =~ /r/ ? 1 : 0)
1101	\| ($arg{poll} =~ /w/ ? 2 : 0))	1263	\| ($arg{poll} =~ /w/ ? 2 : 0))
1102	->start	1264	->start
1103	->cb (sub {	1265	->cb ($cb)
1104	$cb->(($_[1] & 1 ? 'r' : '')
1105	. ($_[1] & 2 ? 'w' : ''));
1106	})],
1107	urxvt::anyevent::	1266	], urxvt::anyevent::
		1267	}
		1268
		1269	sub idle {
		1270	my ($class, %arg) = @_;
		1271
		1272	my $cb = $arg{cb};
		1273
		1274	urxvt::iw
		1275	->new
		1276	->start
		1277	->cb ($cb)
		1278	}
		1279
		1280	sub child {
		1281	my ($class, %arg) = @_;
		1282
		1283	my $cb = $arg{cb};
		1284
		1285	urxvt::pw
		1286	->new
		1287	->start ($arg{pid})
		1288	->cb (sub {
		1289	$_[0]->stop; # need to cancel manually
		1290	$cb->($_[0]->rpid, $_[0]->rstatus);
		1291	})
1108	}	1292	}
1109		1293
1110	sub DESTROY {	1294	sub DESTROY {
1111	$_[0][1]->stop;	1295	$_[0][1]->stop;
1112	}	1296	}
1113		1297
1114	sub condvar {	1298	# only needed for AnyEvent < 6 compatibility
1115	bless \my $flag, urxvt::anyevent::condvar::	1299	sub one_event {
1116	}
1117
1118	sub urxvt::anyevent::condvar::broadcast {
1119	${$_[0]}++;
1120	}
1121
1122	sub urxvt::anyevent::condvar::wait {
1123	unless (${$_[0]}) {
1124	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1125	}
1126	}
1127
1128	sub urxvt::anyevent::one_event {
1129	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1300	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1130	}	1301	}
1131		1302
1132	package urxvt::term;	1303	package urxvt::term;
1133		1304
…		…
1161	$proxy->enable ($name => $ref);	1332	$proxy->enable ($name => $ref);
1162	}	1333	}
1163	}	1334	}
1164	}	1335	}
1165		1336
		1337	sub perl_libdirs {
		1338	map { split /:/ }
		1339	$_[0]->resource ("perl_lib"),
		1340	$ENV{URXVT_PERL_LIB},
		1341	"$ENV{HOME}/.urxvt/ext",
		1342	"$LIBDIR/perl"
		1343	}
		1344
		1345	sub scan_meta {
		1346	my ($self) = @_;
		1347	my @libdirs = perl_libdirs $self;
		1348
		1349	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1350
		1351	my %meta;
		1352
		1353	$self->{meta_libdirs} = join "\x00", @libdirs;
		1354	$self->{meta} = \%meta;
		1355
		1356	for my $dir (reverse @libdirs) {
		1357	opendir my $fh, $dir
		1358	or next;
		1359	for my $ext (readdir $fh) {
		1360	$ext ne "."
		1361	and $ext ne ".."
		1362	and open my $fh, "<", "$dir/$ext"
		1363	or next;
		1364
		1365	while (<$fh>) {
		1366	if (/^#:META:X_RESOURCE:(.*)/) {
		1367	my ($pattern, $type, $desc) = split /:/, $1;
		1368	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1369	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1370	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1371	} else {
		1372	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1373	}
		1374	} elsif (/^\s*(?:#\|$)/) {
		1375	# skip other comments and empty lines
		1376	} else {
		1377	last; # stop parsing on first non-empty non-comment line
		1378	}
		1379	}
		1380	}
		1381	}
		1382	}
		1383
1166	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1384	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1167		1385
1168	Creates a new terminal, very similar as if you had started it with system	1386	Creates a new terminal, very similar as if you had started it with system
1169	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1387	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1170	hash which defines the environment of the new terminal.	1388	hash which defines the environment of the new terminal.
…		…
1224	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1442	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1225		1443
1226	Here is a likely non-exhaustive list of option names, please see the	1444	Here is a likely non-exhaustive list of option names, please see the
1227	source file F</src/optinc.h> to see the actual list:	1445	source file F</src/optinc.h> to see the actual list:
1228		1446
1229	borderLess console cursorBlink cursorUnderline hold iconic insecure	1447	borderLess buffered console cursorBlink cursorUnderline hold iconic
1230	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1448	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1231	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1449	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1232	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1450	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1233	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1451	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1234	transparent tripleclickwords utmpInhibit visualBell	1452	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1453	urgentOnBell utmpInhibit visualBell
1235		1454
1236	=item $value = $term->resource ($name[, $newval])	1455	=item $value = $term->resource ($name[, $newval])
1237		1456
1238	Returns the current resource value associated with a given name and	1457	Returns the current resource value associated with a given name and
1239	optionally sets a new value. Setting values is most useful in the C<init>	1458	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1252		1471
1253	Here is a likely non-exhaustive list of resource names, not all of which	1472	Here is a likely non-exhaustive list of resource names, not all of which
1254	are supported in every build, please see the source file F</src/rsinc.h>	1473	are supported in every build, please see the source file F</src/rsinc.h>
1255	to see the actual list:	1474	to see the actual list:
1256		1475
1257	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1476	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1258	borderLess color cursorBlink cursorUnderline cutchars delete_key	1477	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1259	display_name embed ext_bwidth fade font geometry hold iconName	1478	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1260	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1479	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1480	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1261	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1481	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1262	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1482	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1263	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1483	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1264	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1484	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1265	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1485	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1266	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1486	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1267	secondaryScreen secondaryScroll selectstyle shade term_name title	1487	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1268	transient_for transparent transparent_all tripleclickwords utmpInhibit	1488	term_name title transient_for transparent tripleclickwords urgentOnBell
1269	visualBell	1489	utmpInhibit visualBell
1270		1490
1271	=cut	1491	=cut
1272		1492
1273	sub resource($$;$) {	1493	sub resource($$;$) {
1274	my ($self, $name) = (shift, shift);	1494	my ($self, $name) = (shift, shift);
1275	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1495	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1276	&urxvt::term::_resource	1496	goto &urxvt::term::_resource
1277	}	1497	}
1278		1498
1279	=item $value = $term->x_resource ($pattern)	1499	=item $value = $term->x_resource ($pattern)
1280		1500
1281	Returns the X-Resource for the given pattern, excluding the program or	1501	Returns the X-Resource for the given pattern, excluding the program or
…		…
1285		1505
1286	This method should only be called during the C<on_start> hook, as there is	1506	This method should only be called during the C<on_start> hook, as there is
1287	only one resource database per display, and later invocations might return	1507	only one resource database per display, and later invocations might return
1288	the wrong resources.	1508	the wrong resources.
1289		1509
1290	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1510	=item $value = $term->x_resource_boolean ($pattern)
1291		1511
		1512	Like C<x_resource>, above, but interprets the string value as a boolean
		1513	and returns C<1> for true values, C<0> for false values and C<undef> if
		1514	the resource or option isn't specified.
		1515
		1516	You should always use this method to parse boolean resources.
		1517
		1518	=cut
		1519
		1520	sub x_resource_boolean {
		1521	my $res = &x_resource;
		1522
		1523	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1524	}
		1525
		1526	=item $success = $term->parse_keysym ($key, $octets)
		1527
1292	Adds a keymap translation exactly as specified via a resource. See the	1528	Adds a key binding exactly as specified via a resource. See the
1293	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1529	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1530
		1531	=item $term->register_command ($keysym, $modifiermask, $string)
		1532
		1533	Adds a key binding. This is a lower level api compared to
		1534	C<parse_keysym>, as it expects a parsed key description, and can be
		1535	used only inside either the C<on_init> hook, to add a binding, or the
		1536	C<on_register_command> hook, to modify a parsed binding.
1294		1537
1295	=item $rend = $term->rstyle ([$new_rstyle])	1538	=item $rend = $term->rstyle ([$new_rstyle])
1296		1539
1297	Return and optionally change the current rendition. Text that is output by	1540	Return and optionally change the current rendition. Text that is output by
1298	the terminal application will use this style.	1541	the terminal application will use this style.
…		…
1306		1549
1307	=item ($row, $col) = $term->selection_beg ([$row, $col])	1550	=item ($row, $col) = $term->selection_beg ([$row, $col])
1308		1551
1309	=item ($row, $col) = $term->selection_end ([$row, $col])	1552	=item ($row, $col) = $term->selection_end ([$row, $col])
1310		1553
1311	Return the current values of the selection mark, begin or end positions,	1554	Return the current values of the selection mark, begin or end positions.
1312	and optionally set them to new values.	1555
		1556	When arguments are given, then the selection coordinates are set to
		1557	C<$row> and C<$col>, and the selection screen is set to the current
		1558	screen.
		1559
		1560	=item $screen = $term->selection_screen ([$screen])
		1561
		1562	Returns the current selection screen, and then optionally sets it.
1313		1563
1314	=item $term->selection_make ($eventtime[, $rectangular])	1564	=item $term->selection_make ($eventtime[, $rectangular])
1315		1565
1316	Tries to make a selection as set by C<selection_beg> and	1566	Tries to make a selection as set by C<selection_beg> and
1317	C<selection_end>. If C<$rectangular> is true (default: false), a	1567	C<selection_end>. If C<$rectangular> is true (default: false), a
1318	rectangular selection will be made. This is the prefered function to make	1568	rectangular selection will be made. This is the preferred function to make
1319	a selection.	1569	a selection.
1320		1570
1321	=item $success = $term->selection_grab ($eventtime)	1571	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1322		1572
1323	Try to request the primary selection text from the server (for example, as	1573	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1574	true) selection from the server. The corresponding text can be set
1324	set by the next method). No visual feedback will be given. This function	1575	with the next method. No visual feedback will be given. This function
1325	is mostly useful from within C<on_sel_grab> hooks.	1576	is mostly useful from within C<on_sel_grab> hooks.
1326		1577
1327	=item $oldtext = $term->selection ([$newtext])	1578	=item $oldtext = $term->selection ([$newtext, $clipboard])
1328		1579
1329	Return the current selection text and optionally replace it by C<$newtext>.	1580	Return the current selection (clipboard if C<$clipboard> is true) text
		1581	and optionally replace it by C<$newtext>.
		1582
		1583	=item $term->selection_clear ([$clipboard])
		1584
		1585	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1330		1586
1331	=item $term->overlay_simple ($x, $y, $text)	1587	=item $term->overlay_simple ($x, $y, $text)
1332		1588
1333	Create a simple multi-line overlay box. See the next method for details.	1589	Create a simple multi-line overlay box. See the next method for details.
1334		1590
…		…
1364		1620
1365	The methods currently supported on C<urxvt::overlay> objects are:	1621	The methods currently supported on C<urxvt::overlay> objects are:
1366		1622
1367	=over 4	1623	=over 4
1368		1624
1369	=item $overlay->set ($x, $y, $text, $rend)	1625	=item $overlay->set ($x, $y, $text[, $rend])
1370		1626
1371	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1627	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1372	text in rxvt-unicode's special encoding and an array of rendition values	1628	text in rxvt-unicode's special encoding and an array of rendition values
1373	at a specific position inside the overlay.	1629	at a specific position inside the overlay.
		1630
		1631	If C<$rend> is missing, then the rendition will not be changed.
1374		1632
1375	=item $overlay->hide	1633	=item $overlay->hide
1376		1634
1377	If visible, hide the overlay, but do not destroy it.	1635	If visible, hide the overlay, but do not destroy it.
1378		1636
…		…
1460	locale-specific encoding of the terminal and can contain command sequences	1718	locale-specific encoding of the terminal and can contain command sequences
1461	(escape codes) that will be interpreted.	1719	(escape codes) that will be interpreted.
1462		1720
1463	=item $term->tt_write ($octets)	1721	=item $term->tt_write ($octets)
1464		1722
1465	Write the octets given in C<$data> to the tty (i.e. as program input). To	1723	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1466	pass characters instead of octets, you should convert your strings first	1724	pass characters instead of octets, you should convert your strings first
1467	to the locale-specific encoding using C<< $term->locale_encode >>.	1725	to the locale-specific encoding using C<< $term->locale_encode >>.
		1726
		1727	=item $term->tt_paste ($octets)
		1728
		1729	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1730	CR and bracketing the data with control sequences if bracketed paste mode
		1731	is set.
1468		1732
1469	=item $old_events = $term->pty_ev_events ([$new_events])	1733	=item $old_events = $term->pty_ev_events ([$new_events])
1470		1734
1471	Replaces the event mask of the pty watcher by the given event mask. Can	1735	Replaces the event mask of the pty watcher by the given event mask. Can
1472	be used to suppress input and output handling to the pty/tty. See the	1736	be used to suppress input and output handling to the pty/tty. See the
…		…
1491	Adds the specified events to the vt event mask. Useful e.g. when you want	1755	Adds the specified events to the vt event mask. Useful e.g. when you want
1492	to receive pointer events all the times:	1756	to receive pointer events all the times:
1493		1757
1494	$term->vt_emask_add (urxvt::PointerMotionMask);	1758	$term->vt_emask_add (urxvt::PointerMotionMask);
1495		1759
		1760	=item $term->set_urgency ($set)
		1761
		1762	Enable/disable the urgency hint on the toplevel window.
		1763
1496	=item $term->focus_in	1764	=item $term->focus_in
1497		1765
1498	=item $term->focus_out	1766	=item $term->focus_out
1499		1767
1500	=item $term->key_press ($state, $keycode[, $time])	1768	=item $term->key_press ($state, $keycode[, $time])
…		…
1588		1856
1589	Used after changing terminal contents to display them.	1857	Used after changing terminal contents to display them.
1590		1858
1591	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1859	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1592		1860
1593	Returns the text of the entire row with number C<$row_number>. Row C<0>	1861	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1594	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1862	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1595	terminal line. The scrollback buffer starts at line C<-1> and extends to
1596	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1863	terminal line. Nothing will be returned if a nonexistent line
1597	is requested.	1864	is requested.
1598		1865
1599	If C<$new_text> is specified, it will replace characters in the current	1866	If C<$new_text> is specified, it will replace characters in the current
1600	line, starting at column C<$start_col> (default C<0>), which is useful	1867	line, starting at column C<$start_col> (default C<0>), which is useful
1601	to replace only parts of a line. The font index in the rendition will	1868	to replace only parts of a line. The font index in the rendition will
1602	automatically be updated.	1869	automatically be updated.
1603		1870
1604	C<$text> is in a special encoding: tabs and wide characters that use more	1871	C<$text> is in a special encoding: tabs and wide characters that use more
1605	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1872	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1606	characters. Characters with combining characters and other characters that	1873	characters. Characters with combining characters and other characters that
1607	do not fit into the normal tetx encoding will be replaced with characters	1874	do not fit into the normal text encoding will be replaced with characters
1608	in the private use area.	1875	in the private use area.
1609		1876
1610	You have to obey this encoding when changing text. The advantage is	1877	You have to obey this encoding when changing text. The advantage is
1611	that C<substr> and similar functions work on screen cells and not on	1878	that C<substr> and similar functions work on screen cells and not on
1612	characters.	1879	characters.
…		…
1787	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2054	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1788	recent grab.	2055	recent grab.
1789		2056
1790	=item $term->ungrab	2057	=item $term->ungrab
1791		2058
1792	Calls XUngrab for the most recent grab. Is called automatically on	2059	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1793	evaluation errors, as it is better to lose the grab in the error case as	2060	evaluation errors, as it is better to lose the grab in the error case as
1794	the session.	2061	the session.
1795		2062
1796	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2063	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1797		2064
…		…
1799		2066
1800	=item @atoms = $term->XListProperties ($window)	2067	=item @atoms = $term->XListProperties ($window)
1801		2068
1802	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2069	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1803		2070
1804	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2071	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1805		2072
1806	=item $term->XDeleteProperty ($window, $property)	2073	=item $term->XDeleteProperty ($window, $property)
1807		2074
1808	=item $window = $term->DefaultRootWindow	2075	=item $window = $term->DefaultRootWindow
1809		2076
…		…
1816	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2083	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1817		2084
1818	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2085	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1819		2086
1820	=item $term->XChangeInput ($window, $add_events[, $del_events])	2087	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2088
		2089	=item $keysym = $term->XStringToKeysym ($string)
		2090
		2091	=item $string = $term->XKeysymToString ($keysym)
1821		2092
1822	Various X or X-related functions. The C<$term> object only serves as	2093	Various X or X-related functions. The C<$term> object only serves as
1823	the source of the display, otherwise those functions map more-or-less	2094	the source of the display, otherwise those functions map more-or-less
1824	directory onto the X functions of the same name.	2095	directly onto the X functions of the same name.
1825		2096
1826	=back	2097	=back
1827		2098
1828	=cut	2099	=cut
1829		2100
…		…
1931	my $env = $self->{term}->env;	2202	my $env = $self->{term}->env;
1932	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2203	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1933	delete $env->{LC_ALL};	2204	delete $env->{LC_ALL};
1934	$env->{LC_CTYPE} = $self->{term}->locale;	2205	$env->{LC_CTYPE} = $self->{term}->locale;
1935		2206
1936	urxvt::term->new ($env, "popup",	2207	my $term = urxvt::term->new (
		2208	$env, "popup",
1937	"--perl-lib" => "", "--perl-ext-common" => "",	2209	"--perl-lib" => "", "--perl-ext-common" => "",
1938	"-pty-fd" => -1, "-sl" => 0,	2210	"-pty-fd" => -1, "-sl" => 0,
1939	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2211	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1940	"--transient-for" => $self->{term}->parent,	2212	"--transient-for" => $self->{term}->parent,
1941	"-display" => $self->{term}->display_id,	2213	"-display" => $self->{term}->display_id,
1942	"-pe" => "urxvt-popup")	2214	"-pe" => "urxvt-popup",
1943	or die "unable to create popup window\n";	2215	) or die "unable to create popup window\n";
		2216
		2217	unless (delete $term->{urxvt_popup_init_done}) {
		2218	$term->ungrab;
		2219	$term->destroy;
		2220	die "unable to initialise popup window\n";
		2221	}
1944	}	2222	}
1945		2223
1946	sub DESTROY {	2224	sub DESTROY {
1947	my ($self) = @_;	2225	my ($self) = @_;
1948		2226
…		…
1953	=back	2231	=back
1954		2232
1955	=cut	2233	=cut
1956		2234
1957	package urxvt::watcher;	2235	package urxvt::watcher;
1958
1959	@urxvt::timer::ISA = __PACKAGE__;
1960	@urxvt::iow::ISA = __PACKAGE__;
1961	@urxvt::pw::ISA = __PACKAGE__;
1962	@urxvt::iw::ISA = __PACKAGE__;
1963		2236
1964	=head2 The C<urxvt::timer> Class	2237	=head2 The C<urxvt::timer> Class
1965		2238
1966	This class implements timer watchers/events. Time is represented as a	2239	This class implements timer watchers/events. Time is represented as a
1967	fractional number of seconds since the epoch. Example:	2240	fractional number of seconds since the epoch. Example:
…		…
1971	->new	2244	->new
1972	->interval (1)	2245	->interval (1)
1973	->cb (sub {	2246	->cb (sub {
1974	$term->{overlay}->set (0, 0,	2247	$term->{overlay}->set (0, 0,
1975	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2248	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1976	});	2249	});
1977		2250
1978	=over 4	2251	=over 4
1979		2252
1980	=item $timer = new urxvt::timer	2253	=item $timer = new urxvt::timer
1981		2254
…		…
1984		2257
1985	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2258	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1986		2259
1987	Set the callback to be called when the timer triggers.	2260	Set the callback to be called when the timer triggers.
1988		2261
1989	=item $tstamp = $timer->at
1990
1991	Return the time this watcher will fire next.
1992
1993	=item $timer = $timer->set ($tstamp)	2262	=item $timer = $timer->set ($tstamp[, $interval])
1994		2263
1995	Set the time the event is generated to $tstamp.	2264	Set the time the event is generated to $tstamp (and optionally specifies a
		2265	new $interval).
1996		2266
1997	=item $timer = $timer->interval ($interval)	2267	=item $timer = $timer->interval ($interval)
1998		2268
1999	Normally (and when C<$interval> is C<0>), the timer will automatically	2269	By default (and when C<$interval> is C<0>), the timer will automatically
2000	stop after it has fired once. If C<$interval> is non-zero, then the timer	2270	stop after it has fired once. If C<$interval> is non-zero, then the timer
2001	is automatically rescheduled at the given intervals.	2271	is automatically rescheduled at the given intervals.
2002		2272
2003	=item $timer = $timer->start	2273	=item $timer = $timer->start
2004		2274
2005	Start the timer.	2275	Start the timer.
2006		2276
2007	=item $timer = $timer->start ($tstamp)	2277	=item $timer = $timer->start ($tstamp[, $interval])
2008		2278
2009	Set the event trigger time to C<$tstamp> and start the timer.	2279	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2280	also replaces the interval.
2010		2281
2011	=item $timer = $timer->after ($delay)	2282	=item $timer = $timer->after ($delay[, $interval])
2012		2283
2013	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2284	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2014		2285
2015	=item $timer = $timer->stop	2286	=item $timer = $timer->stop
2016		2287
…		…
2024		2295
2025	$term->{socket} = ...	2296	$term->{socket} = ...
2026	$term->{iow} = urxvt::iow	2297	$term->{iow} = urxvt::iow
2027	->new	2298	->new
2028	->fd (fileno $term->{socket})	2299	->fd (fileno $term->{socket})
2029	->events (urxvt::EVENT_READ)	2300	->events (urxvt::EV_READ)
2030	->start	2301	->start
2031	->cb (sub {	2302	->cb (sub {
2032	my ($iow, $revents) = @_;	2303	my ($iow, $revents) = @_;
2033	# $revents must be 1 here, no need to check	2304	# $revents must be 1 here, no need to check
2034	sysread $term->{socket}, my $buf, 8192	2305	sysread $term->{socket}, my $buf, 8192
…		…
2052	Set the file descriptor (not handle) to watch.	2323	Set the file descriptor (not handle) to watch.
2053		2324
2054	=item $iow = $iow->events ($eventmask)	2325	=item $iow = $iow->events ($eventmask)
2055		2326
2056	Set the event mask to watch. The only allowed values are	2327	Set the event mask to watch. The only allowed values are
2057	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2328	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2058	together, or C<urxvt::EVENT_NONE>.	2329	together, or C<urxvt::EV_NONE>.
2059		2330
2060	=item $iow = $iow->start	2331	=item $iow = $iow->start
2061		2332
2062	Start watching for requested events on the given handle.	2333	Start watching for requested events on the given handle.
2063		2334
…		…
2104	->new	2375	->new
2105	->start ($pid)	2376	->start ($pid)
2106	->cb (sub {	2377	->cb (sub {
2107	my ($pw, $exit_status) = @_;	2378	my ($pw, $exit_status) = @_;
2108	...	2379	...
2109	});	2380	});
2110		2381
2111	=over 4	2382	=over 4
2112		2383
2113	=item $pw = new urxvt::pw	2384	=item $pw = new urxvt::pw
2114		2385
…		…
2147		2418
2148	=back	2419	=back
2149		2420
2150	=head1 AUTHOR	2421	=head1 AUTHOR
2151		2422
2152	Marc Lehmann <pcg@goof.com>	2423	Marc Lehmann <schmorp@schmorp.de>
2153	http://software.schmorp.de/pkg/rxvt-unicode	2424	http://software.schmorp.de/pkg/rxvt-unicode
2154		2425
2155	=cut	2426	=cut
2156		2427
2157	1	2428	1
		2429
		2430	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.149 by root, Sun Dec 3 23:03:52 2006 UTC vs. Revision 1.215 by root, Thu Jun 7 16:30:58 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.149 by root, Sun Dec 3 23:03:52 2006 UTC vs.
Revision 1.215 by root, Thu Jun 7 16:30:58 2012 UTC