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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.151 by root, Thu Dec 14 17:22:04 2006 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 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
…		…
256	The default pattern to match URLs can be overridden with the	259	The default pattern to match URLs can be overridden with the
257	C<matcher.pattern.0> resource, and additional patterns can be specified	260	C<matcher.pattern.0> resource, and additional patterns can be specified
258	with numbered patterns, in a manner similar to the "selection" extension.	261	with numbered patterns, in a manner similar to the "selection" extension.
259	The launcher can also be overridden on a per-pattern basis.	262	The launcher can also be overridden on a per-pattern basis.
260		263
		264	It is possible to activate the most recently seen match from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
261	Example configuration:	267	Example configuration:
262		268
263	URxvt.perl-ext: default,matcher	269	URxvt.perl-ext: default,matcher
264	URxvt.urlLauncher: sensible-browser	270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
265	URxvt.matcher.button: 1	272	URxvt.matcher.button: 1
266	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]	273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
267	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)	274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
268	URxvt.matcher.launcher.2: gvim +$2 $1	275	URxvt.matcher.launcher.2: gvim +$2 $1
269		276
270	=item xim-onthespot	277	=item xim-onthespot
271		278
272	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
273	not work perfectly, and some input methods don't seem to work well with	280	not work perfectly, and some input methods don't seem to work well with
274	OnTheSpot editing in general, but it seems to work at leats for SCIM and	281	OnTheSpot editing in general, but it seems to work at least for SCIM and
275	kinput2.	282	kinput2.
276		283
277	You enable it by specifying this extension and a preedit style of	284	You enable it by specifying this extension and a preedit style of
278	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
279		286
…		…
287	will show or hide itself. Another press of the accelerator key will hide	294	will show or hide itself. Another press of the accelerator key will hide
288	or show it again.	295	or show it again.
289		296
290	Initially, the window will not be shown when using this extension.	297	Initially, the window will not be shown when using this extension.
291		298
292	This is useful if you need a single terminal thats not using any desktop	299	This is useful if you need a single terminal that is not using any desktop
293	space most of the time but is quickly available at the press of a key.	300	space most of the time but is quickly available at the press of a key.
294		301
295	The accelerator key is grabbed regardless of any modifiers, so this	302	The accelerator key is grabbed regardless of any modifiers, so this
296	extension will actually grab a physical key just for this function.	303	extension will actually grab a physical key just for this function.
297		304
298	If you want a quake-like animation, tell your window manager to do so	305	If you want a quake-like animation, tell your window manager to do so
299	(fvwm can do it).	306	(fvwm can do it).
300		307
301	=item automove-background	308	=item overlay-osc
302		309
303	This is basically a very small extension that dynamically changes the	310	This extension implements some OSC commands to display timed popups on the
304	background pixmap offset to the window position, in effect creating the	311	screen - useful for status displays from within scripts. You have to read
305	same effect as pseudo transparency with a custom pixmap. No scaling is	312	the sources for more info.
306	supported in this mode. Example:
307
308	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
309		313
310	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
311		315
312	A not very useful example of filtering all text output to the terminal	316	A not very useful example of filtering all text output to the terminal
313	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
318	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
319		323
320	=item remote-clipboard	324	=item remote-clipboard
321		325
322	Somewhat of a misnomer, this extension adds two menu entries to the	326	Somewhat of a misnomer, this extension adds two menu entries to the
323	selection popup that allows one ti run external commands to store the	327	selection popup that allows one to run external commands to store the
324	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
325		329
326	We use it to implement a "distributed selection mechanism", which just	330	We use it to implement a "distributed selection mechanism", which just
327	means that one command uploads the file to a remote server, and another	331	means that one command uploads the file to a remote server, and another
328	reads it.	332	reads it.
…		…
337	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
338	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
339		343
340	=item selection-pastebin	344	=item selection-pastebin
341		345
342	This is a little rarely useful extension that Uploads the selection as	346	This is a little rarely useful extension that uploads the selection as
343	textfile to a remote site (or does other things). (The implementation is	347	textfile to a remote site (or does other things). (The implementation is
344	not currently secure for use in a multiuser environment as it writes to	348	not currently secure for use in a multiuser environment as it writes to
345	F</tmp> directly.).	349	F</tmp> directly.).
346		350
347	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
366		370
367	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
368		372
369	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
370	the double C</> characters as comment start. Use C<\057\057> instead,	374	the double C</> characters as comment start. Use C<\057\057> instead,
371	which works regardless of wether xrdb is used to parse the resource file	375	which works regardless of whether xrdb is used to parse the resource file
372	or not.	376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
373		391
374	=item example-refresh-hooks	392	=item example-refresh-hooks
375		393
376	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
377	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
378	overlays or changes.	396	overlays or changes.
		397
		398	=item confirm-paste
		399
		400	Displays a confirmation dialog when a paste containing at least a full
		401	line is detected.
379		402
380	=back	403	=back
381		404
382	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
383		406
…		…
399		422
400	=over 4	423	=over 4
401		424
402	=item $text	425	=item $text
403		426
404	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
405	always represents one screen cell. See L<ROW_t> for a discussion of this format.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
406		429
407	=item $string	430	=item $string
408		431
409	A perl text string, with an emphasis on I<text>. It can store all unicode	432	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
543		566
544	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	567	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
545	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	568	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
546	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
547		570
548	=item on_osc_seq $term, $op, $args	571	=item on_osc_seq $term, $op, $args, $resp
549		572
550	Called on every OSC sequence and can be used to suppress it or modify its	573	Called on every OSC sequence and can be used to suppress it or modify its
551	behaviour. The default should be to return an empty list. A true value	574	behaviour. The default should be to return an empty list. A true value
552	suppresses execution of the request completely. Make sure you don't get	575	suppresses execution of the request completely. Make sure you don't get
553	confused by recursive invocations when you output an osc sequence within	576	confused by recursive invocations when you output an OSC sequence within
554	this callback.	577	this callback.
555		578
556	C<on_osc_seq_perl> should be used for new behaviour.	579	C<on_osc_seq_perl> should be used for new behaviour.
557		580
558	=item on_osc_seq_perl $term, $string	581	=item on_osc_seq_perl $term, $args, $resp
559		582
560	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
561	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
562	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
563	string should start with the extension name and a colon, to distinguish	586	string should start with the extension name (sans -osc) and a semicolon,
564	it from commands for other extensions, and this might be enforced in the	587	to distinguish it from commands for other extensions, and this might be
565	future.	588	enforced in the future.
		589
		590	For example, C<overlay-osc> uses this:
		591
		592	sub on_osc_seq_perl {
		593	my ($self, $osc, $resp) = @_;
		594
		595	return unless $osc =~ s/^overlay;//;
		596
		597	... process remaining $osc string
		598	}
566		599
567	Be careful not ever to trust (in a security sense) the data you receive,	600	Be careful not ever to trust (in a security sense) the data you receive,
568	as its source can not easily be controlled (e-mail content, messages from	601	as its source can not easily be controlled (e-mail content, messages from
569	other users on the same system etc.).	602	other users on the same system etc.).
		603
		604	For responses, C<$resp> contains the end-of-args separator used by the
		605	sender.
570		606
571	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
572		608
573	Called whenever text is about to be output, with the text as argument. You	609	Called whenever text is about to be output, with the text as argument. You
574	can filter/change and output the text yourself by returning a true value	610	can filter/change and output the text yourself by returning a true value
…		…
579	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
580		616
581	Called whenever some data is written to the tty/pty and can be used to	617	Called whenever some data is written to the tty/pty and can be used to
582	suppress or filter tty input.	618	suppress or filter tty input.
583		619
		620	=item on_tt_paste $term, $octets
		621
		622	Called whenever text is about to be pasted, with the text as argument. You
		623	can filter/change and paste the text yourself by returning a true value
		624	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		625	locale-encoded.
		626
584	=item on_line_update $term, $row	627	=item on_line_update $term, $row
585		628
586	Called whenever a line was updated or changed. Can be used to filter	629	Called whenever a line was updated or changed. Can be used to filter
587	screen output (e.g. underline urls or other useless stuff). Only lines	630	screen output (e.g. underline urls or other useless stuff). Only lines
588	that are being shown will be filtered, and, due to performance reasons,	631	that are being shown will be filtered, and, due to performance reasons,
…		…
595	later with the already-modified line (e.g. if unrelated parts change), so	638	later with the already-modified line (e.g. if unrelated parts change), so
596	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
597		640
598	=item on_refresh_begin $term	641	=item on_refresh_begin $term
599		642
600	Called just before the screen gets redrawn. Can be used for overlay	643	Called just before the screen gets redrawn. Can be used for overlay or
601	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
602	restoring them in refresh_end. The built-in overlay and selection display	645	restoring them in refresh_end. The built-in overlay and selection display
603	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
604		647
605	=item on_refresh_end $term	648	=item on_refresh_end $term
606		649
…		…
613	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
614		657
615	The event is simply the action string. This interface is assumed to change	658	The event is simply the action string. This interface is assumed to change
616	slightly in the future.	659	slightly in the future.
617		660
618	=item on_resize_all_windows $tern, $new_width, $new_height	661	=item on_resize_all_windows $term, $new_width, $new_height
619		662
620	Called just after the new window size has been calculated, but before	663	Called just after the new window size has been calculated, but before
621	windows are actually being resized or hints are being set. If this hook	664	windows are actually being resized or hints are being set. If this hook
622	returns TRUE, setting of the window hints is being skipped.	665	returns TRUE, setting of the window hints is being skipped.
623		666
…		…
657		700
658	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
659		702
660	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
661		704
662	Called whenever the corresponding X event is received for the terminal If	705	Called whenever the corresponding X event is received for the terminal. If
663	the hook returns true, then the even will be ignored by rxvt-unicode.	706	the hook returns true, then the event will be ignored by rxvt-unicode.
664		707
665	The event is a hash with most values as named by Xlib (see the XEvent	708	The event is a hash with most values as named by Xlib (see the XEvent
666	manpage), with the additional members C<row> and C<col>, which are the	709	manpage), with the additional members C<row> and C<col>, which are the
667	(real, not screen-based) row and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
668		711
…		…
677		720
678	=item on_wm_delete_window $term, $event	721	=item on_wm_delete_window $term, $event
679		722
680	Called when various types of ClientMessage events are received (all with	723	Called when various types of ClientMessage events are received (all with
681	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		725
		726	=item on_bell $term
		727
		728	Called on receipt of a bell character.
682		729
683	=back	730	=back
684		731
685	=cut	732	=cut
686		733
…		…
824		871
825	=item $rend = urxvt::OVERLAY_RSTYLE	872	=item $rend = urxvt::OVERLAY_RSTYLE
826		873
827	Return the rendition mask used for overlays by default.	874	Return the rendition mask used for overlays by default.
828		875
829	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	876	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		877	urxvt::RS_RVid, urxvt::RS_Uline
830		878
831	Return the bit that enabled bold, italic, blink, reverse-video and	879	Return the bit that enabled bold, italic, blink, reverse-video and
832	underline, respectively. To enable such a style, just logically OR it into	880	underline, respectively. To enable such a style, just logically OR it into
833	the bitset.	881	the bitset.
834		882
…		…
917	local $TERM = shift;	965	local $TERM = shift;
918	my $htype = shift;	966	my $htype = shift;
919		967
920	if ($htype == 0) { # INIT	968	if ($htype == 0) { # INIT
921	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	969	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
922		970
923	my %ext_arg;	971	my %ext_arg;
924		972
925	{	973	{
926	my @init = @TERM_INIT;	974	my @init = @TERM_INIT;
927	@TERM_INIT = ();	975	@TERM_INIT = ();
…		…
990		1038
991	sub SET_COLOR($$$) {	1039	sub SET_COLOR($$$) {
992	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1040	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
993	}	1041	}
994		1042
		1043	sub rend2mask {
		1044	no strict 'refs';
		1045	my ($str, $mask) = (@_, 0);
		1046	my %color = ( fg => undef, bg => undef );
		1047	my @failed;
		1048	for my $spec ( split /\s+/, $str ) {
		1049	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1050	$color{lc($1)} = $2;
		1051	} else {
		1052	my $neg = $spec =~ s/^[-^]//;
		1053	unless ( exists &{"RS_$spec"} ) {
		1054	push @failed, $spec;
		1055	next;
		1056	}
		1057	my $cur = &{"RS_$spec"};
		1058	if ( $neg ) {
		1059	$mask &= ~$cur;
		1060	} else {
		1061	$mask \|= $cur;
		1062	}
		1063	}
		1064	}
		1065	($mask, @color{qw(fg bg)}, \@failed)
		1066	}
		1067
995	# urxvt::term::extension	1068	# urxvt::term::extension
996		1069
997	package urxvt::term::extension;	1070	package urxvt::term::extension;
998		1071
999	sub enable {	1072	sub enable {
…		…
1068	is that you cannot use blocking APIs, but the non-blocking variant should	1141	is that you cannot use blocking APIs, but the non-blocking variant should
1069	work.	1142	work.
1070		1143
1071	=cut	1144	=cut
1072		1145
1073	our $VERSION = 1;	1146	our $VERSION = '5.23';
1074		1147
1075	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1148	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1076	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1149	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1077		1150
1078	sub timer {	1151	sub timer {
…		…
1080		1153
1081	my $cb = $arg{cb};	1154	my $cb = $arg{cb};
1082		1155
1083	urxvt::timer	1156	urxvt::timer
1084	->new	1157	->new
1085	->start (urxvt::NOW + $arg{after})	1158	->after ($arg{after}, $arg{interval})
1086	->cb (sub {	1159	->cb ($arg{interval} ? $cb : sub {
1087	$_[0]->stop; # need to cancel manually	1160	$_[0]->stop; # need to cancel manually
1088	$cb->();	1161	$cb->();
1089	})	1162	})
1090	}	1163	}
1091		1164
1092	sub io {	1165	sub io {
1093	my ($class, %arg) = @_;	1166	my ($class, %arg) = @_;
1094		1167
1095	my $cb = $arg{cb};	1168	my $cb = $arg{cb};
		1169	my $fd = fileno $arg{fh};
		1170	defined $fd or $fd = $arg{fh};
1096		1171
1097	bless [$arg{fh}, urxvt::iow	1172	bless [$arg{fh}, urxvt::iow
1098	->new	1173	->new
1099	->fd (fileno $arg{fh})	1174	->fd ($fd)
1100	->events (($arg{poll} =~ /r/ ? 1 : 0)	1175	->events (($arg{poll} =~ /r/ ? 1 : 0)
1101	\| ($arg{poll} =~ /w/ ? 2 : 0))	1176	\| ($arg{poll} =~ /w/ ? 2 : 0))
1102	->start	1177	->start
1103	->cb (sub {	1178	->cb ($cb)
1104	$cb->(($_[1] & 1 ? 'r' : '')
1105	. ($_[1] & 2 ? 'w' : ''));
1106	})],
1107	urxvt::anyevent::	1179	], urxvt::anyevent::
		1180	}
		1181
		1182	sub idle {
		1183	my ($class, %arg) = @_;
		1184
		1185	my $cb = $arg{cb};
		1186
		1187	urxvt::iw
		1188	->new
		1189	->start
		1190	->cb ($cb)
		1191	}
		1192
		1193	sub child {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::pw
		1199	->new
		1200	->start ($arg{pid})
		1201	->cb (sub {
		1202	$_[0]->stop; # need to cancel manually
		1203	$cb->($_[0]->rpid, $_[0]->rstatus);
		1204	})
1108	}	1205	}
1109		1206
1110	sub DESTROY {	1207	sub DESTROY {
1111	$_[0][1]->stop;	1208	$_[0][1]->stop;
1112	}
1113
1114	sub condvar {
1115	bless \my $flag, urxvt::anyevent::
1116	}
1117
1118	sub broadcast {
1119	${$_[0]}++;
1120	}
1121
1122	sub wait {
1123	unless (${$_[0]}) {
1124	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1125	}
1126	}	1209	}
1127		1210
1128	sub one_event {	1211	sub one_event {
1129	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1212	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1130	}	1213	}
…		…
1253	Here is a likely non-exhaustive list of resource names, not all of which	1336	Here is a likely non-exhaustive list of resource names, not all of which
1254	are supported in every build, please see the source file F</src/rsinc.h>	1337	are supported in every build, please see the source file F</src/rsinc.h>
1255	to see the actual list:	1338	to see the actual list:
1256		1339
1257	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1340	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1258	borderLess color cursorBlink cursorUnderline cutchars delete_key	1341	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1259	display_name embed ext_bwidth fade font geometry hold iconName	1342	display_name embed ext_bwidth fade font geometry hold iconName
1260	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1343	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1261	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1344	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1262	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1345	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1263	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1346	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1264	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1347	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1265	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1348	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1266	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1349	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1267	secondaryScreen secondaryScroll selectstyle shade term_name title	1350	secondaryScreen secondaryScroll shade term_name title
1268	transient_for transparent transparent_all tripleclickwords utmpInhibit	1351	transient_for transparent transparent_all tripleclickwords utmpInhibit
1269	visualBell	1352	visualBell
1270		1353
1271	=cut	1354	=cut
1272		1355
1273	sub resource($$;$) {	1356	sub resource($$;$) {
1274	my ($self, $name) = (shift, shift);	1357	my ($self, $name) = (shift, shift);
1275	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1358	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1276	&urxvt::term::_resource	1359	goto &urxvt::term::_resource
1277	}	1360	}
1278		1361
1279	=item $value = $term->x_resource ($pattern)	1362	=item $value = $term->x_resource ($pattern)
1280		1363
1281	Returns the X-Resource for the given pattern, excluding the program or	1364	Returns the X-Resource for the given pattern, excluding the program or
…		…
1306		1389
1307	=item ($row, $col) = $term->selection_beg ([$row, $col])	1390	=item ($row, $col) = $term->selection_beg ([$row, $col])
1308		1391
1309	=item ($row, $col) = $term->selection_end ([$row, $col])	1392	=item ($row, $col) = $term->selection_end ([$row, $col])
1310		1393
1311	Return the current values of the selection mark, begin or end positions,	1394	Return the current values of the selection mark, begin or end positions.
1312	and optionally set them to new values.	1395
		1396	When arguments are given, then the selection coordinates are set to
		1397	C<$row> and C<$col>, and the selection screen is set to the current
		1398	screen.
		1399
		1400	=item $screen = $term->selection_screen ([$screen])
		1401
		1402	Returns the current selection screen, and then optionally sets it.
1313		1403
1314	=item $term->selection_make ($eventtime[, $rectangular])	1404	=item $term->selection_make ($eventtime[, $rectangular])
1315		1405
1316	Tries to make a selection as set by C<selection_beg> and	1406	Tries to make a selection as set by C<selection_beg> and
1317	C<selection_end>. If C<$rectangular> is true (default: false), a	1407	C<selection_end>. If C<$rectangular> is true (default: false), a
1318	rectangular selection will be made. This is the prefered function to make	1408	rectangular selection will be made. This is the preferred function to make
1319	a selection.	1409	a selection.
1320		1410
1321	=item $success = $term->selection_grab ($eventtime)	1411	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1322		1412
1323	Try to request the primary selection text from the server (for example, as	1413	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1414	true) selection from the server. The corresponding text can be set
1324	set by the next method). No visual feedback will be given. This function	1415	with the next method. No visual feedback will be given. This function
1325	is mostly useful from within C<on_sel_grab> hooks.	1416	is mostly useful from within C<on_sel_grab> hooks.
1326		1417
1327	=item $oldtext = $term->selection ([$newtext])	1418	=item $oldtext = $term->selection ([$newtext, $clipboard])
1328		1419
1329	Return the current selection text and optionally replace it by C<$newtext>.	1420	Return the current selection (clipboard if C<$clipboard> is true) text
		1421	and optionally replace it by C<$newtext>.
		1422
		1423	=item $term->selection_clear ([$clipboard])
		1424
		1425	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1330		1426
1331	=item $term->overlay_simple ($x, $y, $text)	1427	=item $term->overlay_simple ($x, $y, $text)
1332		1428
1333	Create a simple multi-line overlay box. See the next method for details.	1429	Create a simple multi-line overlay box. See the next method for details.
1334		1430
…		…
1364		1460
1365	The methods currently supported on C<urxvt::overlay> objects are:	1461	The methods currently supported on C<urxvt::overlay> objects are:
1366		1462
1367	=over 4	1463	=over 4
1368		1464
1369	=item $overlay->set ($x, $y, $text, $rend)	1465	=item $overlay->set ($x, $y, $text[, $rend])
1370		1466
1371	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1467	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1372	text in rxvt-unicode's special encoding and an array of rendition values	1468	text in rxvt-unicode's special encoding and an array of rendition values
1373	at a specific position inside the overlay.	1469	at a specific position inside the overlay.
		1470
		1471	If C<$rend> is missing, then the rendition will not be changed.
1374		1472
1375	=item $overlay->hide	1473	=item $overlay->hide
1376		1474
1377	If visible, hide the overlay, but do not destroy it.	1475	If visible, hide the overlay, but do not destroy it.
1378		1476
…		…
1460	locale-specific encoding of the terminal and can contain command sequences	1558	locale-specific encoding of the terminal and can contain command sequences
1461	(escape codes) that will be interpreted.	1559	(escape codes) that will be interpreted.
1462		1560
1463	=item $term->tt_write ($octets)	1561	=item $term->tt_write ($octets)
1464		1562
1465	Write the octets given in C<$data> to the tty (i.e. as program input). To	1563	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1466	pass characters instead of octets, you should convert your strings first	1564	pass characters instead of octets, you should convert your strings first
1467	to the locale-specific encoding using C<< $term->locale_encode >>.	1565	to the locale-specific encoding using C<< $term->locale_encode >>.
		1566
		1567	=item $term->tt_paste ($octets)
		1568
		1569	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1570	CR and bracketing the data with control sequences if bracketed paste mode
		1571	is set.
1468		1572
1469	=item $old_events = $term->pty_ev_events ([$new_events])	1573	=item $old_events = $term->pty_ev_events ([$new_events])
1470		1574
1471	Replaces the event mask of the pty watcher by the given event mask. Can	1575	Replaces the event mask of the pty watcher by the given event mask. Can
1472	be used to suppress input and output handling to the pty/tty. See the	1576	be used to suppress input and output handling to the pty/tty. See the
…		…
1588		1692
1589	Used after changing terminal contents to display them.	1693	Used after changing terminal contents to display them.
1590		1694
1591	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1695	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1592		1696
1593	Returns the text of the entire row with number C<$row_number>. Row C<0>	1697	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1594	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1698	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1595	terminal line. The scrollback buffer starts at line C<-1> and extends to
1596	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1699	terminal line. Nothing will be returned if a nonexistent line
1597	is requested.	1700	is requested.
1598		1701
1599	If C<$new_text> is specified, it will replace characters in the current	1702	If C<$new_text> is specified, it will replace characters in the current
1600	line, starting at column C<$start_col> (default C<0>), which is useful	1703	line, starting at column C<$start_col> (default C<0>), which is useful
1601	to replace only parts of a line. The font index in the rendition will	1704	to replace only parts of a line. The font index in the rendition will
1602	automatically be updated.	1705	automatically be updated.
1603		1706
1604	C<$text> is in a special encoding: tabs and wide characters that use more	1707	C<$text> is in a special encoding: tabs and wide characters that use more
1605	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1708	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1606	characters. Characters with combining characters and other characters that	1709	characters. Characters with combining characters and other characters that
1607	do not fit into the normal tetx encoding will be replaced with characters	1710	do not fit into the normal text encoding will be replaced with characters
1608	in the private use area.	1711	in the private use area.
1609		1712
1610	You have to obey this encoding when changing text. The advantage is	1713	You have to obey this encoding when changing text. The advantage is
1611	that C<substr> and similar functions work on screen cells and not on	1714	that C<substr> and similar functions work on screen cells and not on
1612	characters.	1715	characters.
…		…
1787	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1890	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1788	recent grab.	1891	recent grab.
1789		1892
1790	=item $term->ungrab	1893	=item $term->ungrab
1791		1894
1792	Calls XUngrab for the most recent grab. Is called automatically on	1895	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1793	evaluation errors, as it is better to lose the grab in the error case as	1896	evaluation errors, as it is better to lose the grab in the error case as
1794	the session.	1897	the session.
1795		1898
1796	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1899	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1797		1900
…		…
1799		1902
1800	=item @atoms = $term->XListProperties ($window)	1903	=item @atoms = $term->XListProperties ($window)
1801		1904
1802	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1905	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1803		1906
1804	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1907	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1805		1908
1806	=item $term->XDeleteProperty ($window, $property)	1909	=item $term->XDeleteProperty ($window, $property)
1807		1910
1808	=item $window = $term->DefaultRootWindow	1911	=item $window = $term->DefaultRootWindow
1809		1912
…		…
1819		1922
1820	=item $term->XChangeInput ($window, $add_events[, $del_events])	1923	=item $term->XChangeInput ($window, $add_events[, $del_events])
1821		1924
1822	Various X or X-related functions. The C<$term> object only serves as	1925	Various X or X-related functions. The C<$term> object only serves as
1823	the source of the display, otherwise those functions map more-or-less	1926	the source of the display, otherwise those functions map more-or-less
1824	directory onto the X functions of the same name.	1927	directly onto the X functions of the same name.
1825		1928
1826	=back	1929	=back
1827		1930
1828	=cut	1931	=cut
1829		1932
…		…
1931	my $env = $self->{term}->env;	2034	my $env = $self->{term}->env;
1932	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2035	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1933	delete $env->{LC_ALL};	2036	delete $env->{LC_ALL};
1934	$env->{LC_CTYPE} = $self->{term}->locale;	2037	$env->{LC_CTYPE} = $self->{term}->locale;
1935		2038
1936	urxvt::term->new ($env, "popup",	2039	my $term = urxvt::term->new (
		2040	$env, "popup",
1937	"--perl-lib" => "", "--perl-ext-common" => "",	2041	"--perl-lib" => "", "--perl-ext-common" => "",
1938	"-pty-fd" => -1, "-sl" => 0,	2042	"-pty-fd" => -1, "-sl" => 0,
1939	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2043	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1940	"--transient-for" => $self->{term}->parent,	2044	"--transient-for" => $self->{term}->parent,
1941	"-display" => $self->{term}->display_id,	2045	"-display" => $self->{term}->display_id,
1942	"-pe" => "urxvt-popup")	2046	"-pe" => "urxvt-popup",
1943	or die "unable to create popup window\n";	2047	) or die "unable to create popup window\n";
		2048
		2049	unless (delete $term->{urxvt_popup_init_done}) {
		2050	$term->ungrab;
		2051	$term->destroy;
		2052	die "unable to initialise popup window\n";
		2053	}
1944	}	2054	}
1945		2055
1946	sub DESTROY {	2056	sub DESTROY {
1947	my ($self) = @_;	2057	my ($self) = @_;
1948		2058
…		…
1966	->new	2076	->new
1967	->interval (1)	2077	->interval (1)
1968	->cb (sub {	2078	->cb (sub {
1969	$term->{overlay}->set (0, 0,	2079	$term->{overlay}->set (0, 0,
1970	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2080	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1971	});	2081	});
1972		2082
1973	=over 4	2083	=over 4
1974		2084
1975	=item $timer = new urxvt::timer	2085	=item $timer = new urxvt::timer
1976		2086
…		…
1979		2089
1980	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2090	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1981		2091
1982	Set the callback to be called when the timer triggers.	2092	Set the callback to be called when the timer triggers.
1983		2093
1984	=item $tstamp = $timer->at
1985
1986	Return the time this watcher will fire next.
1987
1988	=item $timer = $timer->set ($tstamp)	2094	=item $timer = $timer->set ($tstamp[, $interval])
1989		2095
1990	Set the time the event is generated to $tstamp.	2096	Set the time the event is generated to $tstamp (and optionally specifies a
		2097	new $interval).
1991		2098
1992	=item $timer = $timer->interval ($interval)	2099	=item $timer = $timer->interval ($interval)
1993		2100
1994	Normally (and when C<$interval> is C<0>), the timer will automatically	2101	By default (and when C<$interval> is C<0>), the timer will automatically
1995	stop after it has fired once. If C<$interval> is non-zero, then the timer	2102	stop after it has fired once. If C<$interval> is non-zero, then the timer
1996	is automatically rescheduled at the given intervals.	2103	is automatically rescheduled at the given intervals.
1997		2104
1998	=item $timer = $timer->start	2105	=item $timer = $timer->start
1999		2106
2000	Start the timer.	2107	Start the timer.
2001		2108
2002	=item $timer = $timer->start ($tstamp)	2109	=item $timer = $timer->start ($tstamp[, $interval])
2003		2110
2004	Set the event trigger time to C<$tstamp> and start the timer.	2111	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2112	also replaces the interval.
2005		2113
2006	=item $timer = $timer->after ($delay)	2114	=item $timer = $timer->after ($delay[, $interval])
2007		2115
2008	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2116	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2009		2117
2010	=item $timer = $timer->stop	2118	=item $timer = $timer->stop
2011		2119
…		…
2019		2127
2020	$term->{socket} = ...	2128	$term->{socket} = ...
2021	$term->{iow} = urxvt::iow	2129	$term->{iow} = urxvt::iow
2022	->new	2130	->new
2023	->fd (fileno $term->{socket})	2131	->fd (fileno $term->{socket})
2024	->events (urxvt::EVENT_READ)	2132	->events (urxvt::EV_READ)
2025	->start	2133	->start
2026	->cb (sub {	2134	->cb (sub {
2027	my ($iow, $revents) = @_;	2135	my ($iow, $revents) = @_;
2028	# $revents must be 1 here, no need to check	2136	# $revents must be 1 here, no need to check
2029	sysread $term->{socket}, my $buf, 8192	2137	sysread $term->{socket}, my $buf, 8192
…		…
2047	Set the file descriptor (not handle) to watch.	2155	Set the file descriptor (not handle) to watch.
2048		2156
2049	=item $iow = $iow->events ($eventmask)	2157	=item $iow = $iow->events ($eventmask)
2050		2158
2051	Set the event mask to watch. The only allowed values are	2159	Set the event mask to watch. The only allowed values are
2052	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2160	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2053	together, or C<urxvt::EVENT_NONE>.	2161	together, or C<urxvt::EV_NONE>.
2054		2162
2055	=item $iow = $iow->start	2163	=item $iow = $iow->start
2056		2164
2057	Start watching for requested events on the given handle.	2165	Start watching for requested events on the given handle.
2058		2166
…		…
2099	->new	2207	->new
2100	->start ($pid)	2208	->start ($pid)
2101	->cb (sub {	2209	->cb (sub {
2102	my ($pw, $exit_status) = @_;	2210	my ($pw, $exit_status) = @_;
2103	...	2211	...
2104	});	2212	});
2105		2213
2106	=over 4	2214	=over 4
2107		2215
2108	=item $pw = new urxvt::pw	2216	=item $pw = new urxvt::pw
2109		2217
…		…
2148	http://software.schmorp.de/pkg/rxvt-unicode	2256	http://software.schmorp.de/pkg/rxvt-unicode
2149		2257
2150	=cut	2258	=cut
2151		2259
2152	1	2260	1
		2261
		2262	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.151 by root, Thu Dec 14 17:22:04 2006 UTC vs. Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.151 by root, Thu Dec 14 17:22:04 2006 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC