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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.148 by root, Tue Oct 3 21:41:07 2006 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
98		101
99	Other extensions can extend this popup menu by pushing a code reference	102	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the	103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.	104	popup is being displayed.
102		105
103	It's sole argument is the popup menu, which can be modified. It should	106	Its sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code	107	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference	108	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as	109	will be called when the toggle changes, with the new boolean value as
107	first argument.	110	first argument.
108		111
109	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
111		114
112	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};	117	};
115		118
…		…
121		124
122	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.	127	popup is being displayed.
125		128
126	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide whether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
128	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
131		134
132	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:	137	C<a>s:
135		138
136	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
138	: ()	141	: ()
139	};	142	};
140		143
141	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
142		145
…		…
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
154	selection.	157	selection if the C<Shift> modifier is active.
155		158
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To	159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>	160	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.	161	or simply use an uppercase character which removes the "(?i)" prefix.
159		162
…		…
162	=item readline (enabled by default)	165	=item readline (enabled by default)
163		166
164	A support package that tries to make editing with readline easier. At	167	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
166	move the text cursor to this position. It does so by generating as many	169	move the text cursor to this position. It does so by generating as many
167	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
168	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
169		172
170	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
171		174
172	=over 4	175	=over 4
…		…
256	The default pattern to match URLs can be overridden with the	259	The default pattern to match URLs can be overridden with the
257	C<matcher.pattern.0> resource, and additional patterns can be specified	260	C<matcher.pattern.0> resource, and additional patterns can be specified
258	with numbered patterns, in a manner similar to the "selection" extension.	261	with numbered patterns, in a manner similar to the "selection" extension.
259	The launcher can also be overridden on a per-pattern basis.	262	The launcher can also be overridden on a per-pattern basis.
260		263
		264	It is possible to activate the most recently seen match from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
261	Example configuration:	267	Example configuration:
262		268
263	URxvt.perl-ext: default,matcher	269	URxvt.perl-ext: default,matcher
264	URxvt.urlLauncher: sensible-browser	270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
265	URxvt.matcher.button: 1	272	URxvt.matcher.button: 1
266	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]	273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
267	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)	274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
268	URxvt.matcher.launcher.2: gvim +$2 $1	275	URxvt.matcher.launcher.2: gvim +$2 $1
269		276
270	=item xim-onthespot	277	=item xim-onthespot
271		278
272	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
273	not work perfectly, and some input methods don't seem to work well with	280	not work perfectly, and some input methods don't seem to work well with
274	OnTheSpot editing in general, but it seems to work at leats for SCIM and	281	OnTheSpot editing in general, but it seems to work at least for SCIM and
275	kinput2.	282	kinput2.
276		283
277	You enable it by specifying this extension and a preedit style of	284	You enable it by specifying this extension and a preedit style of
278	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
279		286
…		…
287	will show or hide itself. Another press of the accelerator key will hide	294	will show or hide itself. Another press of the accelerator key will hide
288	or show it again.	295	or show it again.
289		296
290	Initially, the window will not be shown when using this extension.	297	Initially, the window will not be shown when using this extension.
291		298
292	This is useful if you need a single terminal thats not using any desktop	299	This is useful if you need a single terminal that is not using any desktop
293	space most of the time but is quickly available at the press of a key.	300	space most of the time but is quickly available at the press of a key.
294		301
295	The accelerator key is grabbed regardless of any modifiers, so this	302	The accelerator key is grabbed regardless of any modifiers, so this
296	extension will actually grab a physical key just for this function.	303	extension will actually grab a physical key just for this function.
297		304
298	If you want a quake-like animation, tell your window manager to do so	305	If you want a quake-like animation, tell your window manager to do so
299	(fvwm can do it).	306	(fvwm can do it).
300		307
301	=item automove-background	308	=item overlay-osc
302		309
303	This is basically a very small extension that dynamically changes the	310	This extension implements some OSC commands to display timed popups on the
304	background pixmap offset to the window position, in effect creating the	311	screen - useful for status displays from within scripts. You have to read
305	same effect as pseudo transparency with a custom pixmap. No scaling is	312	the sources for more info.
306	supported in this mode. Example:
307
308	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
309		313
310	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
311		315
312	A not very useful example of filtering all text output to the terminal	316	A not very useful example of filtering all text output to the terminal
313	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
318	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
319		323
320	=item remote-clipboard	324	=item remote-clipboard
321		325
322	Somewhat of a misnomer, this extension adds two menu entries to the	326	Somewhat of a misnomer, this extension adds two menu entries to the
323	selection popup that allows one ti run external commands to store the	327	selection popup that allows one to run external commands to store the
324	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
325		329
326	We use it to implement a "distributed selection mechanism", which just	330	We use it to implement a "distributed selection mechanism", which just
327	means that one command uploads the file to a remote server, and another	331	means that one command uploads the file to a remote server, and another
328	reads it.	332	reads it.
…		…
337	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
338	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
339		343
340	=item selection-pastebin	344	=item selection-pastebin
341		345
342	This is a little rarely useful extension that Uploads the selection as	346	This is a little rarely useful extension that uploads the selection as
343	textfile to a remote site (or does other things). (The implementation is	347	textfile to a remote site (or does other things). (The implementation is
344	not currently secure for use in a multiuser environment as it writes to	348	not currently secure for use in a multiuser environment as it writes to
345	F</tmp> directly.).	349	F</tmp> directly.).
346		350
347	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
366		370
367	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
368		372
369	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
370	the double C</> characters as comment start. Use C<\057\057> instead,	374	the double C</> characters as comment start. Use C<\057\057> instead,
371	which works regardless of wether xrdb is used to parse the resource file	375	which works regardless of whether xrdb is used to parse the resource file
372	or not.	376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
373		391
374	=item example-refresh-hooks	392	=item example-refresh-hooks
375		393
376	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
377	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
399		417
400	=over 4	418	=over 4
401		419
402	=item $text	420	=item $text
403		421
404	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
405	always represents one screen cell. See L<ROW_t> for a discussion of this format.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
406		424
407	=item $string	425	=item $string
408		426
409	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
…		…
543		561
544	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,
545	$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
546	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
547		565
548	=item on_osc_seq $term, $op, $args	566	=item on_osc_seq $term, $op, $args, $resp
549		567
550	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
551	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
552	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
553	confused by recursive invocations when you output an osc sequence within	571	confused by recursive invocations when you output an OSC sequence within
554	this callback.	572	this callback.
555		573
556	C<on_osc_seq_perl> should be used for new behaviour.	574	C<on_osc_seq_perl> should be used for new behaviour.
557		575
558	=item on_osc_seq_perl $term, $string	576	=item on_osc_seq_perl $term, $args, $resp
559		577
560	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
561	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
562	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
563	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,
564	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
565	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	}
566		594
567	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,
568	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
569	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.
570		601
571	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
572		603
573	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
574	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
…		…
579	=item on_tt_write $term, $octets	610	=item on_tt_write $term, $octets
580		611
581	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
582	suppress or filter tty input.	613	suppress or filter tty input.
583		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
584	=item on_line_update $term, $row	622	=item on_line_update $term, $row
585		623
586	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
587	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
588	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,
…		…
595	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
596	you cannot just toggle rendition bits, but only set them.	634	you cannot just toggle rendition bits, but only set them.
597		635
598	=item on_refresh_begin $term	636	=item on_refresh_begin $term
599		637
600	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
601	or similar effects by modify terminal contents in refresh_begin, and	639	similar effects by modifying the terminal contents in refresh_begin, and
602	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
603	code is run after this hook, and takes precedence.	641	code is run after this hook, and takes precedence.
604		642
605	=item on_refresh_end $term	643	=item on_refresh_end $term
606		644
…		…
613	resource in the @@RXVT_NAME@@(1) manpage).	651	resource in the @@RXVT_NAME@@(1) manpage).
614		652
615	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
616	slightly in the future.	654	slightly in the future.
617		655
618	=item on_resize_all_windows $tern, $new_width, $new_height	656	=item on_resize_all_windows $term, $new_width, $new_height
619		657
620	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
621	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
622	returns TRUE, setting of the window hints is being skipped.	660	returns TRUE, setting of the window hints is being skipped.
623		661
…		…
657		695
658	=item on_map_notify $term, $event	696	=item on_map_notify $term, $event
659		697
660	=item on_unmap_notify $term, $event	698	=item on_unmap_notify $term, $event
661		699
662	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
663	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.
664		702
665	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
666	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
667	(real, not screen-based) row and column under the mouse cursor.	705	(real, not screen-based) row and column under the mouse cursor.
668		706
…		…
677		715
678	=item on_wm_delete_window $term, $event	716	=item on_wm_delete_window $term, $event
679		717
680	Called when various types of ClientMessage events are received (all with	718	Called when various types of ClientMessage events are received (all with
681	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.
682		724
683	=back	725	=back
684		726
685	=cut	727	=cut
686		728
…		…
917	local $TERM = shift;	959	local $TERM = shift;
918	my $htype = shift;	960	my $htype = shift;
919		961
920	if ($htype == 0) { # INIT	962	if ($htype == 0) { # INIT
921	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	963	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
922		964
923	my %ext_arg;	965	my %ext_arg;
924		966
925	{	967	{
926	my @init = @TERM_INIT;	968	my @init = @TERM_INIT;
927	@TERM_INIT = ();	969	@TERM_INIT = ();
…		…
990		1032
991	sub SET_COLOR($$$) {	1033	sub SET_COLOR($$$) {
992	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1034	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
993	}	1035	}
994		1036
		1037	sub rend2mask {
		1038	no strict 'refs';
		1039	my ($str, $mask) = (@_, 0);
		1040	my %color = ( fg => undef, bg => undef );
		1041	my @failed;
		1042	for my $spec ( split /\s+/, $str ) {
		1043	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1044	$color{lc($1)} = $2;
		1045	} else {
		1046	my $neg = $spec =~ s/^[-^]//;
		1047	unless ( exists &{"RS_$spec"} ) {
		1048	push @failed, $spec;
		1049	next;
		1050	}
		1051	my $cur = &{"RS_$spec"};
		1052	if ( $neg ) {
		1053	$mask &= ~$cur;
		1054	} else {
		1055	$mask \|= $cur;
		1056	}
		1057	}
		1058	}
		1059	($mask, @color{qw(fg bg)}, \@failed)
		1060	}
		1061
995	# urxvt::term::extension	1062	# urxvt::term::extension
996		1063
997	package urxvt::term::extension;	1064	package urxvt::term::extension;
998		1065
999	sub enable {	1066	sub enable {
…		…
1068	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
1069	work.	1136	work.
1070		1137
1071	=cut	1138	=cut
1072		1139
1073	our $VERSION = 1;	1140	our $VERSION = '5.23';
1074		1141
1075	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1142	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1076	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1143	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1077		1144
1078	sub timer {	1145	sub timer {
…		…
1080		1147
1081	my $cb = $arg{cb};	1148	my $cb = $arg{cb};
1082		1149
1083	urxvt::timer	1150	urxvt::timer
1084	->new	1151	->new
1085	->start (urxvt::NOW + $arg{after})	1152	->after ($arg{after}, $arg{interval})
1086	->cb (sub {	1153	->cb ($arg{interval} ? $cb : sub {
1087	$_[0]->stop; # need to cancel manually	1154	$_[0]->stop; # need to cancel manually
1088	$cb->();	1155	$cb->();
1089	})	1156	})
1090	}	1157	}
1091		1158
1092	sub io {	1159	sub io {
1093	my ($class, %arg) = @_;	1160	my ($class, %arg) = @_;
1094		1161
1095	my $cb = $arg{cb};	1162	my $cb = $arg{cb};
		1163	my $fd = fileno $arg{fh};
		1164	defined $fd or $fd = $arg{fh};
1096		1165
1097	bless [$arg{fh}, urxvt::iow	1166	bless [$arg{fh}, urxvt::iow
1098	->new	1167	->new
1099	->fd (fileno $arg{fh})	1168	->fd ($fd)
1100	->events (($arg{poll} =~ /r/ ? 1 : 0)	1169	->events (($arg{poll} =~ /r/ ? 1 : 0)
1101	\| ($arg{poll} =~ /w/ ? 2 : 0))	1170	\| ($arg{poll} =~ /w/ ? 2 : 0))
1102	->start	1171	->start
1103	->cb (sub {	1172	->cb ($cb)
1104	$cb->(($_[1] & 1 ? 'r' : '')
1105	. ($_[1] & 2 ? 'w' : ''));
1106	})],
1107	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	})
1108	}	1199	}
1109		1200
1110	sub DESTROY {	1201	sub DESTROY {
1111	$_[0][1]->stop;	1202	$_[0][1]->stop;
1112	}	1203	}
1113		1204
1114	sub condvar {	1205	sub one_event {
1115	bless \my $flag, urxvt::anyevent::condvar::
1116	}
1117
1118	sub urxvt::anyevent::condvar::broadcast {
1119	${$_[0]}++;
1120	}
1121
1122	sub urxvt::anyevent::condvar::wait {
1123	unless (${$_[0]}) {
1124	Carp::croak "AnyEvent->condvar 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";
1125	}
1126	}	1207	}
1127		1208
1128	package urxvt::term;	1209	package urxvt::term;
1129		1210
1130	=head2 The C<urxvt::term> Class	1211	=head2 The C<urxvt::term> Class
…		…
1249	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
1250	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>
1251	to see the actual list:	1332	to see the actual list:
1252		1333
1253	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1334	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1254	borderLess color cursorBlink cursorUnderline cutchars delete_key	1335	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1255	display_name embed ext_bwidth fade font geometry hold iconName	1336	display_name embed ext_bwidth fade font geometry hold iconName
1256	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1337	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1257	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1338	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1258	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1339	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1259	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1340	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1260	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1341	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1261	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1342	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1262	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1343	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1263	secondaryScreen secondaryScroll selectstyle shade term_name title	1344	secondaryScreen secondaryScroll shade term_name title
1264	transient_for transparent transparent_all tripleclickwords utmpInhibit	1345	transient_for transparent transparent_all tripleclickwords utmpInhibit
1265	visualBell	1346	visualBell
1266		1347
1267	=cut	1348	=cut
1268		1349
1269	sub resource($$;$) {	1350	sub resource($$;$) {
1270	my ($self, $name) = (shift, shift);	1351	my ($self, $name) = (shift, shift);
1271	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1352	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1272	&urxvt::term::_resource	1353	goto &urxvt::term::_resource
1273	}	1354	}
1274		1355
1275	=item $value = $term->x_resource ($pattern)	1356	=item $value = $term->x_resource ($pattern)
1276		1357
1277	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
…		…
1302		1383
1303	=item ($row, $col) = $term->selection_beg ([$row, $col])	1384	=item ($row, $col) = $term->selection_beg ([$row, $col])
1304		1385
1305	=item ($row, $col) = $term->selection_end ([$row, $col])	1386	=item ($row, $col) = $term->selection_end ([$row, $col])
1306		1387
1307	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.
1308	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.
1309		1397
1310	=item $term->selection_make ($eventtime[, $rectangular])	1398	=item $term->selection_make ($eventtime[, $rectangular])
1311		1399
1312	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
1313	C<selection_end>. If C<$rectangular> is true (default: false), a	1401	C<selection_end>. If C<$rectangular> is true (default: false), a
1314	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
1315	a selection.	1403	a selection.
1316		1404
1317	=item $success = $term->selection_grab ($eventtime)	1405	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1318		1406
1319	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
1320	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
1321	is mostly useful from within C<on_sel_grab> hooks.	1410	is mostly useful from within C<on_sel_grab> hooks.
1322		1411
1323	=item $oldtext = $term->selection ([$newtext])	1412	=item $oldtext = $term->selection ([$newtext, $clipboard])
1324		1413
1325	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.
1326		1420
1327	=item $term->overlay_simple ($x, $y, $text)	1421	=item $term->overlay_simple ($x, $y, $text)
1328		1422
1329	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.
1330		1424
…		…
1360		1454
1361	The methods currently supported on C<urxvt::overlay> objects are:	1455	The methods currently supported on C<urxvt::overlay> objects are:
1362		1456
1363	=over 4	1457	=over 4
1364		1458
1365	=item $overlay->set ($x, $y, $text, $rend)	1459	=item $overlay->set ($x, $y, $text[, $rend])
1366		1460
1367	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
1368	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
1369	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.
1370		1466
1371	=item $overlay->hide	1467	=item $overlay->hide
1372		1468
1373	If visible, hide the overlay, but do not destroy it.	1469	If visible, hide the overlay, but do not destroy it.
1374		1470
…		…
1456	locale-specific encoding of the terminal and can contain command sequences	1552	locale-specific encoding of the terminal and can contain command sequences
1457	(escape codes) that will be interpreted.	1553	(escape codes) that will be interpreted.
1458		1554
1459	=item $term->tt_write ($octets)	1555	=item $term->tt_write ($octets)
1460		1556
1461	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
1462	pass characters instead of octets, you should convert your strings first	1558	pass characters instead of octets, you should convert your strings first
1463	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.
1464		1566
1465	=item $old_events = $term->pty_ev_events ([$new_events])	1567	=item $old_events = $term->pty_ev_events ([$new_events])
1466		1568
1467	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
1468	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
…		…
1584		1686
1585	Used after changing terminal contents to display them.	1687	Used after changing terminal contents to display them.
1586		1688
1587	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1689	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1588		1690
1589	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 >>
1590	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
1591	terminal line. The scrollback buffer starts at line C<-1> and extends to
1592	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1693	terminal line. Nothing will be returned if a nonexistent line
1593	is requested.	1694	is requested.
1594		1695
1595	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
1596	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
1597	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
1598	automatically be updated.	1699	automatically be updated.
1599		1700
1600	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
1601	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)
1602	characters. Characters with combining characters and other characters that	1703	characters. Characters with combining characters and other characters that
1603	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
1604	in the private use area.	1705	in the private use area.
1605		1706
1606	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
1607	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
1608	characters.	1709	characters.
…		…
1783	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1884	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1784	recent grab.	1885	recent grab.
1785		1886
1786	=item $term->ungrab	1887	=item $term->ungrab
1787		1888
1788	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
1789	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
1790	the session.	1891	the session.
1791		1892
1792	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1893	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1793		1894
…		…
1795		1896
1796	=item @atoms = $term->XListProperties ($window)	1897	=item @atoms = $term->XListProperties ($window)
1797		1898
1798	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1899	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1799		1900
1800	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1901	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1801		1902
1802	=item $term->XDeleteProperty ($window, $property)	1903	=item $term->XDeleteProperty ($window, $property)
1803		1904
1804	=item $window = $term->DefaultRootWindow	1905	=item $window = $term->DefaultRootWindow
1805		1906
…		…
1815		1916
1816	=item $term->XChangeInput ($window, $add_events[, $del_events])	1917	=item $term->XChangeInput ($window, $add_events[, $del_events])
1817		1918
1818	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
1819	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
1820	directory onto the X functions of the same name.	1921	directly onto the X functions of the same name.
1821		1922
1822	=back	1923	=back
1823		1924
1824	=cut	1925	=cut
1825		1926
…		…
1927	my $env = $self->{term}->env;	2028	my $env = $self->{term}->env;
1928	# 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.
1929	delete $env->{LC_ALL};	2030	delete $env->{LC_ALL};
1930	$env->{LC_CTYPE} = $self->{term}->locale;	2031	$env->{LC_CTYPE} = $self->{term}->locale;
1931		2032
1932	urxvt::term->new ($env, "popup",	2033	my $term = urxvt::term->new (
		2034	$env, "popup",
1933	"--perl-lib" => "", "--perl-ext-common" => "",	2035	"--perl-lib" => "", "--perl-ext-common" => "",
1934	"-pty-fd" => -1, "-sl" => 0,	2036	"-pty-fd" => -1, "-sl" => 0,
1935	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2037	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1936	"--transient-for" => $self->{term}->parent,	2038	"--transient-for" => $self->{term}->parent,
1937	"-display" => $self->{term}->display_id,	2039	"-display" => $self->{term}->display_id,
1938	"-pe" => "urxvt-popup")	2040	"-pe" => "urxvt-popup",
1939	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	}
1940	}	2048	}
1941		2049
1942	sub DESTROY {	2050	sub DESTROY {
1943	my ($self) = @_;	2051	my ($self) = @_;
1944		2052
…		…
1949	=back	2057	=back
1950		2058
1951	=cut	2059	=cut
1952		2060
1953	package urxvt::watcher;	2061	package urxvt::watcher;
1954
1955	@urxvt::timer::ISA = __PACKAGE__;
1956	@urxvt::iow::ISA = __PACKAGE__;
1957	@urxvt::pw::ISA = __PACKAGE__;
1958	@urxvt::iw::ISA = __PACKAGE__;
1959		2062
1960	=head2 The C<urxvt::timer> Class	2063	=head2 The C<urxvt::timer> Class
1961		2064
1962	This class implements timer watchers/events. Time is represented as a	2065	This class implements timer watchers/events. Time is represented as a
1963	fractional number of seconds since the epoch. Example:	2066	fractional number of seconds since the epoch. Example:
…		…
1967	->new	2070	->new
1968	->interval (1)	2071	->interval (1)
1969	->cb (sub {	2072	->cb (sub {
1970	$term->{overlay}->set (0, 0,	2073	$term->{overlay}->set (0, 0,
1971	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2074	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1972	});	2075	});
1973		2076
1974	=over 4	2077	=over 4
1975		2078
1976	=item $timer = new urxvt::timer	2079	=item $timer = new urxvt::timer
1977		2080
…		…
1980		2083
1981	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2084	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1982		2085
1983	Set the callback to be called when the timer triggers.	2086	Set the callback to be called when the timer triggers.
1984		2087
1985	=item $tstamp = $timer->at
1986
1987	Return the time this watcher will fire next.
1988
1989	=item $timer = $timer->set ($tstamp)	2088	=item $timer = $timer->set ($tstamp[, $interval])
1990		2089
1991	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).
1992		2092
1993	=item $timer = $timer->interval ($interval)	2093	=item $timer = $timer->interval ($interval)
1994		2094
1995	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
1996	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
1997	is automatically rescheduled at the given intervals.	2097	is automatically rescheduled at the given intervals.
1998		2098
1999	=item $timer = $timer->start	2099	=item $timer = $timer->start
2000		2100
2001	Start the timer.	2101	Start the timer.
2002		2102
2003	=item $timer = $timer->start ($tstamp)	2103	=item $timer = $timer->start ($tstamp[, $interval])
2004		2104
2005	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.
2006		2107
2007	=item $timer = $timer->after ($delay)	2108	=item $timer = $timer->after ($delay[, $interval])
2008		2109
2009	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>.
2010		2111
2011	=item $timer = $timer->stop	2112	=item $timer = $timer->stop
2012		2113
…		…
2020		2121
2021	$term->{socket} = ...	2122	$term->{socket} = ...
2022	$term->{iow} = urxvt::iow	2123	$term->{iow} = urxvt::iow
2023	->new	2124	->new
2024	->fd (fileno $term->{socket})	2125	->fd (fileno $term->{socket})
2025	->events (urxvt::EVENT_READ)	2126	->events (urxvt::EV_READ)
2026	->start	2127	->start
2027	->cb (sub {	2128	->cb (sub {
2028	my ($iow, $revents) = @_;	2129	my ($iow, $revents) = @_;
2029	# $revents must be 1 here, no need to check	2130	# $revents must be 1 here, no need to check
2030	sysread $term->{socket}, my $buf, 8192	2131	sysread $term->{socket}, my $buf, 8192
…		…
2048	Set the file descriptor (not handle) to watch.	2149	Set the file descriptor (not handle) to watch.
2049		2150
2050	=item $iow = $iow->events ($eventmask)	2151	=item $iow = $iow->events ($eventmask)
2051		2152
2052	Set the event mask to watch. The only allowed values are	2153	Set the event mask to watch. The only allowed values are
2053	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
2054	together, or C<urxvt::EVENT_NONE>.	2155	together, or C<urxvt::EV_NONE>.
2055		2156
2056	=item $iow = $iow->start	2157	=item $iow = $iow->start
2057		2158
2058	Start watching for requested events on the given handle.	2159	Start watching for requested events on the given handle.
2059		2160
…		…
2100	->new	2201	->new
2101	->start ($pid)	2202	->start ($pid)
2102	->cb (sub {	2203	->cb (sub {
2103	my ($pw, $exit_status) = @_;	2204	my ($pw, $exit_status) = @_;
2104	...	2205	...
2105	});	2206	});
2106		2207
2107	=over 4	2208	=over 4
2108		2209
2109	=item $pw = new urxvt::pw	2210	=item $pw = new urxvt::pw
2110		2211
…		…
2149	http://software.schmorp.de/pkg/rxvt-unicode	2250	http://software.schmorp.de/pkg/rxvt-unicode
2150		2251
2151	=cut	2252	=cut
2152		2253
2153	1	2254	1
		2255
		2256	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.148 by root, Tue Oct 3 21:41:07 2006 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.148 by root, Tue Oct 3 21:41:07 2006 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC