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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.146 by root, Thu Aug 17 21:56:11 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
…		…
240	URxvt.tabbed.tab-bg: <colour-index, default 1>	243	URxvt.tabbed.tab-bg: <colour-index, default 1>
241		244
242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid	245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243	indices.	246	indices.
244		247
245	=item mark-urls	248	=item matcher
246		249
247	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
248	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
249	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
250	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		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
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
251		276
252	=item xim-onthespot	277	=item xim-onthespot
253		278
254	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
255	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
256	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
257	kinput2.	282	kinput2.
258		283
259	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
260	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
261		286
…		…
269	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
270	or show it again.	295	or show it again.
271		296
272	Initially, the window will not be shown when using this extension.	297	Initially, the window will not be shown when using this extension.
273		298
274	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
275	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.
276		301
277	The accelerator key is grabbed regardless of any modifiers, so this	302	The accelerator key is grabbed regardless of any modifiers, so this
278	extension will actually grab a physical key just for this function.	303	extension will actually grab a physical key just for this function.
279		304
280	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
281	(fvwm can do it).	306	(fvwm can do it).
282		307
283	=item automove-background	308	=item overlay-osc
284		309
285	This is basically a very small extension that dynamically changes the	310	This extension implements some OSC commands to display timed popups on the
286	background pixmap offset to the window position, in effect creating the	311	screen - useful for status displays from within scripts. You have to read
287	same effect as pseudo transparency with a custom pixmap. No scaling is	312	the sources for more info.
288	supported in this mode. Example:
289
290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291		313
292	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
293		315
294	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
295	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
…		…
300	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
301		323
302	=item remote-clipboard	324	=item remote-clipboard
303		325
304	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
305	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
306	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
307		329
308	We use it to implement a "distributed selection mechanism", which just	330	We use it to implement a "distributed selection mechanism", which just
309	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
310	reads it.	332	reads it.
…		…
319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321		343
322	=item selection-pastebin	344	=item selection-pastebin
323		345
324	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
325	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
326	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
327	F</tmp> directly.).	349	F</tmp> directly.).
328		350
329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
348		370
349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350		372
351	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
352	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,
353	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
354	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.
355		391
356	=item example-refresh-hooks	392	=item example-refresh-hooks
357		393
358	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
359	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
381		417
382	=over 4	418	=over 4
383		419
384	=item $text	420	=item $text
385		421
386	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
387	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.
388		424
389	=item $string	425	=item $string
390		426
391	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
…		…
525		561
526	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,
527	$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
528	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
529		565
530	=item on_osc_seq $term, $op, $args	566	=item on_osc_seq $term, $op, $args, $resp
531		567
532	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
533	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
534	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
535	confused by recursive invocations when you output an osc sequence within	571	confused by recursive invocations when you output an OSC sequence within
536	this callback.	572	this callback.
537		573
538	C<on_osc_seq_perl> should be used for new behaviour.	574	C<on_osc_seq_perl> should be used for new behaviour.
539		575
540	=item on_osc_seq_perl $term, $string	576	=item on_osc_seq_perl $term, $args, $resp
541		577
542	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
543	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
544	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
545	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,
546	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
547	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	}
548		594
549	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,
550	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
551	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.
552		601
553	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
554		603
555	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
556	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
…		…
561	=item on_tt_write $term, $octets	610	=item on_tt_write $term, $octets
562		611
563	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
564	suppress or filter tty input.	613	suppress or filter tty input.
565		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
566	=item on_line_update $term, $row	622	=item on_line_update $term, $row
567		623
568	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
569	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
570	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,
…		…
577	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
578	you cannot just toggle rendition bits, but only set them.	634	you cannot just toggle rendition bits, but only set them.
579		635
580	=item on_refresh_begin $term	636	=item on_refresh_begin $term
581		637
582	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
583	or similar effects by modify terminal contents in refresh_begin, and	639	similar effects by modifying the terminal contents in refresh_begin, and
584	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
585	code is run after this hook, and takes precedence.	641	code is run after this hook, and takes precedence.
586		642
587	=item on_refresh_end $term	643	=item on_refresh_end $term
588		644
…		…
595	resource in the @@RXVT_NAME@@(1) manpage).	651	resource in the @@RXVT_NAME@@(1) manpage).
596		652
597	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
598	slightly in the future.	654	slightly in the future.
599		655
600	=item on_resize_all_windows $tern, $new_width, $new_height	656	=item on_resize_all_windows $term, $new_width, $new_height
601		657
602	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
603	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
604	returns TRUE, setting of the window hints is being skipped.	660	returns TRUE, setting of the window hints is being skipped.
605		661
…		…
639		695
640	=item on_map_notify $term, $event	696	=item on_map_notify $term, $event
641		697
642	=item on_unmap_notify $term, $event	698	=item on_unmap_notify $term, $event
643		699
644	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
645	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.
646		702
647	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
648	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
649	(real, not screen-based) row and column under the mouse cursor.	705	(real, not screen-based) row and column under the mouse cursor.
650		706
…		…
659		715
660	=item on_wm_delete_window $term, $event	716	=item on_wm_delete_window $term, $event
661		717
662	Called when various types of ClientMessage events are received (all with	718	Called when various types of ClientMessage events are received (all with
663	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.
664		724
665	=back	725	=back
666		726
667	=cut	727	=cut
668		728
…		…
899	local $TERM = shift;	959	local $TERM = shift;
900	my $htype = shift;	960	my $htype = shift;
901		961
902	if ($htype == 0) { # INIT	962	if ($htype == 0) { # INIT
903	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	963	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
904		964
905	my %ext_arg;	965	my %ext_arg;
906		966
907	{	967	{
908	my @init = @TERM_INIT;	968	my @init = @TERM_INIT;
909	@TERM_INIT = ();	969	@TERM_INIT = ();
…		…
972		1032
973	sub SET_COLOR($$$) {	1033	sub SET_COLOR($$$) {
974	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1034	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
975	}	1035	}
976		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
977	# urxvt::term::extension	1062	# urxvt::term::extension
978		1063
979	package urxvt::term::extension;	1064	package urxvt::term::extension;
980		1065
981	sub enable {	1066	sub enable {
…		…
1050	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
1051	work.	1136	work.
1052		1137
1053	=cut	1138	=cut
1054		1139
1055	our $VERSION = 1;	1140	our $VERSION = '5.23';
1056		1141
1057	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1142	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1058	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1143	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1059		1144
1060	sub timer {	1145	sub timer {
…		…
1062		1147
1063	my $cb = $arg{cb};	1148	my $cb = $arg{cb};
1064		1149
1065	urxvt::timer	1150	urxvt::timer
1066	->new	1151	->new
1067	->start (urxvt::NOW + $arg{after})	1152	->after ($arg{after}, $arg{interval})
1068	->cb (sub {	1153	->cb ($arg{interval} ? $cb : sub {
1069	$_[0]->stop; # need to cancel manually	1154	$_[0]->stop; # need to cancel manually
1070	$cb->();	1155	$cb->();
1071	})	1156	})
1072	}	1157	}
1073		1158
1074	sub io {	1159	sub io {
1075	my ($class, %arg) = @_;	1160	my ($class, %arg) = @_;
1076		1161
1077	my $cb = $arg{cb};	1162	my $cb = $arg{cb};
		1163	my $fd = fileno $arg{fh};
		1164	defined $fd or $fd = $arg{fh};
1078		1165
1079	bless [$arg{fh}, urxvt::iow	1166	bless [$arg{fh}, urxvt::iow
1080	->new	1167	->new
1081	->fd (fileno $arg{fh})	1168	->fd ($fd)
1082	->events (($arg{poll} =~ /r/ ? 1 : 0)	1169	->events (($arg{poll} =~ /r/ ? 1 : 0)
1083	\| ($arg{poll} =~ /w/ ? 2 : 0))	1170	\| ($arg{poll} =~ /w/ ? 2 : 0))
1084	->start	1171	->start
1085	->cb (sub {	1172	->cb ($cb)
1086	$cb->(($_[1] & 1 ? 'r' : '')
1087	. ($_[1] & 2 ? 'w' : ''));
1088	})],
1089	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	})
1090	}	1199	}
1091		1200
1092	sub DESTROY {	1201	sub DESTROY {
1093	$_[0][1]->stop;	1202	$_[0][1]->stop;
1094	}	1203	}
1095		1204
1096	sub condvar {	1205	sub one_event {
1097	bless \my $flag, urxvt::anyevent::condvar::
1098	}
1099
1100	sub urxvt::anyevent::condvar::broadcast {
1101	${$_[0]}++;
1102	}
1103
1104	sub urxvt::anyevent::condvar::wait {
1105	unless (${$_[0]}) {
1106	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";
1107	}
1108	}	1207	}
1109		1208
1110	package urxvt::term;	1209	package urxvt::term;
1111		1210
1112	=head2 The C<urxvt::term> Class	1211	=head2 The C<urxvt::term> Class
…		…
1231	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
1232	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>
1233	to see the actual list:	1332	to see the actual list:
1234		1333
1235	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1334	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1236	borderLess color cursorBlink cursorUnderline cutchars delete_key	1335	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1237	display_name embed ext_bwidth fade font geometry hold iconName	1336	display_name embed ext_bwidth fade font geometry hold iconName
1238	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1337	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1239	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1338	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1240	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1339	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1241	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1340	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1242	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1341	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1243	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1342	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1244	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1343	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1245	secondaryScreen secondaryScroll selectstyle shade term_name title	1344	secondaryScreen secondaryScroll shade term_name title
1246	transient_for transparent transparent_all tripleclickwords utmpInhibit	1345	transient_for transparent transparent_all tripleclickwords utmpInhibit
1247	visualBell	1346	visualBell
1248		1347
1249	=cut	1348	=cut
1250		1349
1251	sub resource($$;$) {	1350	sub resource($$;$) {
1252	my ($self, $name) = (shift, shift);	1351	my ($self, $name) = (shift, shift);
1253	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1352	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1254	&urxvt::term::_resource	1353	goto &urxvt::term::_resource
1255	}	1354	}
1256		1355
1257	=item $value = $term->x_resource ($pattern)	1356	=item $value = $term->x_resource ($pattern)
1258		1357
1259	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
…		…
1284		1383
1285	=item ($row, $col) = $term->selection_beg ([$row, $col])	1384	=item ($row, $col) = $term->selection_beg ([$row, $col])
1286		1385
1287	=item ($row, $col) = $term->selection_end ([$row, $col])	1386	=item ($row, $col) = $term->selection_end ([$row, $col])
1288		1387
1289	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.
1290	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.
1291		1397
1292	=item $term->selection_make ($eventtime[, $rectangular])	1398	=item $term->selection_make ($eventtime[, $rectangular])
1293		1399
1294	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
1295	C<selection_end>. If C<$rectangular> is true (default: false), a	1401	C<selection_end>. If C<$rectangular> is true (default: false), a
1296	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
1297	a selection.	1403	a selection.
1298		1404
1299	=item $success = $term->selection_grab ($eventtime)	1405	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1300		1406
1301	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
1302	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
1303	is mostly useful from within C<on_sel_grab> hooks.	1410	is mostly useful from within C<on_sel_grab> hooks.
1304		1411
1305	=item $oldtext = $term->selection ([$newtext])	1412	=item $oldtext = $term->selection ([$newtext, $clipboard])
1306		1413
1307	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.
1308		1420
1309	=item $term->overlay_simple ($x, $y, $text)	1421	=item $term->overlay_simple ($x, $y, $text)
1310		1422
1311	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.
1312		1424
…		…
1342		1454
1343	The methods currently supported on C<urxvt::overlay> objects are:	1455	The methods currently supported on C<urxvt::overlay> objects are:
1344		1456
1345	=over 4	1457	=over 4
1346		1458
1347	=item $overlay->set ($x, $y, $text, $rend)	1459	=item $overlay->set ($x, $y, $text[, $rend])
1348		1460
1349	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
1350	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
1351	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.
1352		1466
1353	=item $overlay->hide	1467	=item $overlay->hide
1354		1468
1355	If visible, hide the overlay, but do not destroy it.	1469	If visible, hide the overlay, but do not destroy it.
1356		1470
…		…
1438	locale-specific encoding of the terminal and can contain command sequences	1552	locale-specific encoding of the terminal and can contain command sequences
1439	(escape codes) that will be interpreted.	1553	(escape codes) that will be interpreted.
1440		1554
1441	=item $term->tt_write ($octets)	1555	=item $term->tt_write ($octets)
1442		1556
1443	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
1444	pass characters instead of octets, you should convert your strings first	1558	pass characters instead of octets, you should convert your strings first
1445	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.
1446		1566
1447	=item $old_events = $term->pty_ev_events ([$new_events])	1567	=item $old_events = $term->pty_ev_events ([$new_events])
1448		1568
1449	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
1450	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
…		…
1566		1686
1567	Used after changing terminal contents to display them.	1687	Used after changing terminal contents to display them.
1568		1688
1569	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1689	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1570		1690
1571	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 >>
1572	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
1573	terminal line. The scrollback buffer starts at line C<-1> and extends to
1574	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1693	terminal line. Nothing will be returned if a nonexistent line
1575	is requested.	1694	is requested.
1576		1695
1577	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
1578	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
1579	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
1580	automatically be updated.	1699	automatically be updated.
1581		1700
1582	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
1583	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)
1584	characters. Characters with combining characters and other characters that	1703	characters. Characters with combining characters and other characters that
1585	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
1586	in the private use area.	1705	in the private use area.
1587		1706
1588	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
1589	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
1590	characters.	1709	characters.
…		…
1765	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1884	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1766	recent grab.	1885	recent grab.
1767		1886
1768	=item $term->ungrab	1887	=item $term->ungrab
1769		1888
1770	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
1771	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
1772	the session.	1891	the session.
1773		1892
1774	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1893	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1775		1894
…		…
1777		1896
1778	=item @atoms = $term->XListProperties ($window)	1897	=item @atoms = $term->XListProperties ($window)
1779		1898
1780	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1899	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1781		1900
1782	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1901	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1783		1902
1784	=item $term->XDeleteProperty ($window, $property)	1903	=item $term->XDeleteProperty ($window, $property)
1785		1904
1786	=item $window = $term->DefaultRootWindow	1905	=item $window = $term->DefaultRootWindow
1787		1906
…		…
1797		1916
1798	=item $term->XChangeInput ($window, $add_events[, $del_events])	1917	=item $term->XChangeInput ($window, $add_events[, $del_events])
1799		1918
1800	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
1801	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
1802	directory onto the X functions of the same name.	1921	directly onto the X functions of the same name.
1803		1922
1804	=back	1923	=back
1805		1924
1806	=cut	1925	=cut
1807		1926
…		…
1909	my $env = $self->{term}->env;	2028	my $env = $self->{term}->env;
1910	# 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.
1911	delete $env->{LC_ALL};	2030	delete $env->{LC_ALL};
1912	$env->{LC_CTYPE} = $self->{term}->locale;	2031	$env->{LC_CTYPE} = $self->{term}->locale;
1913		2032
1914	urxvt::term->new ($env, "popup",	2033	my $term = urxvt::term->new (
		2034	$env, "popup",
1915	"--perl-lib" => "", "--perl-ext-common" => "",	2035	"--perl-lib" => "", "--perl-ext-common" => "",
1916	"-pty-fd" => -1, "-sl" => 0,	2036	"-pty-fd" => -1, "-sl" => 0,
1917	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2037	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1918	"--transient-for" => $self->{term}->parent,	2038	"--transient-for" => $self->{term}->parent,
1919	"-display" => $self->{term}->display_id,	2039	"-display" => $self->{term}->display_id,
1920	"-pe" => "urxvt-popup")	2040	"-pe" => "urxvt-popup",
1921	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	}
1922	}	2048	}
1923		2049
1924	sub DESTROY {	2050	sub DESTROY {
1925	my ($self) = @_;	2051	my ($self) = @_;
1926		2052
…		…
1931	=back	2057	=back
1932		2058
1933	=cut	2059	=cut
1934		2060
1935	package urxvt::watcher;	2061	package urxvt::watcher;
1936
1937	@urxvt::timer::ISA = __PACKAGE__;
1938	@urxvt::iow::ISA = __PACKAGE__;
1939	@urxvt::pw::ISA = __PACKAGE__;
1940	@urxvt::iw::ISA = __PACKAGE__;
1941		2062
1942	=head2 The C<urxvt::timer> Class	2063	=head2 The C<urxvt::timer> Class
1943		2064
1944	This class implements timer watchers/events. Time is represented as a	2065	This class implements timer watchers/events. Time is represented as a
1945	fractional number of seconds since the epoch. Example:	2066	fractional number of seconds since the epoch. Example:
…		…
1949	->new	2070	->new
1950	->interval (1)	2071	->interval (1)
1951	->cb (sub {	2072	->cb (sub {
1952	$term->{overlay}->set (0, 0,	2073	$term->{overlay}->set (0, 0,
1953	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2074	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1954	});	2075	});
1955		2076
1956	=over 4	2077	=over 4
1957		2078
1958	=item $timer = new urxvt::timer	2079	=item $timer = new urxvt::timer
1959		2080
…		…
1962		2083
1963	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2084	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1964		2085
1965	Set the callback to be called when the timer triggers.	2086	Set the callback to be called when the timer triggers.
1966		2087
1967	=item $tstamp = $timer->at
1968
1969	Return the time this watcher will fire next.
1970
1971	=item $timer = $timer->set ($tstamp)	2088	=item $timer = $timer->set ($tstamp[, $interval])
1972		2089
1973	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).
1974		2092
1975	=item $timer = $timer->interval ($interval)	2093	=item $timer = $timer->interval ($interval)
1976		2094
1977	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
1978	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
1979	is automatically rescheduled at the given intervals.	2097	is automatically rescheduled at the given intervals.
1980		2098
1981	=item $timer = $timer->start	2099	=item $timer = $timer->start
1982		2100
1983	Start the timer.	2101	Start the timer.
1984		2102
1985	=item $timer = $timer->start ($tstamp)	2103	=item $timer = $timer->start ($tstamp[, $interval])
1986		2104
1987	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.
1988		2107
1989	=item $timer = $timer->after ($delay)	2108	=item $timer = $timer->after ($delay[, $interval])
1990		2109
1991	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>.
1992		2111
1993	=item $timer = $timer->stop	2112	=item $timer = $timer->stop
1994		2113
…		…
2002		2121
2003	$term->{socket} = ...	2122	$term->{socket} = ...
2004	$term->{iow} = urxvt::iow	2123	$term->{iow} = urxvt::iow
2005	->new	2124	->new
2006	->fd (fileno $term->{socket})	2125	->fd (fileno $term->{socket})
2007	->events (urxvt::EVENT_READ)	2126	->events (urxvt::EV_READ)
2008	->start	2127	->start
2009	->cb (sub {	2128	->cb (sub {
2010	my ($iow, $revents) = @_;	2129	my ($iow, $revents) = @_;
2011	# $revents must be 1 here, no need to check	2130	# $revents must be 1 here, no need to check
2012	sysread $term->{socket}, my $buf, 8192	2131	sysread $term->{socket}, my $buf, 8192
…		…
2030	Set the file descriptor (not handle) to watch.	2149	Set the file descriptor (not handle) to watch.
2031		2150
2032	=item $iow = $iow->events ($eventmask)	2151	=item $iow = $iow->events ($eventmask)
2033		2152
2034	Set the event mask to watch. The only allowed values are	2153	Set the event mask to watch. The only allowed values are
2035	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
2036	together, or C<urxvt::EVENT_NONE>.	2155	together, or C<urxvt::EV_NONE>.
2037		2156
2038	=item $iow = $iow->start	2157	=item $iow = $iow->start
2039		2158
2040	Start watching for requested events on the given handle.	2159	Start watching for requested events on the given handle.
2041		2160
…		…
2082	->new	2201	->new
2083	->start ($pid)	2202	->start ($pid)
2084	->cb (sub {	2203	->cb (sub {
2085	my ($pw, $exit_status) = @_;	2204	my ($pw, $exit_status) = @_;
2086	...	2205	...
2087	});	2206	});
2088		2207
2089	=over 4	2208	=over 4
2090		2209
2091	=item $pw = new urxvt::pw	2210	=item $pw = new urxvt::pw
2092		2211
…		…
2131	http://software.schmorp.de/pkg/rxvt-unicode	2250	http://software.schmorp.de/pkg/rxvt-unicode
2132		2251
2133	=cut	2252	=cut
2134		2253
2135	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.146 by root, Thu Aug 17 21:56:11 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.146 by root, Thu Aug 17 21:56:11 2006 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC