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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.145 by root, Thu Aug 10 22:53:20 2006 UTC vs.
Revision 1.212 by root, Wed Jun 6 15:06:41 2012 UTC

…		…
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
…		…
240	URxvt.tabbed.tab-bg: <colour-index, default 1>	243	URxvt.tabbed.tab-bg: <colour-index, default 1>
241		244
242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid	245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243	indices.	246	indices.
244		247
245	=item mark-urls	248	=item matcher
246		249
247	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
248	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
249	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
250	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
		266	"perl:matcher:list" as seen in the example below.
		267
		268	Example configuration:
		269
		270	URxvt.perl-ext: default,matcher
		271	URxvt.urlLauncher: sensible-browser
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
		274	URxvt.matcher.button: 1
		275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		277	URxvt.matcher.launcher.2: gvim +$2 $1
251		278
252	=item xim-onthespot	279	=item xim-onthespot
253		280
254	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
255	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
256	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
257	kinput2.	284	kinput2.
258		285
259	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
260	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
261		288
…		…
269	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
270	or show it again.	297	or show it again.
271		298
272	Initially, the window will not be shown when using this extension.	299	Initially, the window will not be shown when using this extension.
273		300
274	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
275	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.
276		303
277	The accelerator key is grabbed regardless of any modifiers, so this	304	The accelerator key is grabbed regardless of any modifiers, so this
278	extension will actually grab a physical key just for this function.	305	extension will actually grab a physical key just for this function.
279		306
280	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
281	(fvwm can do it).	308	(fvwm can do it).
282		309
283	=item automove-background	310	=item overlay-osc
284		311
285	This is basically a very small extension that dynamically changes the	312	This extension implements some OSC commands to display timed popups on the
286	background pixmap offset to the window position, in effect creating the	313	screen - useful for status displays from within scripts. You have to read
287	same effect as pseudo transparency with a custom pixmap. No scaling is	314	the sources for more info.
288	supported in this mode. Example:
289
290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291		315
292	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
293		317
294	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
295	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
…		…
300	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
301		325
302	=item remote-clipboard	326	=item remote-clipboard
303		327
304	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
305	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
306	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
307		331
308	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
309	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
310	reads it.	334	reads it.
…		…
319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321		345
322	=item selection-pastebin	346	=item selection-pastebin
323		347
324	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
325	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
326	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
327	F</tmp> directly.).	351	F</tmp> directly.).
328		352
329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
346	in the C<selection-pastebin-url> resource (again, the % is the placeholder	370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
347	for the filename):	371	for the filename):
348		372
349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350		374
		375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		376	the double C</> characters as comment start. Use C<\057\057> instead,
		377	which works regardless of whether xrdb is used to parse the resource file
		378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
		393
351	=item example-refresh-hooks	394	=item example-refresh-hooks
352		395
353	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
354	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
355	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"
356		412
357	=back	413	=back
358		414
359	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
360		416
…		…
376		432
377	=over 4	433	=over 4
378		434
379	=item $text	435	=item $text
380		436
381	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
382	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.
383		439
384	=item $string	440	=item $string
385		441
386	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
…		…
390	=item $octets	446	=item $octets
391		447
392	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
393	locale-specific way.	449	locale-specific way.
394		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
395	=back	457	=back
396		458
397	=head2 Extension Objects	459	=head2 Extension Objects
398		460
399	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
400	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,
401	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
402	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
403	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
404	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
405	internal use.	467	internal use.
…		…
520		582
521	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,
522	$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
523	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
524		586
525	=item on_osc_seq $term, $op, $args	587	=item on_osc_seq $term, $op, $args, $resp
526		588
527	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
528	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
529	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
530	confused by recursive invocations when you output an osc sequence within	592	confused by recursive invocations when you output an OSC sequence within
531	this callback.	593	this callback.
532		594
533	C<on_osc_seq_perl> should be used for new behaviour.	595	C<on_osc_seq_perl> should be used for new behaviour.
534		596
535	=item on_osc_seq_perl $term, $string	597	=item on_osc_seq_perl $term, $args, $resp
536		598
537	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
538	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
539	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
540	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,
541	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
542	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	}
543		615
544	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,
545	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
546	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.
547		622
548	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
549		624
550	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
551	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
…		…
556	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
557		632
558	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
559	suppress or filter tty input.	634	suppress or filter tty input.
560		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
561	=item on_line_update $term, $row	643	=item on_line_update $term, $row
562		644
563	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
564	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
565	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,
…		…
572	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
573	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
574		656
575	=item on_refresh_begin $term	657	=item on_refresh_begin $term
576		658
577	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
578	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
579	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
580	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
581		663
582	=item on_refresh_end $term	664	=item on_refresh_end $term
583		665
…		…
590	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
591		673
592	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
593	slightly in the future.	675	slightly in the future.
594		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
595	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
596		685
597	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
598	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
599	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
600		689
…		…
634		723
635	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
636		725
637	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
638		727
639	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
640	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.
641		730
642	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
643	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
644	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
645		734
…		…
654		743
655	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
656		745
657	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
658	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
659		752
660	=back	753	=back
661		754
662	=cut	755	=cut
663		756
…		…
669	use Scalar::Util ();	762	use Scalar::Util ();
670	use List::Util ();	763	use List::Util ();
671		764
672	our $VERSION = 1;	765	our $VERSION = 1;
673	our $TERM;	766	our $TERM;
674	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
675	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
676	our @HOOKNAME;	769	our @HOOKNAME;
677	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
678	our %OPTION;	771	our %OPTION;
679		772
680	our $LIBDIR;	773	our $LIBDIR;
…		…
728		821
729	=over 4	822	=over 4
730		823
731	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
732		825
733	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
734	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
735	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
736		830
737	=item urxvt::warn $string	831	=item urxvt::warn $string
738		832
739	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
740	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
741	that calls this function.	835	that calls this function.
742		836
743	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
744	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
748	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
749		843
750	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
751	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
752	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
753	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
754		848
755	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
756		850
757	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
758		852
…		…
801		895
802	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
803		897
804	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
805		899
806	=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
807		902
808	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
809	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
810	the bitset.	905	the bitset.
811		906
…		…
848	};	943	};
849	}	944	}
850		945
851	no warnings 'utf8';	946	no warnings 'utf8';
852		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_EXT, $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	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1002	}
		1003	}
		1004	}
		1005
853	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1006	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
854		1007
855	sub verbose {	1008	sub verbose {
856	my ($level, $msg) = @_;	1009	my ($level, $msg) = @_;
857	warn "$msg\n" if $level <= $verbosity;	1010	warn "$msg\n" if $level <= $verbosity;
…		…
893	sub invoke {	1046	sub invoke {
894	local $TERM = shift;	1047	local $TERM = shift;
895	my $htype = shift;	1048	my $htype = shift;
896		1049
897	if ($htype == 0) { # INIT	1050	if ($htype == 0) { # INIT
898	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1051	my @dirs = $TERM->perl_libdirs;
899		1052
900	my %ext_arg;	1053	my %ext_arg;
901		1054
902	{	1055	{
903	my @init = @TERM_INIT;	1056	my @init = @TERM_INIT;
904	@TERM_INIT = ();	1057	@TERM_INIT = ();
…		…
967		1120
968	sub SET_COLOR($$$) {	1121	sub SET_COLOR($$$) {
969	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1122	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
970	}	1123	}
971		1124
		1125	sub rend2mask {
		1126	no strict 'refs';
		1127	my ($str, $mask) = (@_, 0);
		1128	my %color = ( fg => undef, bg => undef );
		1129	my @failed;
		1130	for my $spec ( split /\s+/, $str ) {
		1131	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1132	$color{lc($1)} = $2;
		1133	} else {
		1134	my $neg = $spec =~ s/^[-^]//;
		1135	unless ( exists &{"RS_$spec"} ) {
		1136	push @failed, $spec;
		1137	next;
		1138	}
		1139	my $cur = &{"RS_$spec"};
		1140	if ( $neg ) {
		1141	$mask &= ~$cur;
		1142	} else {
		1143	$mask \|= $cur;
		1144	}
		1145	}
		1146	}
		1147	($mask, @color{qw(fg bg)}, \@failed)
		1148	}
		1149
972	# urxvt::term::extension	1150	# urxvt::term::extension
973		1151
974	package urxvt::term::extension;	1152	package urxvt::term::extension;
975		1153
976	sub enable {	1154	sub enable {
…		…
1039	=head2 The C<urxvt::anyevent> Class	1217	=head2 The C<urxvt::anyevent> Class
1040		1218
1041	The sole purpose of this class is to deliver an interface to the	1219	The sole purpose of this class is to deliver an interface to the
1042	C<AnyEvent> module - any module using it will work inside urxvt without	1220	C<AnyEvent> module - any module using it will work inside urxvt without
1043	further programming. The only exception is that you cannot wait on	1221	further programming. The only exception is that you cannot wait on
1044	condition variables, but non-blocking condvar use is ok. What this means	1222	condition variables, but non-blocking condvar use is ok.
1045	is that you cannot use blocking APIs, but the non-blocking variant should	1223
1046	work.	1224	In practical terms this means is that you cannot use blocking APIs, but
		1225	the non-blocking variant should work.
1047		1226
1048	=cut	1227	=cut
1049		1228
1050	our $VERSION = 1;	1229	our $VERSION = '5.23';
1051		1230
1052	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1231	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1053	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1232	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1054		1233
1055	sub timer {	1234	sub timer {
…		…
1057		1236
1058	my $cb = $arg{cb};	1237	my $cb = $arg{cb};
1059		1238
1060	urxvt::timer	1239	urxvt::timer
1061	->new	1240	->new
1062	->start (urxvt::NOW + $arg{after})	1241	->after ($arg{after}, $arg{interval})
1063	->cb (sub {	1242	->cb ($arg{interval} ? $cb : sub {
1064	$_[0]->stop; # need to cancel manually	1243	$_[0]->stop; # need to cancel manually
1065	$cb->();	1244	$cb->();
1066	})	1245	})
1067	}	1246	}
1068		1247
1069	sub io {	1248	sub io {
1070	my ($class, %arg) = @_;	1249	my ($class, %arg) = @_;
1071		1250
1072	my $cb = $arg{cb};	1251	my $cb = $arg{cb};
		1252	my $fd = fileno $arg{fh};
		1253	defined $fd or $fd = $arg{fh};
1073		1254
1074	bless [$arg{fh}, urxvt::iow	1255	bless [$arg{fh}, urxvt::iow
1075	->new	1256	->new
1076	->fd (fileno $arg{fh})	1257	->fd ($fd)
1077	->events (($arg{poll} =~ /r/ ? 1 : 0)	1258	->events (($arg{poll} =~ /r/ ? 1 : 0)
1078	\| ($arg{poll} =~ /w/ ? 2 : 0))	1259	\| ($arg{poll} =~ /w/ ? 2 : 0))
1079	->start	1260	->start
1080	->cb (sub {	1261	->cb ($cb)
1081	$cb->(($_[1] & 1 ? 'r' : '')
1082	. ($_[1] & 2 ? 'w' : ''));
1083	})],
1084	urxvt::anyevent::	1262	], urxvt::anyevent::
		1263	}
		1264
		1265	sub idle {
		1266	my ($class, %arg) = @_;
		1267
		1268	my $cb = $arg{cb};
		1269
		1270	urxvt::iw
		1271	->new
		1272	->start
		1273	->cb ($cb)
		1274	}
		1275
		1276	sub child {
		1277	my ($class, %arg) = @_;
		1278
		1279	my $cb = $arg{cb};
		1280
		1281	urxvt::pw
		1282	->new
		1283	->start ($arg{pid})
		1284	->cb (sub {
		1285	$_[0]->stop; # need to cancel manually
		1286	$cb->($_[0]->rpid, $_[0]->rstatus);
		1287	})
1085	}	1288	}
1086		1289
1087	sub DESTROY {	1290	sub DESTROY {
1088	$_[0][1]->stop;	1291	$_[0][1]->stop;
1089	}	1292	}
1090		1293
1091	sub condvar {	1294	# only needed for AnyEvent < 6 compatibility
1092	bless \my $flag, urxvt::anyevent::condvar::	1295	sub one_event {
1093	}
1094
1095	sub urxvt::anyevent::condvar::broadcast {
1096	${$_[0]}++;
1097	}
1098
1099	sub urxvt::anyevent::condvar::wait {
1100	unless (${$_[0]}) {
1101	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1296	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1102	}
1103	}	1297	}
1104		1298
1105	package urxvt::term;	1299	package urxvt::term;
1106		1300
1107	=head2 The C<urxvt::term> Class	1301	=head2 The C<urxvt::term> Class
…		…
1134	$proxy->enable ($name => $ref);	1328	$proxy->enable ($name => $ref);
1135	}	1329	}
1136	}	1330	}
1137	}	1331	}
1138		1332
		1333	sub perl_libdirs {
		1334	map { split /:/ }
		1335	$_[0]->resource ("perl_lib"),
		1336	$ENV{URXVT_PERL_LIB},
		1337	"$ENV{HOME}/.urxvt/ext",
		1338	"$LIBDIR/perl"
		1339	}
		1340
		1341	sub scan_meta {
		1342	my ($self) = @_;
		1343	my @libdirs = perl_libdirs $self;
		1344
		1345	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1346
		1347	my %meta;
		1348
		1349	$self->{meta_libdirs} = join "\x00", @libdirs;
		1350	$self->{meta} = \%meta;
		1351
		1352	for my $dir (reverse @libdirs) {
		1353	opendir my $fh, $dir
		1354	or next;
		1355	for my $ext (readdir $fh) {
		1356	$ext ne "."
		1357	and $ext ne ".."
		1358	and open my $fh, "<", "$dir/$ext"
		1359	or next;
		1360
		1361	while (<$fh>) {
		1362	if (/^#:META:X_RESOURCE:(.*)/) {
		1363	my ($pattern, $type, $desc) = split /:/, $1;
		1364	$pattern =~ s/^%(?:\.\|$)/$ext./g; # % in pattern == extension name
		1365	if ($pattern =~ /[^a-zA-Z\.]/) {
		1366	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1367	} else {
		1368	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1369	}
		1370	} elsif (/^\s*(?:#\|$)/) {
		1371	# skip other comments and empty lines
		1372	} else {
		1373	last; # stop parsing on first non-empty non-comment line
		1374	}
		1375	}
		1376	}
		1377	}
		1378	}
		1379
1139	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1380	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1140		1381
1141	Creates a new terminal, very similar as if you had started it with system	1382	Creates a new terminal, very similar as if you had started it with system
1142	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1383	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1143	hash which defines the environment of the new terminal.	1384	hash which defines the environment of the new terminal.
…		…
1197	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1438	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1198		1439
1199	Here is a likely non-exhaustive list of option names, please see the	1440	Here is a likely non-exhaustive list of option names, please see the
1200	source file F</src/optinc.h> to see the actual list:	1441	source file F</src/optinc.h> to see the actual list:
1201		1442
1202	borderLess console cursorBlink cursorUnderline hold iconic insecure	1443	borderLess buffered console cursorBlink cursorUnderline hold iconic
1203	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1444	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1204	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1445	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1205	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1446	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1206	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1447	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1207	transparent tripleclickwords utmpInhibit visualBell	1448	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1449	urgentOnBell utmpInhibit visualBell
1208		1450
1209	=item $value = $term->resource ($name[, $newval])	1451	=item $value = $term->resource ($name[, $newval])
1210		1452
1211	Returns the current resource value associated with a given name and	1453	Returns the current resource value associated with a given name and
1212	optionally sets a new value. Setting values is most useful in the C<init>	1454	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1225		1467
1226	Here is a likely non-exhaustive list of resource names, not all of which	1468	Here is a likely non-exhaustive list of resource names, not all of which
1227	are supported in every build, please see the source file F</src/rsinc.h>	1469	are supported in every build, please see the source file F</src/rsinc.h>
1228	to see the actual list:	1470	to see the actual list:
1229		1471
1230	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1472	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1231	borderLess color cursorBlink cursorUnderline cutchars delete_key	1473	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1232	display_name embed ext_bwidth fade font geometry hold iconName	1474	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1233	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1475	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1476	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1234	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1477	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1235	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1478	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1236	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1479	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1237	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1480	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1238	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1481	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1239	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1482	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1240	secondaryScreen secondaryScroll selectstyle shade term_name title	1483	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1241	transient_for transparent transparent_all tripleclickwords utmpInhibit	1484	term_name title transient_for transparent tripleclickwords urgentOnBell
1242	visualBell	1485	utmpInhibit visualBell
1243		1486
1244	=cut	1487	=cut
1245		1488
1246	sub resource($$;$) {	1489	sub resource($$;$) {
1247	my ($self, $name) = (shift, shift);	1490	my ($self, $name) = (shift, shift);
1248	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1491	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1249	&urxvt::term::_resource	1492	goto &urxvt::term::_resource
1250	}	1493	}
1251		1494
1252	=item $value = $term->x_resource ($pattern)	1495	=item $value = $term->x_resource ($pattern)
1253		1496
1254	Returns the X-Resource for the given pattern, excluding the program or	1497	Returns the X-Resource for the given pattern, excluding the program or
…		…
1258		1501
1259	This method should only be called during the C<on_start> hook, as there is	1502	This method should only be called during the C<on_start> hook, as there is
1260	only one resource database per display, and later invocations might return	1503	only one resource database per display, and later invocations might return
1261	the wrong resources.	1504	the wrong resources.
1262		1505
1263	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1506	=item $value = $term->x_resource_boolean ($pattern)
1264		1507
		1508	Like C<x_resource>, above, but interprets the string value as a boolean
		1509	and returns C<1> for true values, C<0> for false values and C<undef> if
		1510	the resource or option isn't specified.
		1511
		1512	You should always use this method to parse boolean resources.
		1513
		1514	=cut
		1515
		1516	sub x_resource_boolean {
		1517	my $res = &x_resource;
		1518
		1519	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1520	}
		1521
		1522	=item $success = $term->parse_keysym ($key, $octets)
		1523
1265	Adds a keymap translation exactly as specified via a resource. See the	1524	Adds a key binding exactly as specified via a resource. See the
1266	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1525	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1526
		1527	=item $term->register_command ($keysym, $modifiermask, $string)
		1528
		1529	Adds a key binding. This is a lower level api compared to
		1530	C<parse_keysym>, as it expects a parsed key description, and can be
		1531	used only inside either the C<on_init> hook, to add a binding, or the
		1532	C<on_register_command> hook, to modify a parsed binding.
1267		1533
1268	=item $rend = $term->rstyle ([$new_rstyle])	1534	=item $rend = $term->rstyle ([$new_rstyle])
1269		1535
1270	Return and optionally change the current rendition. Text that is output by	1536	Return and optionally change the current rendition. Text that is output by
1271	the terminal application will use this style.	1537	the terminal application will use this style.
…		…
1279		1545
1280	=item ($row, $col) = $term->selection_beg ([$row, $col])	1546	=item ($row, $col) = $term->selection_beg ([$row, $col])
1281		1547
1282	=item ($row, $col) = $term->selection_end ([$row, $col])	1548	=item ($row, $col) = $term->selection_end ([$row, $col])
1283		1549
1284	Return the current values of the selection mark, begin or end positions,	1550	Return the current values of the selection mark, begin or end positions.
1285	and optionally set them to new values.	1551
		1552	When arguments are given, then the selection coordinates are set to
		1553	C<$row> and C<$col>, and the selection screen is set to the current
		1554	screen.
		1555
		1556	=item $screen = $term->selection_screen ([$screen])
		1557
		1558	Returns the current selection screen, and then optionally sets it.
1286		1559
1287	=item $term->selection_make ($eventtime[, $rectangular])	1560	=item $term->selection_make ($eventtime[, $rectangular])
1288		1561
1289	Tries to make a selection as set by C<selection_beg> and	1562	Tries to make a selection as set by C<selection_beg> and
1290	C<selection_end>. If C<$rectangular> is true (default: false), a	1563	C<selection_end>. If C<$rectangular> is true (default: false), a
1291	rectangular selection will be made. This is the prefered function to make	1564	rectangular selection will be made. This is the preferred function to make
1292	a selection.	1565	a selection.
1293		1566
1294	=item $success = $term->selection_grab ($eventtime)	1567	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1295		1568
1296	Try to request the primary selection text from the server (for example, as	1569	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1570	true) selection from the server. The corresponding text can be set
1297	set by the next method). No visual feedback will be given. This function	1571	with the next method. No visual feedback will be given. This function
1298	is mostly useful from within C<on_sel_grab> hooks.	1572	is mostly useful from within C<on_sel_grab> hooks.
1299		1573
1300	=item $oldtext = $term->selection ([$newtext])	1574	=item $oldtext = $term->selection ([$newtext, $clipboard])
1301		1575
1302	Return the current selection text and optionally replace it by C<$newtext>.	1576	Return the current selection (clipboard if C<$clipboard> is true) text
		1577	and optionally replace it by C<$newtext>.
		1578
		1579	=item $term->selection_clear ([$clipboard])
		1580
		1581	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1303		1582
1304	=item $term->overlay_simple ($x, $y, $text)	1583	=item $term->overlay_simple ($x, $y, $text)
1305		1584
1306	Create a simple multi-line overlay box. See the next method for details.	1585	Create a simple multi-line overlay box. See the next method for details.
1307		1586
…		…
1337		1616
1338	The methods currently supported on C<urxvt::overlay> objects are:	1617	The methods currently supported on C<urxvt::overlay> objects are:
1339		1618
1340	=over 4	1619	=over 4
1341		1620
1342	=item $overlay->set ($x, $y, $text, $rend)	1621	=item $overlay->set ($x, $y, $text[, $rend])
1343		1622
1344	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1623	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1345	text in rxvt-unicode's special encoding and an array of rendition values	1624	text in rxvt-unicode's special encoding and an array of rendition values
1346	at a specific position inside the overlay.	1625	at a specific position inside the overlay.
		1626
		1627	If C<$rend> is missing, then the rendition will not be changed.
1347		1628
1348	=item $overlay->hide	1629	=item $overlay->hide
1349		1630
1350	If visible, hide the overlay, but do not destroy it.	1631	If visible, hide the overlay, but do not destroy it.
1351		1632
…		…
1433	locale-specific encoding of the terminal and can contain command sequences	1714	locale-specific encoding of the terminal and can contain command sequences
1434	(escape codes) that will be interpreted.	1715	(escape codes) that will be interpreted.
1435		1716
1436	=item $term->tt_write ($octets)	1717	=item $term->tt_write ($octets)
1437		1718
1438	Write the octets given in C<$data> to the tty (i.e. as program input). To	1719	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1439	pass characters instead of octets, you should convert your strings first	1720	pass characters instead of octets, you should convert your strings first
1440	to the locale-specific encoding using C<< $term->locale_encode >>.	1721	to the locale-specific encoding using C<< $term->locale_encode >>.
		1722
		1723	=item $term->tt_paste ($octets)
		1724
		1725	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1726	CR and bracketing the data with control sequences if bracketed paste mode
		1727	is set.
1441		1728
1442	=item $old_events = $term->pty_ev_events ([$new_events])	1729	=item $old_events = $term->pty_ev_events ([$new_events])
1443		1730
1444	Replaces the event mask of the pty watcher by the given event mask. Can	1731	Replaces the event mask of the pty watcher by the given event mask. Can
1445	be used to suppress input and output handling to the pty/tty. See the	1732	be used to suppress input and output handling to the pty/tty. See the
…		…
1464	Adds the specified events to the vt event mask. Useful e.g. when you want	1751	Adds the specified events to the vt event mask. Useful e.g. when you want
1465	to receive pointer events all the times:	1752	to receive pointer events all the times:
1466		1753
1467	$term->vt_emask_add (urxvt::PointerMotionMask);	1754	$term->vt_emask_add (urxvt::PointerMotionMask);
1468		1755
		1756	=item $term->set_urgency ($set)
		1757
		1758	Enable/disable the urgency hint on the toplevel window.
		1759
1469	=item $term->focus_in	1760	=item $term->focus_in
1470		1761
1471	=item $term->focus_out	1762	=item $term->focus_out
1472		1763
1473	=item $term->key_press ($state, $keycode[, $time])	1764	=item $term->key_press ($state, $keycode[, $time])
…		…
1561		1852
1562	Used after changing terminal contents to display them.	1853	Used after changing terminal contents to display them.
1563		1854
1564	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1855	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1565		1856
1566	Returns the text of the entire row with number C<$row_number>. Row C<0>	1857	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1567	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1858	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1568	terminal line. The scrollback buffer starts at line C<-1> and extends to
1569	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1859	terminal line. Nothing will be returned if a nonexistent line
1570	is requested.	1860	is requested.
1571		1861
1572	If C<$new_text> is specified, it will replace characters in the current	1862	If C<$new_text> is specified, it will replace characters in the current
1573	line, starting at column C<$start_col> (default C<0>), which is useful	1863	line, starting at column C<$start_col> (default C<0>), which is useful
1574	to replace only parts of a line. The font index in the rendition will	1864	to replace only parts of a line. The font index in the rendition will
1575	automatically be updated.	1865	automatically be updated.
1576		1866
1577	C<$text> is in a special encoding: tabs and wide characters that use more	1867	C<$text> is in a special encoding: tabs and wide characters that use more
1578	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1868	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1579	characters. Characters with combining characters and other characters that	1869	characters. Characters with combining characters and other characters that
1580	do not fit into the normal tetx encoding will be replaced with characters	1870	do not fit into the normal text encoding will be replaced with characters
1581	in the private use area.	1871	in the private use area.
1582		1872
1583	You have to obey this encoding when changing text. The advantage is	1873	You have to obey this encoding when changing text. The advantage is
1584	that C<substr> and similar functions work on screen cells and not on	1874	that C<substr> and similar functions work on screen cells and not on
1585	characters.	1875	characters.
…		…
1760	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2050	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1761	recent grab.	2051	recent grab.
1762		2052
1763	=item $term->ungrab	2053	=item $term->ungrab
1764		2054
1765	Calls XUngrab for the most recent grab. Is called automatically on	2055	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1766	evaluation errors, as it is better to lose the grab in the error case as	2056	evaluation errors, as it is better to lose the grab in the error case as
1767	the session.	2057	the session.
1768		2058
1769	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2059	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1770		2060
…		…
1772		2062
1773	=item @atoms = $term->XListProperties ($window)	2063	=item @atoms = $term->XListProperties ($window)
1774		2064
1775	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2065	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1776		2066
1777	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2067	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1778		2068
1779	=item $term->XDeleteProperty ($window, $property)	2069	=item $term->XDeleteProperty ($window, $property)
1780		2070
1781	=item $window = $term->DefaultRootWindow	2071	=item $window = $term->DefaultRootWindow
1782		2072
…		…
1789	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2079	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1790		2080
1791	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2081	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1792		2082
1793	=item $term->XChangeInput ($window, $add_events[, $del_events])	2083	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2084
		2085	=item $keysym = $term->XStringToKeysym ($string)
		2086
		2087	=item $string = $term->XKeysymToString ($keysym)
1794		2088
1795	Various X or X-related functions. The C<$term> object only serves as	2089	Various X or X-related functions. The C<$term> object only serves as
1796	the source of the display, otherwise those functions map more-or-less	2090	the source of the display, otherwise those functions map more-or-less
1797	directory onto the X functions of the same name.	2091	directly onto the X functions of the same name.
1798		2092
1799	=back	2093	=back
1800		2094
1801	=cut	2095	=cut
1802		2096
…		…
1904	my $env = $self->{term}->env;	2198	my $env = $self->{term}->env;
1905	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2199	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1906	delete $env->{LC_ALL};	2200	delete $env->{LC_ALL};
1907	$env->{LC_CTYPE} = $self->{term}->locale;	2201	$env->{LC_CTYPE} = $self->{term}->locale;
1908		2202
1909	urxvt::term->new ($env, "popup",	2203	my $term = urxvt::term->new (
		2204	$env, "popup",
1910	"--perl-lib" => "", "--perl-ext-common" => "",	2205	"--perl-lib" => "", "--perl-ext-common" => "",
1911	"-pty-fd" => -1, "-sl" => 0,	2206	"-pty-fd" => -1, "-sl" => 0,
1912	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2207	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1913	"--transient-for" => $self->{term}->parent,	2208	"--transient-for" => $self->{term}->parent,
1914	"-display" => $self->{term}->display_id,	2209	"-display" => $self->{term}->display_id,
1915	"-pe" => "urxvt-popup")	2210	"-pe" => "urxvt-popup",
1916	or die "unable to create popup window\n";	2211	) or die "unable to create popup window\n";
		2212
		2213	unless (delete $term->{urxvt_popup_init_done}) {
		2214	$term->ungrab;
		2215	$term->destroy;
		2216	die "unable to initialise popup window\n";
		2217	}
1917	}	2218	}
1918		2219
1919	sub DESTROY {	2220	sub DESTROY {
1920	my ($self) = @_;	2221	my ($self) = @_;
1921		2222
…		…
1926	=back	2227	=back
1927		2228
1928	=cut	2229	=cut
1929		2230
1930	package urxvt::watcher;	2231	package urxvt::watcher;
1931
1932	@urxvt::timer::ISA = __PACKAGE__;
1933	@urxvt::iow::ISA = __PACKAGE__;
1934	@urxvt::pw::ISA = __PACKAGE__;
1935	@urxvt::iw::ISA = __PACKAGE__;
1936		2232
1937	=head2 The C<urxvt::timer> Class	2233	=head2 The C<urxvt::timer> Class
1938		2234
1939	This class implements timer watchers/events. Time is represented as a	2235	This class implements timer watchers/events. Time is represented as a
1940	fractional number of seconds since the epoch. Example:	2236	fractional number of seconds since the epoch. Example:
…		…
1944	->new	2240	->new
1945	->interval (1)	2241	->interval (1)
1946	->cb (sub {	2242	->cb (sub {
1947	$term->{overlay}->set (0, 0,	2243	$term->{overlay}->set (0, 0,
1948	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2244	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1949	});	2245	});
1950		2246
1951	=over 4	2247	=over 4
1952		2248
1953	=item $timer = new urxvt::timer	2249	=item $timer = new urxvt::timer
1954		2250
…		…
1957		2253
1958	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2254	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1959		2255
1960	Set the callback to be called when the timer triggers.	2256	Set the callback to be called when the timer triggers.
1961		2257
1962	=item $tstamp = $timer->at
1963
1964	Return the time this watcher will fire next.
1965
1966	=item $timer = $timer->set ($tstamp)	2258	=item $timer = $timer->set ($tstamp[, $interval])
1967		2259
1968	Set the time the event is generated to $tstamp.	2260	Set the time the event is generated to $tstamp (and optionally specifies a
		2261	new $interval).
1969		2262
1970	=item $timer = $timer->interval ($interval)	2263	=item $timer = $timer->interval ($interval)
1971		2264
1972	Normally (and when C<$interval> is C<0>), the timer will automatically	2265	By default (and when C<$interval> is C<0>), the timer will automatically
1973	stop after it has fired once. If C<$interval> is non-zero, then the timer	2266	stop after it has fired once. If C<$interval> is non-zero, then the timer
1974	is automatically rescheduled at the given intervals.	2267	is automatically rescheduled at the given intervals.
1975		2268
1976	=item $timer = $timer->start	2269	=item $timer = $timer->start
1977		2270
1978	Start the timer.	2271	Start the timer.
1979		2272
1980	=item $timer = $timer->start ($tstamp)	2273	=item $timer = $timer->start ($tstamp[, $interval])
1981		2274
1982	Set the event trigger time to C<$tstamp> and start the timer.	2275	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2276	also replaces the interval.
1983		2277
1984	=item $timer = $timer->after ($delay)	2278	=item $timer = $timer->after ($delay[, $interval])
1985		2279
1986	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2280	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1987		2281
1988	=item $timer = $timer->stop	2282	=item $timer = $timer->stop
1989		2283
…		…
1997		2291
1998	$term->{socket} = ...	2292	$term->{socket} = ...
1999	$term->{iow} = urxvt::iow	2293	$term->{iow} = urxvt::iow
2000	->new	2294	->new
2001	->fd (fileno $term->{socket})	2295	->fd (fileno $term->{socket})
2002	->events (urxvt::EVENT_READ)	2296	->events (urxvt::EV_READ)
2003	->start	2297	->start
2004	->cb (sub {	2298	->cb (sub {
2005	my ($iow, $revents) = @_;	2299	my ($iow, $revents) = @_;
2006	# $revents must be 1 here, no need to check	2300	# $revents must be 1 here, no need to check
2007	sysread $term->{socket}, my $buf, 8192	2301	sysread $term->{socket}, my $buf, 8192
…		…
2025	Set the file descriptor (not handle) to watch.	2319	Set the file descriptor (not handle) to watch.
2026		2320
2027	=item $iow = $iow->events ($eventmask)	2321	=item $iow = $iow->events ($eventmask)
2028		2322
2029	Set the event mask to watch. The only allowed values are	2323	Set the event mask to watch. The only allowed values are
2030	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2324	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2031	together, or C<urxvt::EVENT_NONE>.	2325	together, or C<urxvt::EV_NONE>.
2032		2326
2033	=item $iow = $iow->start	2327	=item $iow = $iow->start
2034		2328
2035	Start watching for requested events on the given handle.	2329	Start watching for requested events on the given handle.
2036		2330
…		…
2077	->new	2371	->new
2078	->start ($pid)	2372	->start ($pid)
2079	->cb (sub {	2373	->cb (sub {
2080	my ($pw, $exit_status) = @_;	2374	my ($pw, $exit_status) = @_;
2081	...	2375	...
2082	});	2376	});
2083		2377
2084	=over 4	2378	=over 4
2085		2379
2086	=item $pw = new urxvt::pw	2380	=item $pw = new urxvt::pw
2087		2381
…		…
2120		2414
2121	=back	2415	=back
2122		2416
2123	=head1 AUTHOR	2417	=head1 AUTHOR
2124		2418
2125	Marc Lehmann <pcg@goof.com>	2419	Marc Lehmann <schmorp@schmorp.de>
2126	http://software.schmorp.de/pkg/rxvt-unicode	2420	http://software.schmorp.de/pkg/rxvt-unicode
2127		2421
2128	=cut	2422	=cut
2129		2423
2130	1	2424	1
		2425
		2426	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.145 by root, Thu Aug 10 22:53:20 2006 UTC vs. Revision 1.212 by root, Wed Jun 6 15:06:41 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.145 by root, Thu Aug 10 22:53:20 2006 UTC vs.
Revision 1.212 by root, Wed Jun 6 15:06:41 2012 UTC