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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.157 by ayin, Wed Oct 31 09:55:24 2007 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 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
…		…
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.
…		…
348	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
349	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
350		343
351	=item selection-pastebin	344	=item selection-pastebin
352		345
353	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
354	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
355	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
356	F</tmp> directly.).	349	F</tmp> directly.).
357		350
358	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
377		370
378	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
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 whether xrdb is used to parse the resource file
383	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.
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
…		…
410		417
411	=over 4	418	=over 4
412		419
413	=item $text	420	=item $text
414		421
415	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
416	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.
417		424
418	=item $string	425	=item $string
419		426
420	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
…		…
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
…		…
590	=item on_tt_write $term, $octets	610	=item on_tt_write $term, $octets
591		611
592	Called whenever some data is written to the tty/pty and can be used to	612	Called whenever some data is written to the tty/pty and can be used to
593	suppress or filter tty input.	613	suppress or filter tty input.
594		614
		615	=item on_tt_paste $term, $octets
		616
		617	Called whenever text is about to be pasted, with the text as argument. You
		618	can filter/change and paste the text yourself by returning a true value
		619	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		620	locale-encoded.
		621
595	=item on_line_update $term, $row	622	=item on_line_update $term, $row
596		623
597	Called whenever a line was updated or changed. Can be used to filter	624	Called whenever a line was updated or changed. Can be used to filter
598	screen output (e.g. underline urls or other useless stuff). Only lines	625	screen output (e.g. underline urls or other useless stuff). Only lines
599	that are being shown will be filtered, and, due to performance reasons,	626	that are being shown will be filtered, and, due to performance reasons,
…		…
606	later with the already-modified line (e.g. if unrelated parts change), so	633	later with the already-modified line (e.g. if unrelated parts change), so
607	you cannot just toggle rendition bits, but only set them.	634	you cannot just toggle rendition bits, but only set them.
608		635
609	=item on_refresh_begin $term	636	=item on_refresh_begin $term
610		637
611	Called just before the screen gets redrawn. Can be used for overlay	638	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	639	similar effects by modifying the terminal contents in refresh_begin, and
613	restoring them in refresh_end. The built-in overlay and selection display	640	restoring them in refresh_end. The built-in overlay and selection display
614	code is run after this hook, and takes precedence.	641	code is run after this hook, and takes precedence.
615		642
616	=item on_refresh_end $term	643	=item on_refresh_end $term
617		644
…		…
624	resource in the @@RXVT_NAME@@(1) manpage).	651	resource in the @@RXVT_NAME@@(1) manpage).
625		652
626	The event is simply the action string. This interface is assumed to change	653	The event is simply the action string. This interface is assumed to change
627	slightly in the future.	654	slightly in the future.
628		655
629	=item on_resize_all_windows $tern, $new_width, $new_height	656	=item on_resize_all_windows $term, $new_width, $new_height
630		657
631	Called just after the new window size has been calculated, but before	658	Called just after the new window size has been calculated, but before
632	windows are actually being resized or hints are being set. If this hook	659	windows are actually being resized or hints are being set. If this hook
633	returns TRUE, setting of the window hints is being skipped.	660	returns TRUE, setting of the window hints is being skipped.
634		661
…		…
668		695
669	=item on_map_notify $term, $event	696	=item on_map_notify $term, $event
670		697
671	=item on_unmap_notify $term, $event	698	=item on_unmap_notify $term, $event
672		699
673	Called whenever the corresponding X event is received for the terminal If	700	Called whenever the corresponding X event is received for the terminal. If
674	the hook returns true, then the even will be ignored by rxvt-unicode.	701	the hook returns true, then the event will be ignored by rxvt-unicode.
675		702
676	The event is a hash with most values as named by Xlib (see the XEvent	703	The event is a hash with most values as named by Xlib (see the XEvent
677	manpage), with the additional members C<row> and C<col>, which are the	704	manpage), with the additional members C<row> and C<col>, which are the
678	(real, not screen-based) row and column under the mouse cursor.	705	(real, not screen-based) row and column under the mouse cursor.
679		706
…		…
688		715
689	=item on_wm_delete_window $term, $event	716	=item on_wm_delete_window $term, $event
690		717
691	Called when various types of ClientMessage events are received (all with	718	Called when various types of ClientMessage events are received (all with
692	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	719	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		720
		721	=item on_bell $term
		722
		723	Called on receipt of a bell character.
693		724
694	=back	725	=back
695		726
696	=cut	727	=cut
697		728
…		…
1104	is that you cannot use blocking APIs, but the non-blocking variant should	1135	is that you cannot use blocking APIs, but the non-blocking variant should
1105	work.	1136	work.
1106		1137
1107	=cut	1138	=cut
1108		1139
1109	our $VERSION = 1;	1140	our $VERSION = '5.23';
1110		1141
1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1142	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1143	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113		1144
1114	sub timer {	1145	sub timer {
…		…
1116		1147
1117	my $cb = $arg{cb};	1148	my $cb = $arg{cb};
1118		1149
1119	urxvt::timer	1150	urxvt::timer
1120	->new	1151	->new
1121	->start (urxvt::NOW + $arg{after})	1152	->after ($arg{after}, $arg{interval})
1122	->cb (sub {	1153	->cb ($arg{interval} ? $cb : sub {
1123	$_[0]->stop; # need to cancel manually	1154	$_[0]->stop; # need to cancel manually
1124	$cb->();	1155	$cb->();
1125	})	1156	})
1126	}	1157	}
1127		1158
1128	sub io {	1159	sub io {
1129	my ($class, %arg) = @_;	1160	my ($class, %arg) = @_;
1130		1161
1131	my $cb = $arg{cb};	1162	my $cb = $arg{cb};
		1163	my $fd = fileno $arg{fh};
		1164	defined $fd or $fd = $arg{fh};
1132		1165
1133	bless [$arg{fh}, urxvt::iow	1166	bless [$arg{fh}, urxvt::iow
1134	->new	1167	->new
1135	->fd (fileno $arg{fh})	1168	->fd ($fd)
1136	->events (($arg{poll} =~ /r/ ? 1 : 0)	1169	->events (($arg{poll} =~ /r/ ? 1 : 0)
1137	\| ($arg{poll} =~ /w/ ? 2 : 0))	1170	\| ($arg{poll} =~ /w/ ? 2 : 0))
1138	->start	1171	->start
1139	->cb (sub {	1172	->cb ($cb)
1140	$cb->(($_[1] & 1 ? 'r' : '')
1141	. ($_[1] & 2 ? 'w' : ''));
1142	})],
1143	urxvt::anyevent::	1173	], urxvt::anyevent::
		1174	}
		1175
		1176	sub idle {
		1177	my ($class, %arg) = @_;
		1178
		1179	my $cb = $arg{cb};
		1180
		1181	urxvt::iw
		1182	->new
		1183	->start
		1184	->cb ($cb)
		1185	}
		1186
		1187	sub child {
		1188	my ($class, %arg) = @_;
		1189
		1190	my $cb = $arg{cb};
		1191
		1192	urxvt::pw
		1193	->new
		1194	->start ($arg{pid})
		1195	->cb (sub {
		1196	$_[0]->stop; # need to cancel manually
		1197	$cb->($_[0]->rpid, $_[0]->rstatus);
		1198	})
1144	}	1199	}
1145		1200
1146	sub DESTROY {	1201	sub DESTROY {
1147	$_[0][1]->stop;	1202	$_[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	}	1203	}
1163		1204
1164	sub one_event {	1205	sub one_event {
1165	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1206	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1166	}	1207	}
…		…
1289	Here is a likely non-exhaustive list of resource names, not all of which	1330	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>	1331	are supported in every build, please see the source file F</src/rsinc.h>
1291	to see the actual list:	1332	to see the actual list:
1292		1333
1293	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1334	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1294	borderLess color cursorBlink cursorUnderline cutchars delete_key	1335	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1295	display_name embed ext_bwidth fade font geometry hold iconName	1336	display_name embed ext_bwidth fade font geometry hold iconName
1296	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1337	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1297	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1338	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1298	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1339	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1299	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1340	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1341	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1342	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1343	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303	secondaryScreen secondaryScroll selectstyle shade term_name title	1344	secondaryScreen secondaryScroll shade term_name title
1304	transient_for transparent transparent_all tripleclickwords utmpInhibit	1345	transient_for transparent transparent_all tripleclickwords utmpInhibit
1305	visualBell	1346	visualBell
1306		1347
1307	=cut	1348	=cut
1308		1349
1309	sub resource($$;$) {	1350	sub resource($$;$) {
1310	my ($self, $name) = (shift, shift);	1351	my ($self, $name) = (shift, shift);
1311	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1352	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1312	&urxvt::term::_resource	1353	goto &urxvt::term::_resource
1313	}	1354	}
1314		1355
1315	=item $value = $term->x_resource ($pattern)	1356	=item $value = $term->x_resource ($pattern)
1316		1357
1317	Returns the X-Resource for the given pattern, excluding the program or	1358	Returns the X-Resource for the given pattern, excluding the program or
…		…
1342		1383
1343	=item ($row, $col) = $term->selection_beg ([$row, $col])	1384	=item ($row, $col) = $term->selection_beg ([$row, $col])
1344		1385
1345	=item ($row, $col) = $term->selection_end ([$row, $col])	1386	=item ($row, $col) = $term->selection_end ([$row, $col])
1346		1387
1347	Return the current values of the selection mark, begin or end positions,	1388	Return the current values of the selection mark, begin or end positions.
1348	and optionally set them to new values.	1389
		1390	When arguments are given, then the selection coordinates are set to
		1391	C<$row> and C<$col>, and the selection screen is set to the current
		1392	screen.
		1393
		1394	=item $screen = $term->selection_screen ([$screen])
		1395
		1396	Returns the current selection screen, and then optionally sets it.
1349		1397
1350	=item $term->selection_make ($eventtime[, $rectangular])	1398	=item $term->selection_make ($eventtime[, $rectangular])
1351		1399
1352	Tries to make a selection as set by C<selection_beg> and	1400	Tries to make a selection as set by C<selection_beg> and
1353	C<selection_end>. If C<$rectangular> is true (default: false), a	1401	C<selection_end>. If C<$rectangular> is true (default: false), a
1354	rectangular selection will be made. This is the prefered function to make	1402	rectangular selection will be made. This is the preferred function to make
1355	a selection.	1403	a selection.
1356		1404
1357	=item $success = $term->selection_grab ($eventtime)	1405	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1358		1406
1359	Try to request the primary selection text from the server (for example, as	1407	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1408	true) selection from the server. The corresponding text can be set
1360	set by the next method). No visual feedback will be given. This function	1409	with the next method. No visual feedback will be given. This function
1361	is mostly useful from within C<on_sel_grab> hooks.	1410	is mostly useful from within C<on_sel_grab> hooks.
1362		1411
1363	=item $oldtext = $term->selection ([$newtext])	1412	=item $oldtext = $term->selection ([$newtext, $clipboard])
1364		1413
1365	Return the current selection text and optionally replace it by C<$newtext>.	1414	Return the current selection (clipboard if C<$clipboard> is true) text
		1415	and optionally replace it by C<$newtext>.
		1416
		1417	=item $term->selection_clear ([$clipboard])
		1418
		1419	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1366		1420
1367	=item $term->overlay_simple ($x, $y, $text)	1421	=item $term->overlay_simple ($x, $y, $text)
1368		1422
1369	Create a simple multi-line overlay box. See the next method for details.	1423	Create a simple multi-line overlay box. See the next method for details.
1370		1424
…		…
1400		1454
1401	The methods currently supported on C<urxvt::overlay> objects are:	1455	The methods currently supported on C<urxvt::overlay> objects are:
1402		1456
1403	=over 4	1457	=over 4
1404		1458
1405	=item $overlay->set ($x, $y, $text, $rend)	1459	=item $overlay->set ($x, $y, $text[, $rend])
1406		1460
1407	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1461	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	1462	text in rxvt-unicode's special encoding and an array of rendition values
1409	at a specific position inside the overlay.	1463	at a specific position inside the overlay.
		1464
		1465	If C<$rend> is missing, then the rendition will not be changed.
1410		1466
1411	=item $overlay->hide	1467	=item $overlay->hide
1412		1468
1413	If visible, hide the overlay, but do not destroy it.	1469	If visible, hide the overlay, but do not destroy it.
1414		1470
…		…
1496	locale-specific encoding of the terminal and can contain command sequences	1552	locale-specific encoding of the terminal and can contain command sequences
1497	(escape codes) that will be interpreted.	1553	(escape codes) that will be interpreted.
1498		1554
1499	=item $term->tt_write ($octets)	1555	=item $term->tt_write ($octets)
1500		1556
1501	Write the octets given in C<$data> to the tty (i.e. as program input). To	1557	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1502	pass characters instead of octets, you should convert your strings first	1558	pass characters instead of octets, you should convert your strings first
1503	to the locale-specific encoding using C<< $term->locale_encode >>.	1559	to the locale-specific encoding using C<< $term->locale_encode >>.
		1560
		1561	=item $term->tt_paste ($octets)
		1562
		1563	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1564	CR and bracketing the data with control sequences if bracketed paste mode
		1565	is set.
1504		1566
1505	=item $old_events = $term->pty_ev_events ([$new_events])	1567	=item $old_events = $term->pty_ev_events ([$new_events])
1506		1568
1507	Replaces the event mask of the pty watcher by the given event mask. Can	1569	Replaces the event mask of the pty watcher by the given event mask. Can
1508	be used to suppress input and output handling to the pty/tty. See the	1570	be used to suppress input and output handling to the pty/tty. See the
…		…
1624		1686
1625	Used after changing terminal contents to display them.	1687	Used after changing terminal contents to display them.
1626		1688
1627	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1689	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1628		1690
1629	Returns the text of the entire row with number C<$row_number>. Row C<0>	1691	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	1692	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	1693	terminal line. Nothing will be returned if a nonexistent line
1633	is requested.	1694	is requested.
1634		1695
1635	If C<$new_text> is specified, it will replace characters in the current	1696	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	1697	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	1698	to replace only parts of a line. The font index in the rendition will
1638	automatically be updated.	1699	automatically be updated.
1639		1700
1640	C<$text> is in a special encoding: tabs and wide characters that use more	1701	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)	1702	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642	characters. Characters with combining characters and other characters that	1703	characters. Characters with combining characters and other characters that
1643	do not fit into the normal tetx encoding will be replaced with characters	1704	do not fit into the normal text encoding will be replaced with characters
1644	in the private use area.	1705	in the private use area.
1645		1706
1646	You have to obey this encoding when changing text. The advantage is	1707	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	1708	that C<substr> and similar functions work on screen cells and not on
1648	characters.	1709	characters.
…		…
1823	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1884	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1824	recent grab.	1885	recent grab.
1825		1886
1826	=item $term->ungrab	1887	=item $term->ungrab
1827		1888
1828	Calls XUngrab for the most recent grab. Is called automatically on	1889	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1829	evaluation errors, as it is better to lose the grab in the error case as	1890	evaluation errors, as it is better to lose the grab in the error case as
1830	the session.	1891	the session.
1831		1892
1832	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1893	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1833		1894
…		…
1835		1896
1836	=item @atoms = $term->XListProperties ($window)	1897	=item @atoms = $term->XListProperties ($window)
1837		1898
1838	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1899	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1839		1900
1840	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1901	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1841		1902
1842	=item $term->XDeleteProperty ($window, $property)	1903	=item $term->XDeleteProperty ($window, $property)
1843		1904
1844	=item $window = $term->DefaultRootWindow	1905	=item $window = $term->DefaultRootWindow
1845		1906
…		…
1855		1916
1856	=item $term->XChangeInput ($window, $add_events[, $del_events])	1917	=item $term->XChangeInput ($window, $add_events[, $del_events])
1857		1918
1858	Various X or X-related functions. The C<$term> object only serves as	1919	Various X or X-related functions. The C<$term> object only serves as
1859	the source of the display, otherwise those functions map more-or-less	1920	the source of the display, otherwise those functions map more-or-less
1860	directory onto the X functions of the same name.	1921	directly onto the X functions of the same name.
1861		1922
1862	=back	1923	=back
1863		1924
1864	=cut	1925	=cut
1865		1926
…		…
1967	my $env = $self->{term}->env;	2028	my $env = $self->{term}->env;
1968	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2029	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969	delete $env->{LC_ALL};	2030	delete $env->{LC_ALL};
1970	$env->{LC_CTYPE} = $self->{term}->locale;	2031	$env->{LC_CTYPE} = $self->{term}->locale;
1971		2032
1972	urxvt::term->new ($env, "popup",	2033	my $term = urxvt::term->new (
		2034	$env, "popup",
1973	"--perl-lib" => "", "--perl-ext-common" => "",	2035	"--perl-lib" => "", "--perl-ext-common" => "",
1974	"-pty-fd" => -1, "-sl" => 0,	2036	"-pty-fd" => -1, "-sl" => 0,
1975	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2037	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976	"--transient-for" => $self->{term}->parent,	2038	"--transient-for" => $self->{term}->parent,
1977	"-display" => $self->{term}->display_id,	2039	"-display" => $self->{term}->display_id,
1978	"-pe" => "urxvt-popup")	2040	"-pe" => "urxvt-popup",
1979	or die "unable to create popup window\n";	2041	) or die "unable to create popup window\n";
		2042
		2043	unless (delete $term->{urxvt_popup_init_done}) {
		2044	$term->ungrab;
		2045	$term->destroy;
		2046	die "unable to initialise popup window\n";
		2047	}
1980	}	2048	}
1981		2049
1982	sub DESTROY {	2050	sub DESTROY {
1983	my ($self) = @_;	2051	my ($self) = @_;
1984		2052
…		…
2015		2083
2016	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2084	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017		2085
2018	Set the callback to be called when the timer triggers.	2086	Set the callback to be called when the timer triggers.
2019		2087
2020	=item $tstamp = $timer->at
2021
2022	Return the time this watcher will fire next.
2023
2024	=item $timer = $timer->set ($tstamp)	2088	=item $timer = $timer->set ($tstamp[, $interval])
2025		2089
2026	Set the time the event is generated to $tstamp.	2090	Set the time the event is generated to $tstamp (and optionally specifies a
		2091	new $interval).
2027		2092
2028	=item $timer = $timer->interval ($interval)	2093	=item $timer = $timer->interval ($interval)
2029		2094
2030	Normally (and when C<$interval> is C<0>), the timer will automatically	2095	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	2096	stop after it has fired once. If C<$interval> is non-zero, then the timer
2032	is automatically rescheduled at the given intervals.	2097	is automatically rescheduled at the given intervals.
2033		2098
2034	=item $timer = $timer->start	2099	=item $timer = $timer->start
2035		2100
2036	Start the timer.	2101	Start the timer.
2037		2102
2038	=item $timer = $timer->start ($tstamp)	2103	=item $timer = $timer->start ($tstamp[, $interval])
2039		2104
2040	Set the event trigger time to C<$tstamp> and start the timer.	2105	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2106	also replaces the interval.
2041		2107
2042	=item $timer = $timer->after ($delay)	2108	=item $timer = $timer->after ($delay[, $interval])
2043		2109
2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2110	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045		2111
2046	=item $timer = $timer->stop	2112	=item $timer = $timer->stop
2047		2113
…		…
2055		2121
2056	$term->{socket} = ...	2122	$term->{socket} = ...
2057	$term->{iow} = urxvt::iow	2123	$term->{iow} = urxvt::iow
2058	->new	2124	->new
2059	->fd (fileno $term->{socket})	2125	->fd (fileno $term->{socket})
2060	->events (urxvt::EVENT_READ)	2126	->events (urxvt::EV_READ)
2061	->start	2127	->start
2062	->cb (sub {	2128	->cb (sub {
2063	my ($iow, $revents) = @_;	2129	my ($iow, $revents) = @_;
2064	# $revents must be 1 here, no need to check	2130	# $revents must be 1 here, no need to check
2065	sysread $term->{socket}, my $buf, 8192	2131	sysread $term->{socket}, my $buf, 8192
…		…
2083	Set the file descriptor (not handle) to watch.	2149	Set the file descriptor (not handle) to watch.
2084		2150
2085	=item $iow = $iow->events ($eventmask)	2151	=item $iow = $iow->events ($eventmask)
2086		2152
2087	Set the event mask to watch. The only allowed values are	2153	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	2154	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2089	together, or C<urxvt::EVENT_NONE>.	2155	together, or C<urxvt::EV_NONE>.
2090		2156
2091	=item $iow = $iow->start	2157	=item $iow = $iow->start
2092		2158
2093	Start watching for requested events on the given handle.	2159	Start watching for requested events on the given handle.
2094		2160

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.157 by ayin, Wed Oct 31 09:55:24 2007 UTC vs. Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.157 by ayin, Wed Oct 31 09:55:24 2007 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC