[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.216 by root, Sun Jun 10 13:32:55 2012 UTC

…		…
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Every time a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
98		101
99	Other extensions can extend this popup menu by pushing a code reference	102	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the	103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.	104	popup is being displayed.
102		105
103	It's sole argument is the popup menu, which can be modified. It should	106	Its sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code	107	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference	108	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as	109	will be called when the toggle changes, with the new boolean value as
107	first argument.	110	first argument.
108		111
109	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
111		114
112	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};	117	};
115		118
…		…
121		124
122	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.	127	popup is being displayed.
125		128
126	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide whether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
128	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
131		134
132	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:	137	C<a>s:
135		138
136	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
138	: ()	141	: ()
139	};	142	};
140		143
141	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
142		145
…		…
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
154	selection.	157	selection if the C<Shift> modifier is active.
155		158
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To	159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>	160	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.	161	or simply use an uppercase character which removes the "(?i)" prefix.
159		162
…		…
162	=item readline (enabled by default)	165	=item readline (enabled by default)
163		166
164	A support package that tries to make editing with readline easier. At	167	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
166	move the text cursor to this position. It does so by generating as many	169	move the text cursor to this position. It does so by generating as many
167	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
168	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
169		172
170	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
171		174
172	=over 4	175	=over 4
…		…
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
…		…
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).
659		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
		752
660	=back	753	=back
661		754
662	=cut	755	=cut
663		756
664	package urxvt;	757	package urxvt;
665		758
666	use utf8;	759	use utf8;
667	use strict;	760	use strict 'vars';
668	use Carp ();	761	use Carp ();
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	$name =~ y/-/./ if $isarg;
		952
		953	$term->scan_meta;
		954
		955	my $r = $term->{meta}{resource};
		956	keys %$r; # reste iterator
		957	while (my ($pattern, $v) = each %$r) {
		958	if (
		959	$pattern =~ /\.$/
		960	? $pattern eq substr $name, 0, length $pattern
		961	: $pattern eq $name
		962	) {
		963	$name = "$urxvt::RESCLASS.$name";
		964
		965	push @{ $term->{perl_ext_3} }, $v->[0];
		966
		967	if ($v->[1] eq "boolean") {
		968	$term->put_option_db ($name, $flag ? "true" : "false");
		969	return 1;
		970	} else {
		971	$term->put_option_db ($name, $value);
		972	return 1 + 2;
		973	}
		974	}
		975	}
		976
		977	0
		978	}
		979
		980	sub usage {
		981	my ($term, $usage_type) = @_;
		982
		983	$term->scan_meta;
		984
		985	my $r = $term->{meta}{resource};
		986
		987	for my $pattern (sort keys %$r) {
		988	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		989
		990	$desc .= " (-pe $ext)";
		991
		992	if ($usage_type == 1) {
		993	$pattern =~ y/./-/;
		994	$pattern =~ s/-$/-.../g;
		995
		996	if ($type eq "boolean") {
		997	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		998	} else {
		999	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		1000	}
		1001	} else {
		1002	$pattern =~ s/\.$/.*/g;
		1003	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1004	}
		1005	}
		1006	}
		1007
853	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1008	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
854		1009
855	sub verbose {	1010	sub verbose {
856	my ($level, $msg) = @_;	1011	my ($level, $msg) = @_;
857	warn "$msg\n" if $level <= $verbosity;	1012	warn "$msg\n" if $level <= $verbosity;
…		…
873		1028
874	open my $fh, "<:raw", $path	1029	open my $fh, "<:raw", $path
875	or die "$path: $!";	1030	or die "$path: $!";
876		1031
877	my $source =	1032	my $source =
878	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	1033	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
879	. "#line 1 \"$path\"\n{\n"	1034	. "#line 1 \"$path\"\n{\n"
880	. (do { local $/; <$fh> })	1035	. (do { local $/; <$fh> })
881	. "\n};\n1";	1036	. "\n};\n1";
882		1037
883	eval $source	1038	eval $source
…		…
893	sub invoke {	1048	sub invoke {
894	local $TERM = shift;	1049	local $TERM = shift;
895	my $htype = shift;	1050	my $htype = shift;
896		1051
897	if ($htype == 0) { # INIT	1052	if ($htype == 0) { # INIT
898	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1053	my @dirs = $TERM->perl_libdirs;
899		1054
900	my %ext_arg;	1055	my %ext_arg;
901		1056
902	{	1057	{
903	my @init = @TERM_INIT;	1058	my @init = @TERM_INIT;
904	@TERM_INIT = ();	1059	@TERM_INIT = ();
…		…
906	my @pkg = @TERM_EXT;	1061	my @pkg = @TERM_EXT;
907	@TERM_EXT = ();	1062	@TERM_EXT = ();
908	$TERM->register_package ($_) for @pkg;	1063	$TERM->register_package ($_) for @pkg;
909	}	1064	}
910		1065
		1066	for (
		1067	@{ delete $TERM->{perl_ext_3} },
911	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1068	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1069	) {
912	if ($_ eq "default") {	1070	if ($_ eq "default") {
913	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	1071	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
914	} elsif (/^-(.*)$/) {	1072	} elsif (/^-(.*)$/) {
915	delete $ext_arg{$1};	1073	delete $ext_arg{$1};
916	} elsif (/^([^<]+)<(.*)>$/) {	1074	} elsif (/^([^<]+)<(.*)>$/) {
…		…
967		1125
968	sub SET_COLOR($$$) {	1126	sub SET_COLOR($$$) {
969	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1127	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
970	}	1128	}
971		1129
		1130	sub rend2mask {
		1131	no strict 'refs';
		1132	my ($str, $mask) = (@_, 0);
		1133	my %color = ( fg => undef, bg => undef );
		1134	my @failed;
		1135	for my $spec ( split /\s+/, $str ) {
		1136	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1137	$color{lc($1)} = $2;
		1138	} else {
		1139	my $neg = $spec =~ s/^[-^]//;
		1140	unless ( exists &{"RS_$spec"} ) {
		1141	push @failed, $spec;
		1142	next;
		1143	}
		1144	my $cur = &{"RS_$spec"};
		1145	if ( $neg ) {
		1146	$mask &= ~$cur;
		1147	} else {
		1148	$mask \|= $cur;
		1149	}
		1150	}
		1151	}
		1152	($mask, @color{qw(fg bg)}, \@failed)
		1153	}
		1154
972	# urxvt::term::extension	1155	# urxvt::term::extension
973		1156
974	package urxvt::term::extension;	1157	package urxvt::term::extension;
975		1158
976	sub enable {	1159	sub enable {
…		…
1039	=head2 The C<urxvt::anyevent> Class	1222	=head2 The C<urxvt::anyevent> Class
1040		1223
1041	The sole purpose of this class is to deliver an interface to the	1224	The sole purpose of this class is to deliver an interface to the
1042	C<AnyEvent> module - any module using it will work inside urxvt without	1225	C<AnyEvent> module - any module using it will work inside urxvt without
1043	further programming. The only exception is that you cannot wait on	1226	further programming. The only exception is that you cannot wait on
1044	condition variables, but non-blocking condvar use is ok. What this means	1227	condition variables, but non-blocking condvar use is ok.
1045	is that you cannot use blocking APIs, but the non-blocking variant should	1228
1046	work.	1229	In practical terms this means is that you cannot use blocking APIs, but
		1230	the non-blocking variant should work.
1047		1231
1048	=cut	1232	=cut
1049		1233
1050	our $VERSION = 1;	1234	our $VERSION = '5.23';
1051		1235
1052	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1236	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1053	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1237	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1054		1238
1055	sub timer {	1239	sub timer {
…		…
1057		1241
1058	my $cb = $arg{cb};	1242	my $cb = $arg{cb};
1059		1243
1060	urxvt::timer	1244	urxvt::timer
1061	->new	1245	->new
1062	->start (urxvt::NOW + $arg{after})	1246	->after ($arg{after}, $arg{interval})
1063	->cb (sub {	1247	->cb ($arg{interval} ? $cb : sub {
1064	$_[0]->stop; # need to cancel manually	1248	$_[0]->stop; # need to cancel manually
1065	$cb->();	1249	$cb->();
1066	})	1250	})
1067	}	1251	}
1068		1252
1069	sub io {	1253	sub io {
1070	my ($class, %arg) = @_;	1254	my ($class, %arg) = @_;
1071		1255
1072	my $cb = $arg{cb};	1256	my $cb = $arg{cb};
		1257	my $fd = fileno $arg{fh};
		1258	defined $fd or $fd = $arg{fh};
1073		1259
1074	bless [$arg{fh}, urxvt::iow	1260	bless [$arg{fh}, urxvt::iow
1075	->new	1261	->new
1076	->fd (fileno $arg{fh})	1262	->fd ($fd)
1077	->events (($arg{poll} =~ /r/ ? 1 : 0)	1263	->events (($arg{poll} =~ /r/ ? 1 : 0)
1078	\| ($arg{poll} =~ /w/ ? 2 : 0))	1264	\| ($arg{poll} =~ /w/ ? 2 : 0))
1079	->start	1265	->start
1080	->cb (sub {	1266	->cb ($cb)
1081	$cb->(($_[1] & 1 ? 'r' : '')
1082	. ($_[1] & 2 ? 'w' : ''));
1083	})],
1084	urxvt::anyevent::	1267	], urxvt::anyevent::
		1268	}
		1269
		1270	sub idle {
		1271	my ($class, %arg) = @_;
		1272
		1273	my $cb = $arg{cb};
		1274
		1275	urxvt::iw
		1276	->new
		1277	->start
		1278	->cb ($cb)
		1279	}
		1280
		1281	sub child {
		1282	my ($class, %arg) = @_;
		1283
		1284	my $cb = $arg{cb};
		1285
		1286	urxvt::pw
		1287	->new
		1288	->start ($arg{pid})
		1289	->cb (sub {
		1290	$_[0]->stop; # need to cancel manually
		1291	$cb->($_[0]->rpid, $_[0]->rstatus);
		1292	})
1085	}	1293	}
1086		1294
1087	sub DESTROY {	1295	sub DESTROY {
1088	$_[0][1]->stop;	1296	$_[0][1]->stop;
1089	}	1297	}
1090		1298
1091	sub condvar {	1299	# only needed for AnyEvent < 6 compatibility
1092	bless \my $flag, urxvt::anyevent::condvar::	1300	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";	1301	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1102	}
1103	}	1302	}
1104		1303
1105	package urxvt::term;	1304	package urxvt::term;
1106		1305
1107	=head2 The C<urxvt::term> Class	1306	=head2 The C<urxvt::term> Class
…		…
1134	$proxy->enable ($name => $ref);	1333	$proxy->enable ($name => $ref);
1135	}	1334	}
1136	}	1335	}
1137	}	1336	}
1138		1337
		1338	sub perl_libdirs {
		1339	map { split /:/ }
		1340	$_[0]->resource ("perl_lib"),
		1341	$ENV{URXVT_PERL_LIB},
		1342	"$ENV{HOME}/.urxvt/ext",
		1343	"$LIBDIR/perl"
		1344	}
		1345
		1346	sub scan_meta {
		1347	my ($self) = @_;
		1348	my @libdirs = perl_libdirs $self;
		1349
		1350	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1351
		1352	my %meta;
		1353
		1354	$self->{meta_libdirs} = join "\x00", @libdirs;
		1355	$self->{meta} = \%meta;
		1356
		1357	for my $dir (reverse @libdirs) {
		1358	opendir my $fh, $dir
		1359	or next;
		1360	for my $ext (readdir $fh) {
		1361	$ext ne "."
		1362	and $ext ne ".."
		1363	and open my $fh, "<", "$dir/$ext"
		1364	or next;
		1365
		1366	while (<$fh>) {
		1367	if (/^#:META:X_RESOURCE:(.*)/) {
		1368	my ($pattern, $type, $desc) = split /:/, $1;
		1369	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1370	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1371	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1372	} else {
		1373	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1374	}
		1375	} elsif (/^\s*(?:#\|$)/) {
		1376	# skip other comments and empty lines
		1377	} else {
		1378	last; # stop parsing on first non-empty non-comment line
		1379	}
		1380	}
		1381	}
		1382	}
		1383	}
		1384
1139	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1385	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1140		1386
1141	Creates a new terminal, very similar as if you had started it with system	1387	Creates a new terminal, very similar as if you had started it with system
1142	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1388	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1143	hash which defines the environment of the new terminal.	1389	hash which defines the environment of the new terminal.
…		…
1197	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1443	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1198		1444
1199	Here is a likely non-exhaustive list of option names, please see the	1445	Here is a likely non-exhaustive list of option names, please see the
1200	source file F</src/optinc.h> to see the actual list:	1446	source file F</src/optinc.h> to see the actual list:
1201		1447
1202	borderLess console cursorBlink cursorUnderline hold iconic insecure	1448	borderLess buffered console cursorBlink cursorUnderline hold iconic
1203	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1449	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1204	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1450	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1205	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1451	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1206	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1452	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1207	transparent tripleclickwords utmpInhibit visualBell	1453	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1454	urgentOnBell utmpInhibit visualBell
1208		1455
1209	=item $value = $term->resource ($name[, $newval])	1456	=item $value = $term->resource ($name[, $newval])
1210		1457
1211	Returns the current resource value associated with a given name and	1458	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>	1459	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1225		1472
1226	Here is a likely non-exhaustive list of resource names, not all of which	1473	Here is a likely non-exhaustive list of resource names, not all of which
1227	are supported in every build, please see the source file F</src/rsinc.h>	1474	are supported in every build, please see the source file F</src/rsinc.h>
1228	to see the actual list:	1475	to see the actual list:
1229		1476
1230	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1477	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1231	borderLess color cursorBlink cursorUnderline cutchars delete_key	1478	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1232	display_name embed ext_bwidth fade font geometry hold iconName	1479	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1233	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1480	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1481	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1234	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1482	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1235	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1483	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1236	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1484	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1237	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1485	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1238	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1486	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1239	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1487	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1240	secondaryScreen secondaryScroll selectstyle shade term_name title	1488	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1241	transient_for transparent transparent_all tripleclickwords utmpInhibit	1489	term_name title transient_for transparent tripleclickwords urgentOnBell
1242	visualBell	1490	utmpInhibit visualBell
1243		1491
1244	=cut	1492	=cut
1245		1493
1246	sub resource($$;$) {	1494	sub resource($$;$) {
1247	my ($self, $name) = (shift, shift);	1495	my ($self, $name) = (shift, shift);
1248	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1496	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1249	&urxvt::term::_resource	1497	goto &urxvt::term::_resource
1250	}	1498	}
1251		1499
1252	=item $value = $term->x_resource ($pattern)	1500	=item $value = $term->x_resource ($pattern)
1253		1501
1254	Returns the X-Resource for the given pattern, excluding the program or	1502	Returns the X-Resource for the given pattern, excluding the program or
…		…
1258		1506
1259	This method should only be called during the C<on_start> hook, as there is	1507	This method should only be called during the C<on_start> hook, as there is
1260	only one resource database per display, and later invocations might return	1508	only one resource database per display, and later invocations might return
1261	the wrong resources.	1509	the wrong resources.
1262		1510
1263	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1511	=item $value = $term->x_resource_boolean ($pattern)
1264		1512
		1513	Like C<x_resource>, above, but interprets the string value as a boolean
		1514	and returns C<1> for true values, C<0> for false values and C<undef> if
		1515	the resource or option isn't specified.
		1516
		1517	You should always use this method to parse boolean resources.
		1518
		1519	=cut
		1520
		1521	sub x_resource_boolean {
		1522	my $res = &x_resource;
		1523
		1524	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1525	}
		1526
		1527	=item $success = $term->parse_keysym ($key, $octets)
		1528
1265	Adds a keymap translation exactly as specified via a resource. See the	1529	Adds a key binding exactly as specified via a resource. See the
1266	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1530	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1531
		1532	=item $term->register_command ($keysym, $modifiermask, $string)
		1533
		1534	Adds a key binding. This is a lower level api compared to
		1535	C<parse_keysym>, as it expects a parsed key description, and can be
		1536	used only inside either the C<on_init> hook, to add a binding, or the
		1537	C<on_register_command> hook, to modify a parsed binding.
1267		1538
1268	=item $rend = $term->rstyle ([$new_rstyle])	1539	=item $rend = $term->rstyle ([$new_rstyle])
1269		1540
1270	Return and optionally change the current rendition. Text that is output by	1541	Return and optionally change the current rendition. Text that is output by
1271	the terminal application will use this style.	1542	the terminal application will use this style.
…		…
1279		1550
1280	=item ($row, $col) = $term->selection_beg ([$row, $col])	1551	=item ($row, $col) = $term->selection_beg ([$row, $col])
1281		1552
1282	=item ($row, $col) = $term->selection_end ([$row, $col])	1553	=item ($row, $col) = $term->selection_end ([$row, $col])
1283		1554
1284	Return the current values of the selection mark, begin or end positions,	1555	Return the current values of the selection mark, begin or end positions.
1285	and optionally set them to new values.	1556
		1557	When arguments are given, then the selection coordinates are set to
		1558	C<$row> and C<$col>, and the selection screen is set to the current
		1559	screen.
		1560
		1561	=item $screen = $term->selection_screen ([$screen])
		1562
		1563	Returns the current selection screen, and then optionally sets it.
1286		1564
1287	=item $term->selection_make ($eventtime[, $rectangular])	1565	=item $term->selection_make ($eventtime[, $rectangular])
1288		1566
1289	Tries to make a selection as set by C<selection_beg> and	1567	Tries to make a selection as set by C<selection_beg> and
1290	C<selection_end>. If C<$rectangular> is true (default: false), a	1568	C<selection_end>. If C<$rectangular> is true (default: false), a
1291	rectangular selection will be made. This is the prefered function to make	1569	rectangular selection will be made. This is the preferred function to make
1292	a selection.	1570	a selection.
1293		1571
1294	=item $success = $term->selection_grab ($eventtime)	1572	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1295		1573
1296	Try to request the primary selection text from the server (for example, as	1574	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1575	true) selection from the server. The corresponding text can be set
1297	set by the next method). No visual feedback will be given. This function	1576	with the next method. No visual feedback will be given. This function
1298	is mostly useful from within C<on_sel_grab> hooks.	1577	is mostly useful from within C<on_sel_grab> hooks.
1299		1578
1300	=item $oldtext = $term->selection ([$newtext])	1579	=item $oldtext = $term->selection ([$newtext, $clipboard])
1301		1580
1302	Return the current selection text and optionally replace it by C<$newtext>.	1581	Return the current selection (clipboard if C<$clipboard> is true) text
		1582	and optionally replace it by C<$newtext>.
		1583
		1584	=item $term->selection_clear ([$clipboard])
		1585
		1586	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1303		1587
1304	=item $term->overlay_simple ($x, $y, $text)	1588	=item $term->overlay_simple ($x, $y, $text)
1305		1589
1306	Create a simple multi-line overlay box. See the next method for details.	1590	Create a simple multi-line overlay box. See the next method for details.
1307		1591
…		…
1337		1621
1338	The methods currently supported on C<urxvt::overlay> objects are:	1622	The methods currently supported on C<urxvt::overlay> objects are:
1339		1623
1340	=over 4	1624	=over 4
1341		1625
1342	=item $overlay->set ($x, $y, $text, $rend)	1626	=item $overlay->set ($x, $y, $text[, $rend])
1343		1627
1344	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1628	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1345	text in rxvt-unicode's special encoding and an array of rendition values	1629	text in rxvt-unicode's special encoding and an array of rendition values
1346	at a specific position inside the overlay.	1630	at a specific position inside the overlay.
		1631
		1632	If C<$rend> is missing, then the rendition will not be changed.
1347		1633
1348	=item $overlay->hide	1634	=item $overlay->hide
1349		1635
1350	If visible, hide the overlay, but do not destroy it.	1636	If visible, hide the overlay, but do not destroy it.
1351		1637
…		…
1433	locale-specific encoding of the terminal and can contain command sequences	1719	locale-specific encoding of the terminal and can contain command sequences
1434	(escape codes) that will be interpreted.	1720	(escape codes) that will be interpreted.
1435		1721
1436	=item $term->tt_write ($octets)	1722	=item $term->tt_write ($octets)
1437		1723
1438	Write the octets given in C<$data> to the tty (i.e. as program input). To	1724	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1439	pass characters instead of octets, you should convert your strings first	1725	pass characters instead of octets, you should convert your strings first
1440	to the locale-specific encoding using C<< $term->locale_encode >>.	1726	to the locale-specific encoding using C<< $term->locale_encode >>.
		1727
		1728	=item $term->tt_paste ($octets)
		1729
		1730	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1731	CR and bracketing the data with control sequences if bracketed paste mode
		1732	is set.
1441		1733
1442	=item $old_events = $term->pty_ev_events ([$new_events])	1734	=item $old_events = $term->pty_ev_events ([$new_events])
1443		1735
1444	Replaces the event mask of the pty watcher by the given event mask. Can	1736	Replaces the event mask of the pty watcher by the given event mask. Can
1445	be used to suppress input and output handling to the pty/tty. See the	1737	be used to suppress input and output handling to the pty/tty. See the
…		…
1464	Adds the specified events to the vt event mask. Useful e.g. when you want	1756	Adds the specified events to the vt event mask. Useful e.g. when you want
1465	to receive pointer events all the times:	1757	to receive pointer events all the times:
1466		1758
1467	$term->vt_emask_add (urxvt::PointerMotionMask);	1759	$term->vt_emask_add (urxvt::PointerMotionMask);
1468		1760
		1761	=item $term->set_urgency ($set)
		1762
		1763	Enable/disable the urgency hint on the toplevel window.
		1764
1469	=item $term->focus_in	1765	=item $term->focus_in
1470		1766
1471	=item $term->focus_out	1767	=item $term->focus_out
1472		1768
1473	=item $term->key_press ($state, $keycode[, $time])	1769	=item $term->key_press ($state, $keycode[, $time])
…		…
1561		1857
1562	Used after changing terminal contents to display them.	1858	Used after changing terminal contents to display them.
1563		1859
1564	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1860	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1565		1861
1566	Returns the text of the entire row with number C<$row_number>. Row C<0>	1862	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1567	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1863	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
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	1864	terminal line. Nothing will be returned if a nonexistent line
1570	is requested.	1865	is requested.
1571		1866
1572	If C<$new_text> is specified, it will replace characters in the current	1867	If C<$new_text> is specified, it will replace characters in the current
1573	line, starting at column C<$start_col> (default C<0>), which is useful	1868	line, starting at column C<$start_col> (default C<0>), which is useful
1574	to replace only parts of a line. The font index in the rendition will	1869	to replace only parts of a line. The font index in the rendition will
1575	automatically be updated.	1870	automatically be updated.
1576		1871
1577	C<$text> is in a special encoding: tabs and wide characters that use more	1872	C<$text> is in a special encoding: tabs and wide characters that use more
1578	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1873	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1579	characters. Characters with combining characters and other characters that	1874	characters. Characters with combining characters and other characters that
1580	do not fit into the normal tetx encoding will be replaced with characters	1875	do not fit into the normal text encoding will be replaced with characters
1581	in the private use area.	1876	in the private use area.
1582		1877
1583	You have to obey this encoding when changing text. The advantage is	1878	You have to obey this encoding when changing text. The advantage is
1584	that C<substr> and similar functions work on screen cells and not on	1879	that C<substr> and similar functions work on screen cells and not on
1585	characters.	1880	characters.
…		…
1760	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2055	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1761	recent grab.	2056	recent grab.
1762		2057
1763	=item $term->ungrab	2058	=item $term->ungrab
1764		2059
1765	Calls XUngrab for the most recent grab. Is called automatically on	2060	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1766	evaluation errors, as it is better to lose the grab in the error case as	2061	evaluation errors, as it is better to lose the grab in the error case as
1767	the session.	2062	the session.
1768		2063
1769	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2064	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1770		2065
…		…
1772		2067
1773	=item @atoms = $term->XListProperties ($window)	2068	=item @atoms = $term->XListProperties ($window)
1774		2069
1775	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2070	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1776		2071
1777	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2072	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1778		2073
1779	=item $term->XDeleteProperty ($window, $property)	2074	=item $term->XDeleteProperty ($window, $property)
1780		2075
1781	=item $window = $term->DefaultRootWindow	2076	=item $window = $term->DefaultRootWindow
1782		2077
…		…
1789	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2084	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1790		2085
1791	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2086	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1792		2087
1793	=item $term->XChangeInput ($window, $add_events[, $del_events])	2088	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2089
		2090	=item $keysym = $term->XStringToKeysym ($string)
		2091
		2092	=item $string = $term->XKeysymToString ($keysym)
1794		2093
1795	Various X or X-related functions. The C<$term> object only serves as	2094	Various X or X-related functions. The C<$term> object only serves as
1796	the source of the display, otherwise those functions map more-or-less	2095	the source of the display, otherwise those functions map more-or-less
1797	directory onto the X functions of the same name.	2096	directly onto the X functions of the same name.
1798		2097
1799	=back	2098	=back
1800		2099
1801	=cut	2100	=cut
1802		2101
…		…
1904	my $env = $self->{term}->env;	2203	my $env = $self->{term}->env;
1905	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2204	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1906	delete $env->{LC_ALL};	2205	delete $env->{LC_ALL};
1907	$env->{LC_CTYPE} = $self->{term}->locale;	2206	$env->{LC_CTYPE} = $self->{term}->locale;
1908		2207
1909	urxvt::term->new ($env, "popup",	2208	my $term = urxvt::term->new (
		2209	$env, "popup",
1910	"--perl-lib" => "", "--perl-ext-common" => "",	2210	"--perl-lib" => "", "--perl-ext-common" => "",
1911	"-pty-fd" => -1, "-sl" => 0,	2211	"-pty-fd" => -1, "-sl" => 0,
1912	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2212	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1913	"--transient-for" => $self->{term}->parent,	2213	"--transient-for" => $self->{term}->parent,
1914	"-display" => $self->{term}->display_id,	2214	"-display" => $self->{term}->display_id,
1915	"-pe" => "urxvt-popup")	2215	"-pe" => "urxvt-popup",
1916	or die "unable to create popup window\n";	2216	) or die "unable to create popup window\n";
		2217
		2218	unless (delete $term->{urxvt_popup_init_done}) {
		2219	$term->ungrab;
		2220	$term->destroy;
		2221	die "unable to initialise popup window\n";
		2222	}
1917	}	2223	}
1918		2224
1919	sub DESTROY {	2225	sub DESTROY {
1920	my ($self) = @_;	2226	my ($self) = @_;
1921		2227
…		…
1926	=back	2232	=back
1927		2233
1928	=cut	2234	=cut
1929		2235
1930	package urxvt::watcher;	2236	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		2237
1937	=head2 The C<urxvt::timer> Class	2238	=head2 The C<urxvt::timer> Class
1938		2239
1939	This class implements timer watchers/events. Time is represented as a	2240	This class implements timer watchers/events. Time is represented as a
1940	fractional number of seconds since the epoch. Example:	2241	fractional number of seconds since the epoch. Example:
…		…
1944	->new	2245	->new
1945	->interval (1)	2246	->interval (1)
1946	->cb (sub {	2247	->cb (sub {
1947	$term->{overlay}->set (0, 0,	2248	$term->{overlay}->set (0, 0,
1948	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2249	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1949	});	2250	});
1950		2251
1951	=over 4	2252	=over 4
1952		2253
1953	=item $timer = new urxvt::timer	2254	=item $timer = new urxvt::timer
1954		2255
…		…
1957		2258
1958	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2259	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1959		2260
1960	Set the callback to be called when the timer triggers.	2261	Set the callback to be called when the timer triggers.
1961		2262
1962	=item $tstamp = $timer->at
1963
1964	Return the time this watcher will fire next.
1965
1966	=item $timer = $timer->set ($tstamp)	2263	=item $timer = $timer->set ($tstamp[, $interval])
1967		2264
1968	Set the time the event is generated to $tstamp.	2265	Set the time the event is generated to $tstamp (and optionally specifies a
		2266	new $interval).
1969		2267
1970	=item $timer = $timer->interval ($interval)	2268	=item $timer = $timer->interval ($interval)
1971		2269
1972	Normally (and when C<$interval> is C<0>), the timer will automatically	2270	By default (and when C<$interval> is C<0>), the timer will automatically
1973	stop after it has fired once. If C<$interval> is non-zero, then the timer	2271	stop after it has fired once. If C<$interval> is non-zero, then the timer
1974	is automatically rescheduled at the given intervals.	2272	is automatically rescheduled at the given intervals.
1975		2273
1976	=item $timer = $timer->start	2274	=item $timer = $timer->start
1977		2275
1978	Start the timer.	2276	Start the timer.
1979		2277
1980	=item $timer = $timer->start ($tstamp)	2278	=item $timer = $timer->start ($tstamp[, $interval])
1981		2279
1982	Set the event trigger time to C<$tstamp> and start the timer.	2280	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2281	also replaces the interval.
1983		2282
1984	=item $timer = $timer->after ($delay)	2283	=item $timer = $timer->after ($delay[, $interval])
1985		2284
1986	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2285	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1987		2286
1988	=item $timer = $timer->stop	2287	=item $timer = $timer->stop
1989		2288
…		…
1997		2296
1998	$term->{socket} = ...	2297	$term->{socket} = ...
1999	$term->{iow} = urxvt::iow	2298	$term->{iow} = urxvt::iow
2000	->new	2299	->new
2001	->fd (fileno $term->{socket})	2300	->fd (fileno $term->{socket})
2002	->events (urxvt::EVENT_READ)	2301	->events (urxvt::EV_READ)
2003	->start	2302	->start
2004	->cb (sub {	2303	->cb (sub {
2005	my ($iow, $revents) = @_;	2304	my ($iow, $revents) = @_;
2006	# $revents must be 1 here, no need to check	2305	# $revents must be 1 here, no need to check
2007	sysread $term->{socket}, my $buf, 8192	2306	sysread $term->{socket}, my $buf, 8192
…		…
2025	Set the file descriptor (not handle) to watch.	2324	Set the file descriptor (not handle) to watch.
2026		2325
2027	=item $iow = $iow->events ($eventmask)	2326	=item $iow = $iow->events ($eventmask)
2028		2327
2029	Set the event mask to watch. The only allowed values are	2328	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	2329	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2031	together, or C<urxvt::EVENT_NONE>.	2330	together, or C<urxvt::EV_NONE>.
2032		2331
2033	=item $iow = $iow->start	2332	=item $iow = $iow->start
2034		2333
2035	Start watching for requested events on the given handle.	2334	Start watching for requested events on the given handle.
2036		2335
…		…
2077	->new	2376	->new
2078	->start ($pid)	2377	->start ($pid)
2079	->cb (sub {	2378	->cb (sub {
2080	my ($pw, $exit_status) = @_;	2379	my ($pw, $exit_status) = @_;
2081	...	2380	...
2082	});	2381	});
2083		2382
2084	=over 4	2383	=over 4
2085		2384
2086	=item $pw = new urxvt::pw	2385	=item $pw = new urxvt::pw
2087		2386
…		…
2120		2419
2121	=back	2420	=back
2122		2421
2123	=head1 AUTHOR	2422	=head1 AUTHOR
2124		2423
2125	Marc Lehmann <pcg@goof.com>	2424	Marc Lehmann <schmorp@schmorp.de>
2126	http://software.schmorp.de/pkg/rxvt-unicode	2425	http://software.schmorp.de/pkg/rxvt-unicode
2127		2426
2128	=cut	2427	=cut
2129		2428
2130	1	2429	1
		2430
		2431	# 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.216 by root, Sun Jun 10 13:32:55 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.216 by root, Sun Jun 10 13:32:55 2012 UTC