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

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

…		…
40		40
41	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
42		42
43	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:
44		44
45	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
46		46
47	=over 4	47	=over 4
48		48
49	=item selection (enabled by default)	49	=item selection (enabled by default)
50		50
…		…
101		101
102	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
103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the	103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104	popup is being displayed.	104	popup is being displayed.
105		105
106	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
107	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
108	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
109	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
110	first argument.	110	first argument.
111		111
112	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
113	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
114		114
115	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117	};	117	};
118		118
…		…
124		124
125	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
126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127	popup is being displayed.	127	popup is being displayed.
128		128
129	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
130	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.
131	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
132	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
133	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
134		134
135	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
136	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
137	C<a>s:	137	C<a>s:
138		138
139	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
140	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
141	: ()	141	: ()
142	};	142	};
143		143
144	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
145		145
…		…
152	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>
153	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
154	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
155	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
156	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
157	selection.	157	selection if the C<Shift> modifier is active.
158		158
159	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
160	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>
161	or simply use an uppercase character which removes the "(?i)" prefix.	161	or simply use an uppercase character which removes the "(?i)" prefix.
162		162
…		…
165	=item readline (enabled by default)	165	=item readline (enabled by default)
166		166
167	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
168	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
169	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
170	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
171	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
172		172
173	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
174		174
175	=over 4	175	=over 4
…		…
259	The default pattern to match URLs can be overridden with the	259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified	260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.	261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.	262	The launcher can also be overridden on a per-pattern basis.
263		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
264	Example configuration:	267	Example configuration:
265		268
266	URxvt.perl-ext: default,matcher	269	URxvt.perl-ext: default,matcher
267	URxvt.urlLauncher: sensible-browser	270	URxvt.urlLauncher: sensible-browser
268	URxvt.keysym.C-Delete: perl:matcher	271	URxvt.keysym.C-Delete: perl:matcher
…		…
273		276
274	=item xim-onthespot	277	=item xim-onthespot
275		278
276	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
277	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
278	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
279	kinput2.	282	kinput2.
280		283
281	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
282	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
283		286
…		…
291	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
292	or show it again.	295	or show it again.
293		296
294	Initially, the window will not be shown when using this extension.	297	Initially, the window will not be shown when using this extension.
295		298
296	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
297	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.
298		301
299	The accelerator key is grabbed regardless of any modifiers, so this	302	The accelerator key is grabbed regardless of any modifiers, so this
300	extension will actually grab a physical key just for this function.	303	extension will actually grab a physical key just for this function.
301		304
302	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
303	(fvwm can do it).	306	(fvwm can do it).
304		307
305	=item automove-background	308	=item overlay-osc
306		309
307	This is basically a very small extension that dynamically changes the	310	This extension implements some OSC commands to display timed popups on the
308	background pixmap offset to the window position, in effect creating the	311	screen - useful for status displays from within scripts. You have to read
309	same effect as pseudo transparency with a custom pixmap. No scaling is	312	the sources for more info.
310	supported in this mode. Example:
311
312	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
313
314	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
315	shows how this extension can be used to implement an automatically blurred
316	transparent background.
317		313
318	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
319		315
320	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
321	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
…		…
326	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
327		323
328	=item remote-clipboard	324	=item remote-clipboard
329		325
330	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
331	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
332	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
333		329
334	We use it to implement a "distributed selection mechanism", which just	330	We use it to implement a "distributed selection mechanism", which just
335	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
336	reads it.	332	reads it.
…		…
345	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
346	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
347		343
348	=item selection-pastebin	344	=item selection-pastebin
349		345
350	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
351	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
352	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
353	F</tmp> directly.).	349	F</tmp> directly.).
354		350
355	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
374		370
375	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
376		372
377	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
378	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,
379	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
380	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.
381		391
382	=item example-refresh-hooks	392	=item example-refresh-hooks
383		393
384	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
385	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
407		417
408	=over 4	418	=over 4
409		419
410	=item $text	420	=item $text
411		421
412	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
413	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.
414		424
415	=item $string	425	=item $string
416		426
417	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
…		…
551		561
552	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,
553	$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
554	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
555		565
556	=item on_osc_seq $term, $op, $args	566	=item on_osc_seq $term, $op, $args, $resp
557		567
558	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
559	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
560	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
561	confused by recursive invocations when you output an osc sequence within	571	confused by recursive invocations when you output an OSC sequence within
562	this callback.	572	this callback.
563		573
564	C<on_osc_seq_perl> should be used for new behaviour.	574	C<on_osc_seq_perl> should be used for new behaviour.
565		575
566	=item on_osc_seq_perl $term, $string	576	=item on_osc_seq_perl $term, $args, $resp
567		577
568	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
569	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
570	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
571	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,
572	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
573	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	}
574		594
575	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,
576	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
577	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.
578		601
579	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
580		603
581	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
582	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
…		…
603	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
604	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
605		628
606	=item on_refresh_begin $term	629	=item on_refresh_begin $term
607		630
608	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
609	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
610	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
611	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
612		635
613	=item on_refresh_end $term	636	=item on_refresh_end $term
614		637
…		…
621	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
622		645
623	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
624	slightly in the future.	647	slightly in the future.
625		648
626	=item on_resize_all_windows $tern, $new_width, $new_height	649	=item on_resize_all_windows $term, $new_width, $new_height
627		650
628	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
629	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
630	returns TRUE, setting of the window hints is being skipped.	653	returns TRUE, setting of the window hints is being skipped.
631		654
…		…
665		688
666	=item on_map_notify $term, $event	689	=item on_map_notify $term, $event
667		690
668	=item on_unmap_notify $term, $event	691	=item on_unmap_notify $term, $event
669		692
670	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
671	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.
672		695
673	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
674	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
675	(real, not screen-based) row and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
676		699
…		…
685		708
686	=item on_wm_delete_window $term, $event	709	=item on_wm_delete_window $term, $event
687		710
688	Called when various types of ClientMessage events are received (all with	711	Called when various types of ClientMessage events are received (all with
689	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.
690		717
691	=back	718	=back
692		719
693	=cut	720	=cut
694		721
…		…
925	local $TERM = shift;	952	local $TERM = shift;
926	my $htype = shift;	953	my $htype = shift;
927		954
928	if ($htype == 0) { # INIT	955	if ($htype == 0) { # INIT
929	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	956	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
930		957
931	my %ext_arg;	958	my %ext_arg;
932		959
933	{	960	{
934	my @init = @TERM_INIT;	961	my @init = @TERM_INIT;
935	@TERM_INIT = ();	962	@TERM_INIT = ();
…		…
1101	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
1102	work.	1129	work.
1103		1130
1104	=cut	1131	=cut
1105		1132
1106	our $VERSION = 1;	1133	our $VERSION = '5.23';
1107		1134
1108	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1135	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1109	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1136	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1110		1137
1111	sub timer {	1138	sub timer {
…		…
1113		1140
1114	my $cb = $arg{cb};	1141	my $cb = $arg{cb};
1115		1142
1116	urxvt::timer	1143	urxvt::timer
1117	->new	1144	->new
1118	->start (urxvt::NOW + $arg{after})	1145	->after ($arg{after}, $arg{interval})
1119	->cb (sub {	1146	->cb ($arg{interval} ? $cb : sub {
1120	$_[0]->stop; # need to cancel manually	1147	$_[0]->stop; # need to cancel manually
1121	$cb->();	1148	$cb->();
1122	})	1149	})
1123	}	1150	}
1124		1151
1125	sub io {	1152	sub io {
1126	my ($class, %arg) = @_;	1153	my ($class, %arg) = @_;
1127		1154
1128	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
		1156	my $fd = fileno $arg{fh};
		1157	defined $fd or $fd = $arg{fh};
1129		1158
1130	bless [$arg{fh}, urxvt::iow	1159	bless [$arg{fh}, urxvt::iow
1131	->new	1160	->new
1132	->fd (fileno $arg{fh})	1161	->fd ($fd)
1133	->events (($arg{poll} =~ /r/ ? 1 : 0)	1162	->events (($arg{poll} =~ /r/ ? 1 : 0)
1134	\| ($arg{poll} =~ /w/ ? 2 : 0))	1163	\| ($arg{poll} =~ /w/ ? 2 : 0))
1135	->start	1164	->start
1136	->cb (sub {	1165	->cb ($cb)
1137	$cb->(($_[1] & 1 ? 'r' : '')
1138	. ($_[1] & 2 ? 'w' : ''));
1139	})],
1140	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	})
1141	}	1192	}
1142		1193
1143	sub DESTROY {	1194	sub DESTROY {
1144	$_[0][1]->stop;	1195	$_[0][1]->stop;
1145	}
1146
1147	sub condvar {
1148	bless \my $flag, urxvt::anyevent::
1149	}
1150
1151	sub broadcast {
1152	${$_[0]}++;
1153	}
1154
1155	sub wait {
1156	unless (${$_[0]}) {
1157	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1158	}
1159	}	1196	}
1160		1197
1161	sub one_event {	1198	sub one_event {
1162	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";
1163	}	1200	}
…		…
1286	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
1287	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>
1288	to see the actual list:	1325	to see the actual list:
1289		1326
1290	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1327	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1291	borderLess color cursorBlink cursorUnderline cutchars delete_key	1328	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1292	display_name embed ext_bwidth fade font geometry hold iconName	1329	display_name embed ext_bwidth fade font geometry hold iconName
1293	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1330	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1294	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1331	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1295	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1332	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1296	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1333	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1297	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1334	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1298	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1335	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1299	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1336	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1300	secondaryScreen secondaryScroll selectstyle shade term_name title	1337	secondaryScreen secondaryScroll shade term_name title
1301	transient_for transparent transparent_all tripleclickwords utmpInhibit	1338	transient_for transparent transparent_all tripleclickwords utmpInhibit
1302	visualBell	1339	visualBell
1303		1340
1304	=cut	1341	=cut
1305		1342
1306	sub resource($$;$) {	1343	sub resource($$;$) {
1307	my ($self, $name) = (shift, shift);	1344	my ($self, $name) = (shift, shift);
1308	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1345	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1309	&urxvt::term::_resource	1346	goto &urxvt::term::_resource
1310	}	1347	}
1311		1348
1312	=item $value = $term->x_resource ($pattern)	1349	=item $value = $term->x_resource ($pattern)
1313		1350
1314	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
…		…
1339		1376
1340	=item ($row, $col) = $term->selection_beg ([$row, $col])	1377	=item ($row, $col) = $term->selection_beg ([$row, $col])
1341		1378
1342	=item ($row, $col) = $term->selection_end ([$row, $col])	1379	=item ($row, $col) = $term->selection_end ([$row, $col])
1343		1380
1344	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.
1345	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.
1346		1390
1347	=item $term->selection_make ($eventtime[, $rectangular])	1391	=item $term->selection_make ($eventtime[, $rectangular])
1348		1392
1349	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
1350	C<selection_end>. If C<$rectangular> is true (default: false), a	1394	C<selection_end>. If C<$rectangular> is true (default: false), a
1351	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
1352	a selection.	1396	a selection.
1353		1397
1354	=item $success = $term->selection_grab ($eventtime)	1398	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1355		1399
1356	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
1357	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
1358	is mostly useful from within C<on_sel_grab> hooks.	1403	is mostly useful from within C<on_sel_grab> hooks.
1359		1404
1360	=item $oldtext = $term->selection ([$newtext])	1405	=item $oldtext = $term->selection ([$newtext, $clipboard])
1361		1406
1362	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.
1363		1413
1364	=item $term->overlay_simple ($x, $y, $text)	1414	=item $term->overlay_simple ($x, $y, $text)
1365		1415
1366	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.
1367		1417
…		…
1397		1447
1398	The methods currently supported on C<urxvt::overlay> objects are:	1448	The methods currently supported on C<urxvt::overlay> objects are:
1399		1449
1400	=over 4	1450	=over 4
1401		1451
1402	=item $overlay->set ($x, $y, $text, $rend)	1452	=item $overlay->set ($x, $y, $text[, $rend])
1403		1453
1404	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
1405	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
1406	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.
1407		1459
1408	=item $overlay->hide	1460	=item $overlay->hide
1409		1461
1410	If visible, hide the overlay, but do not destroy it.	1462	If visible, hide the overlay, but do not destroy it.
1411		1463
…		…
1493	locale-specific encoding of the terminal and can contain command sequences	1545	locale-specific encoding of the terminal and can contain command sequences
1494	(escape codes) that will be interpreted.	1546	(escape codes) that will be interpreted.
1495		1547
1496	=item $term->tt_write ($octets)	1548	=item $term->tt_write ($octets)
1497		1549
1498	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
1499	pass characters instead of octets, you should convert your strings first	1551	pass characters instead of octets, you should convert your strings first
1500	to the locale-specific encoding using C<< $term->locale_encode >>.	1552	to the locale-specific encoding using C<< $term->locale_encode >>.
1501		1553
1502	=item $old_events = $term->pty_ev_events ([$new_events])	1554	=item $old_events = $term->pty_ev_events ([$new_events])
1503		1555
…		…
1621		1673
1622	Used after changing terminal contents to display them.	1674	Used after changing terminal contents to display them.
1623		1675
1624	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1676	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1625		1677
1626	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 >>
1627	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
1628	terminal line. The scrollback buffer starts at line C<-1> and extends to
1629	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1680	terminal line. Nothing will be returned if a nonexistent line
1630	is requested.	1681	is requested.
1631		1682
1632	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
1633	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
1634	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
1635	automatically be updated.	1686	automatically be updated.
1636		1687
1637	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
1638	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)
1639	characters. Characters with combining characters and other characters that	1690	characters. Characters with combining characters and other characters that
1640	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
1641	in the private use area.	1692	in the private use area.
1642		1693
1643	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
1644	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
1645	characters.	1696	characters.
…		…
1820	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1871	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1821	recent grab.	1872	recent grab.
1822		1873
1823	=item $term->ungrab	1874	=item $term->ungrab
1824		1875
1825	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
1826	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
1827	the session.	1878	the session.
1828		1879
1829	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1880	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1830		1881
…		…
1832		1883
1833	=item @atoms = $term->XListProperties ($window)	1884	=item @atoms = $term->XListProperties ($window)
1834		1885
1835	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1886	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1836		1887
1837	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1888	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1838		1889
1839	=item $term->XDeleteProperty ($window, $property)	1890	=item $term->XDeleteProperty ($window, $property)
1840		1891
1841	=item $window = $term->DefaultRootWindow	1892	=item $window = $term->DefaultRootWindow
1842		1893
…		…
1852		1903
1853	=item $term->XChangeInput ($window, $add_events[, $del_events])	1904	=item $term->XChangeInput ($window, $add_events[, $del_events])
1854		1905
1855	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
1856	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
1857	directory onto the X functions of the same name.	1908	directly onto the X functions of the same name.
1858		1909
1859	=back	1910	=back
1860		1911
1861	=cut	1912	=cut
1862		1913
…		…
1964	my $env = $self->{term}->env;	2015	my $env = $self->{term}->env;
1965	# 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.
1966	delete $env->{LC_ALL};	2017	delete $env->{LC_ALL};
1967	$env->{LC_CTYPE} = $self->{term}->locale;	2018	$env->{LC_CTYPE} = $self->{term}->locale;
1968		2019
1969	urxvt::term->new ($env, "popup",	2020	my $term = urxvt::term->new (
		2021	$env, "popup",
1970	"--perl-lib" => "", "--perl-ext-common" => "",	2022	"--perl-lib" => "", "--perl-ext-common" => "",
1971	"-pty-fd" => -1, "-sl" => 0,	2023	"-pty-fd" => -1, "-sl" => 0,
1972	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2024	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1973	"--transient-for" => $self->{term}->parent,	2025	"--transient-for" => $self->{term}->parent,
1974	"-display" => $self->{term}->display_id,	2026	"-display" => $self->{term}->display_id,
1975	"-pe" => "urxvt-popup")	2027	"-pe" => "urxvt-popup",
1976	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	}
1977	}	2035	}
1978		2036
1979	sub DESTROY {	2037	sub DESTROY {
1980	my ($self) = @_;	2038	my ($self) = @_;
1981		2039
…		…
1999	->new	2057	->new
2000	->interval (1)	2058	->interval (1)
2001	->cb (sub {	2059	->cb (sub {
2002	$term->{overlay}->set (0, 0,	2060	$term->{overlay}->set (0, 0,
2003	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2061	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2004	});	2062	});
2005		2063
2006	=over 4	2064	=over 4
2007		2065
2008	=item $timer = new urxvt::timer	2066	=item $timer = new urxvt::timer
2009		2067
…		…
2012		2070
2013	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2071	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2014		2072
2015	Set the callback to be called when the timer triggers.	2073	Set the callback to be called when the timer triggers.
2016		2074
2017	=item $tstamp = $timer->at
2018
2019	Return the time this watcher will fire next.
2020
2021	=item $timer = $timer->set ($tstamp)	2075	=item $timer = $timer->set ($tstamp[, $interval])
2022		2076
2023	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).
2024		2079
2025	=item $timer = $timer->interval ($interval)	2080	=item $timer = $timer->interval ($interval)
2026		2081
2027	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
2028	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
2029	is automatically rescheduled at the given intervals.	2084	is automatically rescheduled at the given intervals.
2030		2085
2031	=item $timer = $timer->start	2086	=item $timer = $timer->start
2032		2087
2033	Start the timer.	2088	Start the timer.
2034		2089
2035	=item $timer = $timer->start ($tstamp)	2090	=item $timer = $timer->start ($tstamp[, $interval])
2036		2091
2037	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.
2038		2094
2039	=item $timer = $timer->after ($delay)	2095	=item $timer = $timer->after ($delay[, $interval])
2040		2096
2041	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>.
2042		2098
2043	=item $timer = $timer->stop	2099	=item $timer = $timer->stop
2044		2100
…		…
2052		2108
2053	$term->{socket} = ...	2109	$term->{socket} = ...
2054	$term->{iow} = urxvt::iow	2110	$term->{iow} = urxvt::iow
2055	->new	2111	->new
2056	->fd (fileno $term->{socket})	2112	->fd (fileno $term->{socket})
2057	->events (urxvt::EVENT_READ)	2113	->events (urxvt::EV_READ)
2058	->start	2114	->start
2059	->cb (sub {	2115	->cb (sub {
2060	my ($iow, $revents) = @_;	2116	my ($iow, $revents) = @_;
2061	# $revents must be 1 here, no need to check	2117	# $revents must be 1 here, no need to check
2062	sysread $term->{socket}, my $buf, 8192	2118	sysread $term->{socket}, my $buf, 8192
…		…
2080	Set the file descriptor (not handle) to watch.	2136	Set the file descriptor (not handle) to watch.
2081		2137
2082	=item $iow = $iow->events ($eventmask)	2138	=item $iow = $iow->events ($eventmask)
2083		2139
2084	Set the event mask to watch. The only allowed values are	2140	Set the event mask to watch. The only allowed values are
2085	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
2086	together, or C<urxvt::EVENT_NONE>.	2142	together, or C<urxvt::EV_NONE>.
2087		2143
2088	=item $iow = $iow->start	2144	=item $iow = $iow->start
2089		2145
2090	Start watching for requested events on the given handle.	2146	Start watching for requested events on the given handle.
2091		2147
…		…
2132	->new	2188	->new
2133	->start ($pid)	2189	->start ($pid)
2134	->cb (sub {	2190	->cb (sub {
2135	my ($pw, $exit_status) = @_;	2191	my ($pw, $exit_status) = @_;
2136	...	2192	...
2137	});	2193	});
2138		2194
2139	=over 4	2195	=over 4
2140		2196
2141	=item $pw = new urxvt::pw	2197	=item $pw = new urxvt::pw
2142		2198

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.154 by root, Sat Jun 2 06:43:02 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.154 by root, Sat Jun 2 06:43:02 2007 UTC vs.
Revision 1.186 by sf-exg, Fri Jul 23 17:50:41 2010 UTC