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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.155 by tpope, Sun Jun 10 23:42:36 2007 UTC vs.
Revision 1.180 by root, Sat Dec 26 09:42:16 2009 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
…		…
276		276
277	=item xim-onthespot	277	=item xim-onthespot
278		278
279	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
280	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
281	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
282	kinput2.	282	kinput2.
283		283
284	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
285	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
286		286
…		…
294	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
295	or show it again.	295	or show it again.
296		296
297	Initially, the window will not be shown when using this extension.	297	Initially, the window will not be shown when using this extension.
298		298
299	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
300	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.
301		301
302	The accelerator key is grabbed regardless of any modifiers, so this	302	The accelerator key is grabbed regardless of any modifiers, so this
303	extension will actually grab a physical key just for this function.	303	extension will actually grab a physical key just for this function.
304		304
305	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
306	(fvwm can do it).	306	(fvwm can do it).
307		307
308	=item automove-background	308	=item overlay-osc
309		309
310	This is basically a very small extension that dynamically changes the	310	This extension implements some OSC commands to display timed popups on the
311	background pixmap offset to the window position, in effect creating the	311	screen - useful for status displays from within scripts. You have to read
312	same effect as pseudo transparency with a custom pixmap. No scaling is	312	the sources for more info.
313	supported in this mode. Example:
314
315	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
316
317	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
318	shows how this extension can be used to implement an automatically blurred
319	transparent background.
320		313
321	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
322		315
323	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
324	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
…		…
329	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
330		323
331	=item remote-clipboard	324	=item remote-clipboard
332		325
333	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
334	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
335	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
336		329
337	We use it to implement a "distributed selection mechanism", which just	330	We use it to implement a "distributed selection mechanism", which just
338	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
339	reads it.	332	reads it.
…		…
379		372
380	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
381	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,
382	which works regardless of wether xrdb is used to parse the resource file	375	which works regardless of wether xrdb is used to parse the resource file
383	or not.	376	or not.
		377
		378	=item macosx-pastebin and macosx-pastebin-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<maxosx-pastebin> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
384		391
385	=item example-refresh-hooks	392	=item example-refresh-hooks
386		393
387	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
388	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
554		561
555	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,
556	$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
557	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
558		565
559	=item on_osc_seq $term, $op, $args	566	=item on_osc_seq $term, $op, $args, $resp
560		567
561	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
562	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
563	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
564	confused by recursive invocations when you output an osc sequence within	571	confused by recursive invocations when you output an OSC sequence within
565	this callback.	572	this callback.
566		573
567	C<on_osc_seq_perl> should be used for new behaviour.	574	C<on_osc_seq_perl> should be used for new behaviour.
568		575
569	=item on_osc_seq_perl $term, $string	576	=item on_osc_seq_perl $term, $args, $resp
570		577
571	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
572	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
573	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
574	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,
575	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
576	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	}
577		594
578	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,
579	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
580	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.
581		601
582	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
583		603
584	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
585	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
…		…
606	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
607	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
608		628
609	=item on_refresh_begin $term	629	=item on_refresh_begin $term
610		630
611	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
612	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
613	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
614	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
615		635
616	=item on_refresh_end $term	636	=item on_refresh_end $term
617		637
…		…
928	local $TERM = shift;	948	local $TERM = shift;
929	my $htype = shift;	949	my $htype = shift;
930		950
931	if ($htype == 0) { # INIT	951	if ($htype == 0) { # INIT
932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
933		953
934	my %ext_arg;	954	my %ext_arg;
935		955
936	{	956	{
937	my @init = @TERM_INIT;	957	my @init = @TERM_INIT;
938	@TERM_INIT = ();	958	@TERM_INIT = ();
…		…
1104	is that you cannot use blocking APIs, but the non-blocking variant should	1124	is that you cannot use blocking APIs, but the non-blocking variant should
1105	work.	1125	work.
1106		1126
1107	=cut	1127	=cut
1108		1128
1109	our $VERSION = 1;	1129	our $VERSION = '5.23';
1110		1130
1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1131	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1132	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113		1133
1114	sub timer {	1134	sub timer {
…		…
1116		1136
1117	my $cb = $arg{cb};	1137	my $cb = $arg{cb};
1118		1138
1119	urxvt::timer	1139	urxvt::timer
1120	->new	1140	->new
1121	->start (urxvt::NOW + $arg{after})	1141	->after ($arg{after}, $arg{interval})
1122	->cb (sub {	1142	->cb ($arg{interval} ? $cb : sub {
1123	$_[0]->stop; # need to cancel manually	1143	$_[0]->stop; # need to cancel manually
1124	$cb->();	1144	$cb->();
1125	})	1145	})
1126	}	1146	}
1127		1147
1128	sub io {	1148	sub io {
1129	my ($class, %arg) = @_;	1149	my ($class, %arg) = @_;
1130		1150
1131	my $cb = $arg{cb};	1151	my $cb = $arg{cb};
		1152	my $fd = fileno $arg{fh};
		1153	defined $fd or $fd = $arg{fh};
1132		1154
1133	bless [$arg{fh}, urxvt::iow	1155	bless [$arg{fh}, urxvt::iow
1134	->new	1156	->new
1135	->fd (fileno $arg{fh})	1157	->fd ($fd)
1136	->events (($arg{poll} =~ /r/ ? 1 : 0)	1158	->events (($arg{poll} =~ /r/ ? 1 : 0)
1137	\| ($arg{poll} =~ /w/ ? 2 : 0))	1159	\| ($arg{poll} =~ /w/ ? 2 : 0))
1138	->start	1160	->start
1139	->cb (sub {	1161	->cb ($cb)
1140	$cb->(($_[1] & 1 ? 'r' : '')
1141	. ($_[1] & 2 ? 'w' : ''));
1142	})],
1143	urxvt::anyevent::	1162	], urxvt::anyevent::
		1163	}
		1164
		1165	sub idle {
		1166	my ($class, %arg) = @_;
		1167
		1168	my $cb = $arg{cb};
		1169
		1170	urxvt::iw
		1171	->new
		1172	->start
		1173	->cb ($cb)
		1174	}
		1175
		1176	sub child {
		1177	my ($class, %arg) = @_;
		1178
		1179	my $cb = $arg{cb};
		1180
		1181	urxvt::pw
		1182	->new
		1183	->start ($arg{pid})
		1184	->cb (sub {
		1185	$_[0]->stop; # need to cancel manually
		1186	$cb->($_[0]->rpid, $_[0]->rstatus);
		1187	})
1144	}	1188	}
1145		1189
1146	sub DESTROY {	1190	sub DESTROY {
1147	$_[0][1]->stop;	1191	$_[0][1]->stop;
1148	}
1149
1150	sub condvar {
1151	bless \my $flag, urxvt::anyevent::
1152	}
1153
1154	sub broadcast {
1155	${$_[0]}++;
1156	}
1157
1158	sub wait {
1159	unless (${$_[0]}) {
1160	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1161	}
1162	}	1192	}
1163		1193
1164	sub one_event {	1194	sub one_event {
1165	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1195	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1166	}	1196	}
…		…
1289	Here is a likely non-exhaustive list of resource names, not all of which	1319	Here is a likely non-exhaustive list of resource names, not all of which
1290	are supported in every build, please see the source file F</src/rsinc.h>	1320	are supported in every build, please see the source file F</src/rsinc.h>
1291	to see the actual list:	1321	to see the actual list:
1292		1322
1293	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1323	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1294	borderLess color cursorBlink cursorUnderline cutchars delete_key	1324	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1295	display_name embed ext_bwidth fade font geometry hold iconName	1325	display_name embed ext_bwidth fade font geometry hold iconName
1296	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1326	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1297	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1327	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1298	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1328	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1299	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1329	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1330	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1331	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1332	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303	secondaryScreen secondaryScroll selectstyle shade term_name title	1333	secondaryScreen secondaryScroll shade term_name title
1304	transient_for transparent transparent_all tripleclickwords utmpInhibit	1334	transient_for transparent transparent_all tripleclickwords utmpInhibit
1305	visualBell	1335	visualBell
1306		1336
1307	=cut	1337	=cut
1308		1338
1309	sub resource($$;$) {	1339	sub resource($$;$) {
1310	my ($self, $name) = (shift, shift);	1340	my ($self, $name) = (shift, shift);
1311	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1341	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1312	&urxvt::term::_resource	1342	goto &urxvt::term::_resource
1313	}	1343	}
1314		1344
1315	=item $value = $term->x_resource ($pattern)	1345	=item $value = $term->x_resource ($pattern)
1316		1346
1317	Returns the X-Resource for the given pattern, excluding the program or	1347	Returns the X-Resource for the given pattern, excluding the program or
…		…
1342		1372
1343	=item ($row, $col) = $term->selection_beg ([$row, $col])	1373	=item ($row, $col) = $term->selection_beg ([$row, $col])
1344		1374
1345	=item ($row, $col) = $term->selection_end ([$row, $col])	1375	=item ($row, $col) = $term->selection_end ([$row, $col])
1346		1376
1347	Return the current values of the selection mark, begin or end positions,	1377	Return the current values of the selection mark, begin or end positions.
1348	and optionally set them to new values.	1378
		1379	When arguments are given, then the selection coordinates are set to
		1380	C<$row> and C<$col>, and the selection screen is set to the current
		1381	screen.
		1382
		1383	=item $screen = $term->selection_screen ([$screen])
		1384
		1385	Returns the current selection screen, and then optionally sets it.
1349		1386
1350	=item $term->selection_make ($eventtime[, $rectangular])	1387	=item $term->selection_make ($eventtime[, $rectangular])
1351		1388
1352	Tries to make a selection as set by C<selection_beg> and	1389	Tries to make a selection as set by C<selection_beg> and
1353	C<selection_end>. If C<$rectangular> is true (default: false), a	1390	C<selection_end>. If C<$rectangular> is true (default: false), a
…		…
1400		1437
1401	The methods currently supported on C<urxvt::overlay> objects are:	1438	The methods currently supported on C<urxvt::overlay> objects are:
1402		1439
1403	=over 4	1440	=over 4
1404		1441
1405	=item $overlay->set ($x, $y, $text, $rend)	1442	=item $overlay->set ($x, $y, $text[, $rend])
1406		1443
1407	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1444	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1408	text in rxvt-unicode's special encoding and an array of rendition values	1445	text in rxvt-unicode's special encoding and an array of rendition values
1409	at a specific position inside the overlay.	1446	at a specific position inside the overlay.
		1447
		1448	If C<$rend> is missing, then the rendition will not be changed.
1410		1449
1411	=item $overlay->hide	1450	=item $overlay->hide
1412		1451
1413	If visible, hide the overlay, but do not destroy it.	1452	If visible, hide the overlay, but do not destroy it.
1414		1453
…		…
1624		1663
1625	Used after changing terminal contents to display them.	1664	Used after changing terminal contents to display them.
1626		1665
1627	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1666	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1628		1667
1629	Returns the text of the entire row with number C<$row_number>. Row C<0>	1668	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1630	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1669	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1631	terminal line. The scrollback buffer starts at line C<-1> and extends to
1632	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1670	terminal line. Nothing will be returned if a nonexistent line
1633	is requested.	1671	is requested.
1634		1672
1635	If C<$new_text> is specified, it will replace characters in the current	1673	If C<$new_text> is specified, it will replace characters in the current
1636	line, starting at column C<$start_col> (default C<0>), which is useful	1674	line, starting at column C<$start_col> (default C<0>), which is useful
1637	to replace only parts of a line. The font index in the rendition will	1675	to replace only parts of a line. The font index in the rendition will
1638	automatically be updated.	1676	automatically be updated.
1639		1677
1640	C<$text> is in a special encoding: tabs and wide characters that use more	1678	C<$text> is in a special encoding: tabs and wide characters that use more
1641	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1679	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642	characters. Characters with combining characters and other characters that	1680	characters. Characters with combining characters and other characters that
1643	do not fit into the normal tetx encoding will be replaced with characters	1681	do not fit into the normal text encoding will be replaced with characters
1644	in the private use area.	1682	in the private use area.
1645		1683
1646	You have to obey this encoding when changing text. The advantage is	1684	You have to obey this encoding when changing text. The advantage is
1647	that C<substr> and similar functions work on screen cells and not on	1685	that C<substr> and similar functions work on screen cells and not on
1648	characters.	1686	characters.
…		…
1835		1873
1836	=item @atoms = $term->XListProperties ($window)	1874	=item @atoms = $term->XListProperties ($window)
1837		1875
1838	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1876	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1839		1877
1840	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1878	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1841		1879
1842	=item $term->XDeleteProperty ($window, $property)	1880	=item $term->XDeleteProperty ($window, $property)
1843		1881
1844	=item $window = $term->DefaultRootWindow	1882	=item $window = $term->DefaultRootWindow
1845		1883
…		…
1967	my $env = $self->{term}->env;	2005	my $env = $self->{term}->env;
1968	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2006	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969	delete $env->{LC_ALL};	2007	delete $env->{LC_ALL};
1970	$env->{LC_CTYPE} = $self->{term}->locale;	2008	$env->{LC_CTYPE} = $self->{term}->locale;
1971		2009
1972	urxvt::term->new ($env, "popup",	2010	my $term = urxvt::term->new (
		2011	$env, "popup",
1973	"--perl-lib" => "", "--perl-ext-common" => "",	2012	"--perl-lib" => "", "--perl-ext-common" => "",
1974	"-pty-fd" => -1, "-sl" => 0,	2013	"-pty-fd" => -1, "-sl" => 0,
1975	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2014	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976	"--transient-for" => $self->{term}->parent,	2015	"--transient-for" => $self->{term}->parent,
1977	"-display" => $self->{term}->display_id,	2016	"-display" => $self->{term}->display_id,
1978	"-pe" => "urxvt-popup")	2017	"-pe" => "urxvt-popup",
1979	or die "unable to create popup window\n";	2018	) or die "unable to create popup window\n";
		2019
		2020	unless (delete $term->{urxvt_popup_init_done}) {
		2021	$term->ungrab;
		2022	$term->destroy;
		2023	die "unable to initialise popup window\n";
		2024	}
1980	}	2025	}
1981		2026
1982	sub DESTROY {	2027	sub DESTROY {
1983	my ($self) = @_;	2028	my ($self) = @_;
1984		2029
…		…
2002	->new	2047	->new
2003	->interval (1)	2048	->interval (1)
2004	->cb (sub {	2049	->cb (sub {
2005	$term->{overlay}->set (0, 0,	2050	$term->{overlay}->set (0, 0,
2006	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2051	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2007	});	2052	});
2008		2053
2009	=over 4	2054	=over 4
2010		2055
2011	=item $timer = new urxvt::timer	2056	=item $timer = new urxvt::timer
2012		2057
…		…
2015		2060
2016	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2061	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017		2062
2018	Set the callback to be called when the timer triggers.	2063	Set the callback to be called when the timer triggers.
2019		2064
2020	=item $tstamp = $timer->at
2021
2022	Return the time this watcher will fire next.
2023
2024	=item $timer = $timer->set ($tstamp)	2065	=item $timer = $timer->set ($tstamp[, $interval])
2025		2066
2026	Set the time the event is generated to $tstamp.	2067	Set the time the event is generated to $tstamp (and optionally specifies a
		2068	new $interval).
2027		2069
2028	=item $timer = $timer->interval ($interval)	2070	=item $timer = $timer->interval ($interval)
2029		2071
2030	Normally (and when C<$interval> is C<0>), the timer will automatically	2072	By default (and when C<$interval> is C<0>), the timer will automatically
2031	stop after it has fired once. If C<$interval> is non-zero, then the timer	2073	stop after it has fired once. If C<$interval> is non-zero, then the timer
2032	is automatically rescheduled at the given intervals.	2074	is automatically rescheduled at the given intervals.
2033		2075
2034	=item $timer = $timer->start	2076	=item $timer = $timer->start
2035		2077
2036	Start the timer.	2078	Start the timer.
2037		2079
2038	=item $timer = $timer->start ($tstamp)	2080	=item $timer = $timer->start ($tstamp[, $interval])
2039		2081
2040	Set the event trigger time to C<$tstamp> and start the timer.	2082	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2083	also replaces the interval.
2041		2084
2042	=item $timer = $timer->after ($delay)	2085	=item $timer = $timer->after ($delay[, $interval])
2043		2086
2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2087	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045		2088
2046	=item $timer = $timer->stop	2089	=item $timer = $timer->stop
2047		2090
…		…
2055		2098
2056	$term->{socket} = ...	2099	$term->{socket} = ...
2057	$term->{iow} = urxvt::iow	2100	$term->{iow} = urxvt::iow
2058	->new	2101	->new
2059	->fd (fileno $term->{socket})	2102	->fd (fileno $term->{socket})
2060	->events (urxvt::EVENT_READ)	2103	->events (urxvt::EV_READ)
2061	->start	2104	->start
2062	->cb (sub {	2105	->cb (sub {
2063	my ($iow, $revents) = @_;	2106	my ($iow, $revents) = @_;
2064	# $revents must be 1 here, no need to check	2107	# $revents must be 1 here, no need to check
2065	sysread $term->{socket}, my $buf, 8192	2108	sysread $term->{socket}, my $buf, 8192
…		…
2083	Set the file descriptor (not handle) to watch.	2126	Set the file descriptor (not handle) to watch.
2084		2127
2085	=item $iow = $iow->events ($eventmask)	2128	=item $iow = $iow->events ($eventmask)
2086		2129
2087	Set the event mask to watch. The only allowed values are	2130	Set the event mask to watch. The only allowed values are
2088	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2131	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2089	together, or C<urxvt::EVENT_NONE>.	2132	together, or C<urxvt::EV_NONE>.
2090		2133
2091	=item $iow = $iow->start	2134	=item $iow = $iow->start
2092		2135
2093	Start watching for requested events on the given handle.	2136	Start watching for requested events on the given handle.
2094		2137
…		…
2135	->new	2178	->new
2136	->start ($pid)	2179	->start ($pid)
2137	->cb (sub {	2180	->cb (sub {
2138	my ($pw, $exit_status) = @_;	2181	my ($pw, $exit_status) = @_;
2139	...	2182	...
2140	});	2183	});
2141		2184
2142	=over 4	2185	=over 4
2143		2186
2144	=item $pw = new urxvt::pw	2187	=item $pw = new urxvt::pw
2145		2188

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.155 by tpope, Sun Jun 10 23:42:36 2007 UTC vs. Revision 1.180 by root, Sat Dec 26 09:42:16 2009 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.155 by tpope, Sun Jun 10 23:42:36 2007 UTC vs.
Revision 1.180 by root, Sat Dec 26 09:42:16 2009 UTC