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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.153 by root, Sat Jun 2 05:23:11 2007 UTC vs.
Revision 1.186 by sf-exg, Fri Jul 23 17:50:41 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
265	URxvt.keysym.C-Delete: perl:matcher	271	URxvt.keysym.C-Delete: perl:matcher
…		…
270		276
271	=item xim-onthespot	277	=item xim-onthespot
272		278
273	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
274	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
275	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
276	kinput2.	282	kinput2.
277		283
278	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
279	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
280		286
…		…
288	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
289	or show it again.	295	or show it again.
290		296
291	Initially, the window will not be shown when using this extension.	297	Initially, the window will not be shown when using this extension.
292		298
293	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
294	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.
295		301
296	The accelerator key is grabbed regardless of any modifiers, so this	302	The accelerator key is grabbed regardless of any modifiers, so this
297	extension will actually grab a physical key just for this function.	303	extension will actually grab a physical key just for this function.
298		304
299	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
300	(fvwm can do it).	306	(fvwm can do it).
301		307
302	=item automove-background	308	=item overlay-osc
303		309
304	This is basically a very small extension that dynamically changes the	310	This extension implements some OSC commands to display timed popups on the
305	background pixmap offset to the window position, in effect creating the	311	screen - useful for status displays from within scripts. You have to read
306	same effect as pseudo transparency with a custom pixmap. No scaling is	312	the sources for more info.
307	supported in this mode. Example:
308
309	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
310
311	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
312	shows how this extension can be used to implement an automatically blurred
313	transparent background.
314		313
315	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
316		315
317	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
318	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
…		…
323	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
324		323
325	=item remote-clipboard	324	=item remote-clipboard
326		325
327	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
328	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
329	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
330		329
331	We use it to implement a "distributed selection mechanism", which just	330	We use it to implement a "distributed selection mechanism", which just
332	means that one command uploads the file to a remote server, and another	331	means that one command uploads the file to a remote server, and another
333	reads it.	332	reads it.
…		…
342	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
343	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
344		343
345	=item selection-pastebin	344	=item selection-pastebin
346		345
347	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
348	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
349	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
350	F</tmp> directly.).	349	F</tmp> directly.).
351		350
352	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
371		370
372	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
373		372
374	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
375	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,
376	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
377	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.
378		391
379	=item example-refresh-hooks	392	=item example-refresh-hooks
380		393
381	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
382	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
404		417
405	=over 4	418	=over 4
406		419
407	=item $text	420	=item $text
408		421
409	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
410	always represents one screen cell. See L<ROW_t> for a discussion of this format.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
411		424
412	=item $string	425	=item $string
413		426
414	A perl text string, with an emphasis on I<text>. It can store all unicode	427	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
548		561
549	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
550	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
551	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
552		565
553	=item on_osc_seq $term, $op, $args	566	=item on_osc_seq $term, $op, $args, $resp
554		567
555	Called on every OSC sequence and can be used to suppress it or modify its	568	Called on every OSC sequence and can be used to suppress it or modify its
556	behaviour. The default should be to return an empty list. A true value	569	behaviour. The default should be to return an empty list. A true value
557	suppresses execution of the request completely. Make sure you don't get	570	suppresses execution of the request completely. Make sure you don't get
558	confused by recursive invocations when you output an osc sequence within	571	confused by recursive invocations when you output an OSC sequence within
559	this callback.	572	this callback.
560		573
561	C<on_osc_seq_perl> should be used for new behaviour.	574	C<on_osc_seq_perl> should be used for new behaviour.
562		575
563	=item on_osc_seq_perl $term, $string	576	=item on_osc_seq_perl $term, $args, $resp
564		577
565	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
566	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
567	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
568	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
569	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
570	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
571		594
572	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
573	as its source can not easily be controlled (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
574	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
575		601
576	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
577		603
578	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
579	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
…		…
600	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
601	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
602		628
603	=item on_refresh_begin $term	629	=item on_refresh_begin $term
604		630
605	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
606	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
607	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
608	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
609		635
610	=item on_refresh_end $term	636	=item on_refresh_end $term
611		637
…		…
618	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
619		645
620	The event is simply the action string. This interface is assumed to change	646	The event is simply the action string. This interface is assumed to change
621	slightly in the future.	647	slightly in the future.
622		648
623	=item on_resize_all_windows $tern, $new_width, $new_height	649	=item on_resize_all_windows $term, $new_width, $new_height
624		650
625	Called just after the new window size has been calculated, but before	651	Called just after the new window size has been calculated, but before
626	windows are actually being resized or hints are being set. If this hook	652	windows are actually being resized or hints are being set. If this hook
627	returns TRUE, setting of the window hints is being skipped.	653	returns TRUE, setting of the window hints is being skipped.
628		654
…		…
662		688
663	=item on_map_notify $term, $event	689	=item on_map_notify $term, $event
664		690
665	=item on_unmap_notify $term, $event	691	=item on_unmap_notify $term, $event
666		692
667	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal. If
668	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the event will be ignored by rxvt-unicode.
669		695
670	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
671	manpage), with the additional members C<row> and C<col>, which are the	697	manpage), with the additional members C<row> and C<col>, which are the
672	(real, not screen-based) row and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
673		699
…		…
682		708
683	=item on_wm_delete_window $term, $event	709	=item on_wm_delete_window $term, $event
684		710
685	Called when various types of ClientMessage events are received (all with	711	Called when various types of ClientMessage events are received (all with
686	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		713
		714	=item on_bell $term
		715
		716	Called on receipt of a bell character.
687		717
688	=back	718	=back
689		719
690	=cut	720	=cut
691		721
…		…
922	local $TERM = shift;	952	local $TERM = shift;
923	my $htype = shift;	953	my $htype = shift;
924		954
925	if ($htype == 0) { # INIT	955	if ($htype == 0) { # INIT
926	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	956	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
927		957
928	my %ext_arg;	958	my %ext_arg;
929		959
930	{	960	{
931	my @init = @TERM_INIT;	961	my @init = @TERM_INIT;
932	@TERM_INIT = ();	962	@TERM_INIT = ();
…		…
1098	is that you cannot use blocking APIs, but the non-blocking variant should	1128	is that you cannot use blocking APIs, but the non-blocking variant should
1099	work.	1129	work.
1100		1130
1101	=cut	1131	=cut
1102		1132
1103	our $VERSION = 1;	1133	our $VERSION = '5.23';
1104		1134
1105	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1135	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1106	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1136	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1107		1137
1108	sub timer {	1138	sub timer {
…		…
1110		1140
1111	my $cb = $arg{cb};	1141	my $cb = $arg{cb};
1112		1142
1113	urxvt::timer	1143	urxvt::timer
1114	->new	1144	->new
1115	->start (urxvt::NOW + $arg{after})	1145	->after ($arg{after}, $arg{interval})
1116	->cb (sub {	1146	->cb ($arg{interval} ? $cb : sub {
1117	$_[0]->stop; # need to cancel manually	1147	$_[0]->stop; # need to cancel manually
1118	$cb->();	1148	$cb->();
1119	})	1149	})
1120	}	1150	}
1121		1151
1122	sub io {	1152	sub io {
1123	my ($class, %arg) = @_;	1153	my ($class, %arg) = @_;
1124		1154
1125	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
		1156	my $fd = fileno $arg{fh};
		1157	defined $fd or $fd = $arg{fh};
1126		1158
1127	bless [$arg{fh}, urxvt::iow	1159	bless [$arg{fh}, urxvt::iow
1128	->new	1160	->new
1129	->fd (fileno $arg{fh})	1161	->fd ($fd)
1130	->events (($arg{poll} =~ /r/ ? 1 : 0)	1162	->events (($arg{poll} =~ /r/ ? 1 : 0)
1131	\| ($arg{poll} =~ /w/ ? 2 : 0))	1163	\| ($arg{poll} =~ /w/ ? 2 : 0))
1132	->start	1164	->start
1133	->cb (sub {	1165	->cb ($cb)
1134	$cb->(($_[1] & 1 ? 'r' : '')
1135	. ($_[1] & 2 ? 'w' : ''));
1136	})],
1137	urxvt::anyevent::	1166	], urxvt::anyevent::
		1167	}
		1168
		1169	sub idle {
		1170	my ($class, %arg) = @_;
		1171
		1172	my $cb = $arg{cb};
		1173
		1174	urxvt::iw
		1175	->new
		1176	->start
		1177	->cb ($cb)
		1178	}
		1179
		1180	sub child {
		1181	my ($class, %arg) = @_;
		1182
		1183	my $cb = $arg{cb};
		1184
		1185	urxvt::pw
		1186	->new
		1187	->start ($arg{pid})
		1188	->cb (sub {
		1189	$_[0]->stop; # need to cancel manually
		1190	$cb->($_[0]->rpid, $_[0]->rstatus);
		1191	})
1138	}	1192	}
1139		1193
1140	sub DESTROY {	1194	sub DESTROY {
1141	$_[0][1]->stop;	1195	$_[0][1]->stop;
1142	}
1143
1144	sub condvar {
1145	bless \my $flag, urxvt::anyevent::
1146	}
1147
1148	sub broadcast {
1149	${$_[0]}++;
1150	}
1151
1152	sub wait {
1153	unless (${$_[0]}) {
1154	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1155	}
1156	}	1196	}
1157		1197
1158	sub one_event {	1198	sub one_event {
1159	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1199	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1160	}	1200	}
…		…
1283	Here is a likely non-exhaustive list of resource names, not all of which	1323	Here is a likely non-exhaustive list of resource names, not all of which
1284	are supported in every build, please see the source file F</src/rsinc.h>	1324	are supported in every build, please see the source file F</src/rsinc.h>
1285	to see the actual list:	1325	to see the actual list:
1286		1326
1287	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1327	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1288	borderLess color cursorBlink cursorUnderline cutchars delete_key	1328	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1289	display_name embed ext_bwidth fade font geometry hold iconName	1329	display_name embed ext_bwidth fade font geometry hold iconName
1290	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1330	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1291	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1331	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1292	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1332	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1293	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1333	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1294	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1334	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1295	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1335	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1296	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1336	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1297	secondaryScreen secondaryScroll selectstyle shade term_name title	1337	secondaryScreen secondaryScroll shade term_name title
1298	transient_for transparent transparent_all tripleclickwords utmpInhibit	1338	transient_for transparent transparent_all tripleclickwords utmpInhibit
1299	visualBell	1339	visualBell
1300		1340
1301	=cut	1341	=cut
1302		1342
1303	sub resource($$;$) {	1343	sub resource($$;$) {
1304	my ($self, $name) = (shift, shift);	1344	my ($self, $name) = (shift, shift);
1305	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1345	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1306	&urxvt::term::_resource	1346	goto &urxvt::term::_resource
1307	}	1347	}
1308		1348
1309	=item $value = $term->x_resource ($pattern)	1349	=item $value = $term->x_resource ($pattern)
1310		1350
1311	Returns the X-Resource for the given pattern, excluding the program or	1351	Returns the X-Resource for the given pattern, excluding the program or
…		…
1336		1376
1337	=item ($row, $col) = $term->selection_beg ([$row, $col])	1377	=item ($row, $col) = $term->selection_beg ([$row, $col])
1338		1378
1339	=item ($row, $col) = $term->selection_end ([$row, $col])	1379	=item ($row, $col) = $term->selection_end ([$row, $col])
1340		1380
1341	Return the current values of the selection mark, begin or end positions,	1381	Return the current values of the selection mark, begin or end positions.
1342	and optionally set them to new values.	1382
		1383	When arguments are given, then the selection coordinates are set to
		1384	C<$row> and C<$col>, and the selection screen is set to the current
		1385	screen.
		1386
		1387	=item $screen = $term->selection_screen ([$screen])
		1388
		1389	Returns the current selection screen, and then optionally sets it.
1343		1390
1344	=item $term->selection_make ($eventtime[, $rectangular])	1391	=item $term->selection_make ($eventtime[, $rectangular])
1345		1392
1346	Tries to make a selection as set by C<selection_beg> and	1393	Tries to make a selection as set by C<selection_beg> and
1347	C<selection_end>. If C<$rectangular> is true (default: false), a	1394	C<selection_end>. If C<$rectangular> is true (default: false), a
1348	rectangular selection will be made. This is the prefered function to make	1395	rectangular selection will be made. This is the preferred function to make
1349	a selection.	1396	a selection.
1350		1397
1351	=item $success = $term->selection_grab ($eventtime)	1398	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1352		1399
1353	Try to request the primary selection text from the server (for example, as	1400	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1401	true) selection from the server. The corresponding text can be set
1354	set by the next method). No visual feedback will be given. This function	1402	with the next method. No visual feedback will be given. This function
1355	is mostly useful from within C<on_sel_grab> hooks.	1403	is mostly useful from within C<on_sel_grab> hooks.
1356		1404
1357	=item $oldtext = $term->selection ([$newtext])	1405	=item $oldtext = $term->selection ([$newtext, $clipboard])
1358		1406
1359	Return the current selection text and optionally replace it by C<$newtext>.	1407	Return the current selection (clipboard if C<$clipboard> is true) text
		1408	and optionally replace it by C<$newtext>.
		1409
		1410	=item $term->selection_clear ([$clipboard])
		1411
		1412	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1360		1413
1361	=item $term->overlay_simple ($x, $y, $text)	1414	=item $term->overlay_simple ($x, $y, $text)
1362		1415
1363	Create a simple multi-line overlay box. See the next method for details.	1416	Create a simple multi-line overlay box. See the next method for details.
1364		1417
…		…
1394		1447
1395	The methods currently supported on C<urxvt::overlay> objects are:	1448	The methods currently supported on C<urxvt::overlay> objects are:
1396		1449
1397	=over 4	1450	=over 4
1398		1451
1399	=item $overlay->set ($x, $y, $text, $rend)	1452	=item $overlay->set ($x, $y, $text[, $rend])
1400		1453
1401	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1454	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1402	text in rxvt-unicode's special encoding and an array of rendition values	1455	text in rxvt-unicode's special encoding and an array of rendition values
1403	at a specific position inside the overlay.	1456	at a specific position inside the overlay.
		1457
		1458	If C<$rend> is missing, then the rendition will not be changed.
1404		1459
1405	=item $overlay->hide	1460	=item $overlay->hide
1406		1461
1407	If visible, hide the overlay, but do not destroy it.	1462	If visible, hide the overlay, but do not destroy it.
1408		1463
…		…
1490	locale-specific encoding of the terminal and can contain command sequences	1545	locale-specific encoding of the terminal and can contain command sequences
1491	(escape codes) that will be interpreted.	1546	(escape codes) that will be interpreted.
1492		1547
1493	=item $term->tt_write ($octets)	1548	=item $term->tt_write ($octets)
1494		1549
1495	Write the octets given in C<$data> to the tty (i.e. as program input). To	1550	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1496	pass characters instead of octets, you should convert your strings first	1551	pass characters instead of octets, you should convert your strings first
1497	to the locale-specific encoding using C<< $term->locale_encode >>.	1552	to the locale-specific encoding using C<< $term->locale_encode >>.
1498		1553
1499	=item $old_events = $term->pty_ev_events ([$new_events])	1554	=item $old_events = $term->pty_ev_events ([$new_events])
1500		1555
…		…
1618		1673
1619	Used after changing terminal contents to display them.	1674	Used after changing terminal contents to display them.
1620		1675
1621	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1676	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1622		1677
1623	Returns the text of the entire row with number C<$row_number>. Row C<0>	1678	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1624	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1679	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1625	terminal line. The scrollback buffer starts at line C<-1> and extends to
1626	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1680	terminal line. Nothing will be returned if a nonexistent line
1627	is requested.	1681	is requested.
1628		1682
1629	If C<$new_text> is specified, it will replace characters in the current	1683	If C<$new_text> is specified, it will replace characters in the current
1630	line, starting at column C<$start_col> (default C<0>), which is useful	1684	line, starting at column C<$start_col> (default C<0>), which is useful
1631	to replace only parts of a line. The font index in the rendition will	1685	to replace only parts of a line. The font index in the rendition will
1632	automatically be updated.	1686	automatically be updated.
1633		1687
1634	C<$text> is in a special encoding: tabs and wide characters that use more	1688	C<$text> is in a special encoding: tabs and wide characters that use more
1635	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1689	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1636	characters. Characters with combining characters and other characters that	1690	characters. Characters with combining characters and other characters that
1637	do not fit into the normal tetx encoding will be replaced with characters	1691	do not fit into the normal text encoding will be replaced with characters
1638	in the private use area.	1692	in the private use area.
1639		1693
1640	You have to obey this encoding when changing text. The advantage is	1694	You have to obey this encoding when changing text. The advantage is
1641	that C<substr> and similar functions work on screen cells and not on	1695	that C<substr> and similar functions work on screen cells and not on
1642	characters.	1696	characters.
…		…
1817	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1871	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1818	recent grab.	1872	recent grab.
1819		1873
1820	=item $term->ungrab	1874	=item $term->ungrab
1821		1875
1822	Calls XUngrab for the most recent grab. Is called automatically on	1876	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1823	evaluation errors, as it is better to lose the grab in the error case as	1877	evaluation errors, as it is better to lose the grab in the error case as
1824	the session.	1878	the session.
1825		1879
1826	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1880	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1827		1881
…		…
1829		1883
1830	=item @atoms = $term->XListProperties ($window)	1884	=item @atoms = $term->XListProperties ($window)
1831		1885
1832	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1886	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1833		1887
1834	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1888	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1835		1889
1836	=item $term->XDeleteProperty ($window, $property)	1890	=item $term->XDeleteProperty ($window, $property)
1837		1891
1838	=item $window = $term->DefaultRootWindow	1892	=item $window = $term->DefaultRootWindow
1839		1893
…		…
1849		1903
1850	=item $term->XChangeInput ($window, $add_events[, $del_events])	1904	=item $term->XChangeInput ($window, $add_events[, $del_events])
1851		1905
1852	Various X or X-related functions. The C<$term> object only serves as	1906	Various X or X-related functions. The C<$term> object only serves as
1853	the source of the display, otherwise those functions map more-or-less	1907	the source of the display, otherwise those functions map more-or-less
1854	directory onto the X functions of the same name.	1908	directly onto the X functions of the same name.
1855		1909
1856	=back	1910	=back
1857		1911
1858	=cut	1912	=cut
1859		1913
…		…
1961	my $env = $self->{term}->env;	2015	my $env = $self->{term}->env;
1962	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2016	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1963	delete $env->{LC_ALL};	2017	delete $env->{LC_ALL};
1964	$env->{LC_CTYPE} = $self->{term}->locale;	2018	$env->{LC_CTYPE} = $self->{term}->locale;
1965		2019
1966	urxvt::term->new ($env, "popup",	2020	my $term = urxvt::term->new (
		2021	$env, "popup",
1967	"--perl-lib" => "", "--perl-ext-common" => "",	2022	"--perl-lib" => "", "--perl-ext-common" => "",
1968	"-pty-fd" => -1, "-sl" => 0,	2023	"-pty-fd" => -1, "-sl" => 0,
1969	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2024	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1970	"--transient-for" => $self->{term}->parent,	2025	"--transient-for" => $self->{term}->parent,
1971	"-display" => $self->{term}->display_id,	2026	"-display" => $self->{term}->display_id,
1972	"-pe" => "urxvt-popup")	2027	"-pe" => "urxvt-popup",
1973	or die "unable to create popup window\n";	2028	) or die "unable to create popup window\n";
		2029
		2030	unless (delete $term->{urxvt_popup_init_done}) {
		2031	$term->ungrab;
		2032	$term->destroy;
		2033	die "unable to initialise popup window\n";
		2034	}
1974	}	2035	}
1975		2036
1976	sub DESTROY {	2037	sub DESTROY {
1977	my ($self) = @_;	2038	my ($self) = @_;
1978		2039
…		…
1996	->new	2057	->new
1997	->interval (1)	2058	->interval (1)
1998	->cb (sub {	2059	->cb (sub {
1999	$term->{overlay}->set (0, 0,	2060	$term->{overlay}->set (0, 0,
2000	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2061	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2001	});	2062	});
2002		2063
2003	=over 4	2064	=over 4
2004		2065
2005	=item $timer = new urxvt::timer	2066	=item $timer = new urxvt::timer
2006		2067
…		…
2009		2070
2010	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2071	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2011		2072
2012	Set the callback to be called when the timer triggers.	2073	Set the callback to be called when the timer triggers.
2013		2074
2014	=item $tstamp = $timer->at
2015
2016	Return the time this watcher will fire next.
2017
2018	=item $timer = $timer->set ($tstamp)	2075	=item $timer = $timer->set ($tstamp[, $interval])
2019		2076
2020	Set the time the event is generated to $tstamp.	2077	Set the time the event is generated to $tstamp (and optionally specifies a
		2078	new $interval).
2021		2079
2022	=item $timer = $timer->interval ($interval)	2080	=item $timer = $timer->interval ($interval)
2023		2081
2024	Normally (and when C<$interval> is C<0>), the timer will automatically	2082	By default (and when C<$interval> is C<0>), the timer will automatically
2025	stop after it has fired once. If C<$interval> is non-zero, then the timer	2083	stop after it has fired once. If C<$interval> is non-zero, then the timer
2026	is automatically rescheduled at the given intervals.	2084	is automatically rescheduled at the given intervals.
2027		2085
2028	=item $timer = $timer->start	2086	=item $timer = $timer->start
2029		2087
2030	Start the timer.	2088	Start the timer.
2031		2089
2032	=item $timer = $timer->start ($tstamp)	2090	=item $timer = $timer->start ($tstamp[, $interval])
2033		2091
2034	Set the event trigger time to C<$tstamp> and start the timer.	2092	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2093	also replaces the interval.
2035		2094
2036	=item $timer = $timer->after ($delay)	2095	=item $timer = $timer->after ($delay[, $interval])
2037		2096
2038	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2097	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2039		2098
2040	=item $timer = $timer->stop	2099	=item $timer = $timer->stop
2041		2100
…		…
2049		2108
2050	$term->{socket} = ...	2109	$term->{socket} = ...
2051	$term->{iow} = urxvt::iow	2110	$term->{iow} = urxvt::iow
2052	->new	2111	->new
2053	->fd (fileno $term->{socket})	2112	->fd (fileno $term->{socket})
2054	->events (urxvt::EVENT_READ)	2113	->events (urxvt::EV_READ)
2055	->start	2114	->start
2056	->cb (sub {	2115	->cb (sub {
2057	my ($iow, $revents) = @_;	2116	my ($iow, $revents) = @_;
2058	# $revents must be 1 here, no need to check	2117	# $revents must be 1 here, no need to check
2059	sysread $term->{socket}, my $buf, 8192	2118	sysread $term->{socket}, my $buf, 8192
…		…
2077	Set the file descriptor (not handle) to watch.	2136	Set the file descriptor (not handle) to watch.
2078		2137
2079	=item $iow = $iow->events ($eventmask)	2138	=item $iow = $iow->events ($eventmask)
2080		2139
2081	Set the event mask to watch. The only allowed values are	2140	Set the event mask to watch. The only allowed values are
2082	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2141	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2083	together, or C<urxvt::EVENT_NONE>.	2142	together, or C<urxvt::EV_NONE>.
2084		2143
2085	=item $iow = $iow->start	2144	=item $iow = $iow->start
2086		2145
2087	Start watching for requested events on the given handle.	2146	Start watching for requested events on the given handle.
2088		2147
…		…
2129	->new	2188	->new
2130	->start ($pid)	2189	->start ($pid)
2131	->cb (sub {	2190	->cb (sub {
2132	my ($pw, $exit_status) = @_;	2191	my ($pw, $exit_status) = @_;
2133	...	2192	...
2134	});	2193	});
2135		2194
2136	=over 4	2195	=over 4
2137		2196
2138	=item $pw = new urxvt::pw	2197	=item $pw = new urxvt::pw
2139		2198

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.153 by root, Sat Jun 2 05:23:11 2007 UTC vs. Revision 1.186 by sf-exg, Fri Jul 23 17:50:41 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.153 by root, Sat Jun 2 05:23:11 2007 UTC vs.
Revision 1.186 by sf-exg, Fri Jul 23 17:50:41 2010 UTC