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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC vs.
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
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
…		…
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	Intelligent selection. This extension tries to be more intelligent when
45	the user extends selections (double-click). Right now, it tries to select	45	the user extends selections (double-click). Right now, it tries to select
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	urls and complete shell-quoted arguments, which is very convenient, too,
47	if your F<ls> supports C<--quoting-style=shell>.	47	if your F<ls> supports C<--quoting-style=shell>.
…		…
56		56
57	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
58		58
59	=back	59	=back
60		60
		61	=item option-popup (enabled by default)
		62
		63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		64	runtime.
		65
		66	=item selection-popup (enabled by default)
		67
		68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		69	text into various other formats/action.
		70
		71	=item searchable-scrollback<hotkey> (enabled by default)
		72
		73	Adds regex search functionality to the scrollback buffer, triggered
		74	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		75	input/output is suspended.
		76
		77	C</> starts an incremental regex search, C<n> searches further, C<p> or
		78	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
		79	history, C<enter> leaves search mode at the current position and C<escape>
		80	returns to the original position.
		81
61	=item digital-clock	82	=item digital-clock
62		83
63	Displays a digital clock using the built-in overlay.	84	Displays a digital clock using the built-in overlay.
64		85
65	=item mark-urls	86	=item mark-urls
66		87
67	Uses per-line filtering (C<on_line_update>) to underline urls.	88	Uses per-line display filtering (C<on_line_update>) to underline urls.
		89
		90	=item block-graphics-to-ascii
		91
		92	A not very useful example of filtering all text output to the terminal,
		93	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		94	similar-looking ascii character.
68		95
69	=item example-refresh-hooks	96	=item example-refresh-hooks
70		97
71	Displays a very simple digital clock in the upper right corner of the	98	Displays a very simple digital clock in the upper right corner of the
72	window. Illustrates overwriting the refresh callbacks to create your own	99	window. Illustrates overwriting the refresh callbacks to create your own
73	overlays or changes.	100	overlays or changes.
74
75	=item example-filter-input
76
77	A not very useful example of filtering all text output to the terminal, by
78	underlining all urls that matches a certain regex (i.e. some urls :). It
79	is not very useful because urls that are output in multiple steps (e.g.
80	when typing them) do not get marked.
81		101
82	=back	102	=back
83		103
84	=head2 General API Considerations	104	=head2 General API Considerations
85		105
…		…
115	Either binary data or - more common - a text string encoded in a	135	Either binary data or - more common - a text string encoded in a
116	locale-specific way.	136	locale-specific way.
117		137
118	=back	138	=back
119		139
		140	=head2 Extension Objects
		141
		142	Very perl extension is a perl class. A separate perl object is created
		143	for each terminal and each extension and passed as the first parameter to
		144	hooks. So extensions can use their C<$self> object without having to think
		145	about other extensions, with the exception of methods and members that
		146	begin with an underscore character C<_>: these are reserved for internal
		147	use.
		148
		149	Although it isn't a C<urxvt::term> object, you can call all methods of the
		150	C<urxvt::term> class on this object.
		151
		152	It has the following methods and data members:
		153
		154	=over 4
		155
		156	=item $urxvt_term = $self->{term}
		157
		158	Returns the C<urxvt::term> object associated with this instance of the
		159	extension. This member I<must not> be changed in any way.
		160
		161	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		162
		163	Dynamically enable the given hooks (named without the C<on_> prefix) for
		164	this extension, replacing any previous hook. This is useful when you want
		165	to overwrite time-critical hooks only temporarily.
		166
		167	=item $self->disable ($hook_name[, $hook_name..])
		168
		169	Dynamically disable the given hooks.
		170
		171	=back
		172
120	=head2 Hooks	173	=head2 Hooks
121		174
122	The following subroutines can be declared in loaded scripts, and will be	175	The following subroutines can be declared in extension files, and will be
123	called whenever the relevant event happens.	176	called whenever the relevant event happens.
124		177
125	The first argument passed to them is an object private to each terminal	178	The first argument passed to them is an extension oject as described in
126	and extension package. You can call all C<urxvt::term> methods on it, but	179	the in the C<Extension Objects> section.
127	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
128	object that is shared between all packages is stored in the C<term>
129	member.
130		180
131	All of them must return a boolean value. If it is true, then the event	181	B<All> of these hooks must return a boolean value. If it is true, then the
132	counts as being I<consumed>, and the invocation of other hooks is skipped,	182	event counts as being I<consumed>, and the invocation of other hooks is
133	and the relevant action might not be carried out by the C++ code.	183	skipped, and the relevant action might not be carried out by the C++ code.
134		184
135	When in doubt, return a false value (preferably C<()>).	185	I<< When in doubt, return a false value (preferably C<()>). >>
136		186
137	=over 4	187	=over 4
138		188
139	=item on_init $term	189	=item on_init $term
140		190
141	Called after a new terminal object has been initialized, but before	191	Called after a new terminal object has been initialized, but before
142	windows are created or the command gets run.	192	windows are created or the command gets run. Most methods are unsafe to
		193	call or deliver senseless data, as terminal size and other characteristics
		194	have not yet been determined. You can safely query and change resources,
		195	though.
143		196
144	=item on_reset $term	197	=item on_reset $term
145		198
146	Called after the screen is "reset" for any reason, such as resizing or	199	Called after the screen is "reset" for any reason, such as resizing or
147	control sequences. Here is where you can react on changes to size-related	200	control sequences. Here is where you can react on changes to size-related
…		…
176	should extend the selection itelf and return true to suppress the built-in	229	should extend the selection itelf and return true to suppress the built-in
177	processing.	230	processing.
178		231
179	See the F<selection> example extension.	232	See the F<selection> example extension.
180		233
181	=item on_focus_in $term
182
183	Called whenever the window gets the keyboard focus, before urxvt does
184	focus in processing.
185
186	=item on_focus_out $term
187
188	Called wheneever the window loses keyboard focus, before urxvt does focus
189	out processing.
190
191	=item on_view_change $term, $offset	234	=item on_view_change $term, $offset
192		235
193	Called whenever the view offset changes, i..e the user or program	236	Called whenever the view offset changes, i..e the user or program
194	scrolls. Offset C<0> means display the normal terminal, positive values	237	scrolls. Offset C<0> means display the normal terminal, positive values
195	show this many lines of scrollback.	238	show this many lines of scrollback.
…		…
201	than the scroll back buffer or the terminal.	244	than the scroll back buffer or the terminal.
202		245
203	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	246	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
204	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	247	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
205	number of lines that will be in the scrollback buffer.	248	number of lines that will be in the scrollback buffer.
206
207	=item on_tty_activity $term NYI
208
209	Called whenever the program(s) running in the urxvt window send output.
210		249
211	=item on_osc_seq $term, $string	250	=item on_osc_seq $term, $string
212		251
213	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	252	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
214	operating system command) is processed. Cursor position and other state	253	operating system command) is processed. Cursor position and other state
…		…
227	can filter/change and output the text yourself by returning a true value	266	can filter/change and output the text yourself by returning a true value
228	and calling C<< $term->scr_add_lines >> yourself. Please note that this	267	and calling C<< $term->scr_add_lines >> yourself. Please note that this
229	might be very slow, however, as your hook is called for B<all> text being	268	might be very slow, however, as your hook is called for B<all> text being
230	output.	269	output.
231		270
		271	=item on_tt_write $term, $octets
		272
		273	Called whenever some data is written to the tty/pty and can be used to
		274	suppress or filter tty input.
		275
232	=item on_line_update $term, $row	276	=item on_line_update $term, $row
233		277
234	Called whenever a line was updated or changed. Can be used to filter	278	Called whenever a line was updated or changed. Can be used to filter
235	screen output (e.g. underline urls or other useless stuff). Only lines	279	screen output (e.g. underline urls or other useless stuff). Only lines
236	that are being shown will be filtered, and, due to performance reasons,	280	that are being shown will be filtered, and, due to performance reasons,
…		…
258		302
259	Called whenever the user presses a key combination that has a	303	Called whenever the user presses a key combination that has a
260	C<perl:string> action bound to it (see description of the B<keysym>	304	C<perl:string> action bound to it (see description of the B<keysym>
261	resource in the @@RXVT_NAME@@(1) manpage).	305	resource in the @@RXVT_NAME@@(1) manpage).
262		306
		307	=item on_focus_in $term
		308
		309	Called whenever the window gets the keyboard focus, before rxvt-unicode
		310	does focus in processing.
		311
		312	=item on_focus_out $term
		313
		314	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		315	focus out processing.
		316
		317	=item on_key_press $term, $event, $keysym, $octets
		318
		319	=item on_key_release $term, $event, $keysym
		320
		321	=item on_button_press $term, $event
		322
		323	=item on_button_release $term, $event
		324
		325	=item on_motion_notify $term, $event
		326
		327	=item on_map_notify $term, $event
		328
		329	=item on_unmap_notify $term, $event
		330
		331	Called whenever the corresponding X event is received for the terminal If
		332	the hook returns true, then the even will be ignored by rxvt-unicode.
		333
		334	The event is a hash with most values as named by Xlib (see the XEvent
		335	manpage), with the additional members C<row> and C<col>, which are the row
		336	and column under the mouse cursor.
		337
		338	C<on_key_press> additionally receives the string rxvt-unicode would
		339	output, if any, in locale-specific encoding.
		340
		341	subwindow.
		342
263	=back	343	=back
264		344
265	=head2 Variables in the C<urxvt> Package	345	=head2 Variables in the C<urxvt> Package
266		346
267	=over 4	347	=over 4
268		348
269	=item $urxvt::TERM	349	=item $urxvt::TERM
270		350
271	The current terminal. Whenever a callback/Hook is bein executed, this	351	The current terminal. This variable stores the current C<urxvt::term>
272	variable stores the current C<urxvt::term> object.	352	object, whenever a callback/hook is executing.
273		353
274	=back	354	=back
275		355
276	=head2 Functions in the C<urxvt> Package	356	=head2 Functions in the C<urxvt> Package
277		357
278	=over 4	358	=over 4
		359
		360	=item $term = new urxvt [arg...]
		361
		362	Creates a new terminal, very similar as if you had started it with
		363	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		364	if the new instance couldn't be created. Returns C<undef> if the new
		365	instance didn't initialise perl, and the terminal object otherwise. The
		366	C<init> and C<start> hooks will be called during the call.
279		367
280	=item urxvt::fatal $errormessage	368	=item urxvt::fatal $errormessage
281		369
282	Fatally aborts execution with the given error message. Avoid at all	370	Fatally aborts execution with the given error message. Avoid at all
283	costs! The only time this is acceptable is when the terminal process	371	costs! The only time this is acceptable is when the terminal process
…		…
290	that calls this function.	378	that calls this function.
291		379
292	Using this function has the advantage that its output ends up in the	380	Using this function has the advantage that its output ends up in the
293	correct place, e.g. on stderr of the connecting urxvtc client.	381	correct place, e.g. on stderr of the connecting urxvtc client.
294		382
		383	=item $is_safe = urxvt::safe
		384
		385	Returns true when it is safe to do potentially unsafe things, such as
		386	evaluating perl code specified by the user. This is true when urxvt was
		387	started setuid or setgid.
		388
295	=item $time = urxvt::NOW	389	=item $time = urxvt::NOW
296		390
297	Returns the "current time" (as per the event loop).	391	Returns the "current time" (as per the event loop).
		392
		393	=item urxvt::CurrentTime
		394
		395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		397	Button4Mask, Button5Mask, AnyModifier
		398
		399	Various constants for use in X calls and event processing.
298		400
299	=back	401	=back
300		402
301	=head2 RENDITION	403	=head2 RENDITION
302		404
…		…
352		454
353	=cut	455	=cut
354		456
355	package urxvt;	457	package urxvt;
356		458
		459	use utf8;
357	use strict;	460	use strict;
		461	use Carp ();
358	use Scalar::Util ();	462	use Scalar::Util ();
		463	use List::Util ();
359		464
		465	our $VERSION = 1;
360	our $TERM;	466	our $TERM;
361	our @HOOKNAME;	467	our @HOOKNAME;
		468	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		469	our %OPTION;
		470
362	our $LIBDIR;	471	our $LIBDIR;
		472	our $RESNAME;
		473	our $RESCLASS;
		474	our $RXVTNAME;
363		475
364	BEGIN {	476	BEGIN {
365	urxvt->bootstrap;	477	urxvt->bootstrap;
366		478
367	# overwrite perl's warn	479	# overwrite perl's warn
…		…
369	my $msg = join "", @_;	481	my $msg = join "", @_;
370	$msg .= "\n"	482	$msg .= "\n"
371	unless $msg =~ /\n$/;	483	unless $msg =~ /\n$/;
372	urxvt::warn ($msg);	484	urxvt::warn ($msg);
373	};	485	};
		486
		487	delete $ENV{IFS};
		488	delete $ENV{CDPATH};
		489	delete $ENV{BASH_ENV};
		490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
374	}	491	}
375		492
376	my @hook_count;	493	my @hook_count;
377	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
378		495
379	sub verbose {	496	sub verbose {
380	my ($level, $msg) = @_;	497	my ($level, $msg) = @_;
381	warn "$msg\n" if $level <= $verbosity;	498	warn "$msg\n" if $level <= $verbosity;
382	}	499	}
383		500
384	# find on_xxx subs in the package and register them	501	my $extension_pkg = "extension0000";
385	# as hooks	502	my %extension_pkg;
386	sub register_package($) {
387	my ($pkg) = @_;
388
389	for my $htype (0.. $#HOOKNAME) {
390	my $name = $HOOKNAME[$htype];
391
392	my $ref = $pkg->can ("on_" . lc $name)
393	or next;
394
395	$TERM->{_hook}[$htype]{$pkg} = $ref;
396	$hook_count[$htype]++
397	or set_should_invoke $htype, 1;
398	}
399	}
400
401	my $script_pkg = "script0000";
402	my %script_pkg;
403		503
404	# load a single script into its own package, once only	504	# load a single script into its own package, once only
405	sub script_package($) {	505	sub extension_package($) {
406	my ($path) = @_;	506	my ($path) = @_;
407		507
408	$script_pkg{$path} \|\|= do {	508	$extension_pkg{$path} \|\|= do {
409	my $pkg = "urxvt::" . ($script_pkg++);	509	my $pkg = "urxvt::" . ($extension_pkg++);
410		510
411	verbose 3, "loading script '$path' into package '$pkg'";	511	verbose 3, "loading extension '$path' into package '$pkg'";
412		512
413	open my $fh, "<:raw", $path	513	open my $fh, "<:raw", $path
414	or die "$path: $!";	514	or die "$path: $!";
415		515
		516	my $source = untaint
416	my $source = "package $pkg; use strict; use utf8;\n"	517	"package $pkg; use strict; use utf8;\n"
		518	. "use base urxvt::term::extension::;\n"
417	. "#line 1 \"$path\"\n{\n"	519	. "#line 1 \"$path\"\n{\n"
418	. (do { local $/; <$fh> })	520	. (do { local $/; <$fh> })
419	. "\n};\n1";	521	. "\n};\n1";
420		522
		523	eval $source
421	eval $source or die "$path: $@";	524	or die "$path: $@";
422		525
423	$pkg	526	$pkg
424	}	527	}
425	}	528	}
426		529
…		…
431	local $TERM = shift;	534	local $TERM = shift;
432	my $htype = shift;	535	my $htype = shift;
433		536
434	if ($htype == 0) { # INIT	537	if ($htype == 0) { # INIT
435	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	538	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		539
		540	my %ext_arg;
436		541
437	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	542	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		543	if ($_ eq "default") {
		544	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		545	} elsif (/^-(.*)$/) {
		546	delete $ext_arg{$1};
		547	} elsif (/^([^<]+)<(.*)>$/) {
		548	push @{ $ext_arg{$1} }, $2;
		549	} else {
		550	$ext_arg{$_} \|\|= [];
		551	}
		552	}
		553
		554	while (my ($ext, $argv) = each %ext_arg) {
438	my @files = grep -f $_, map "$_/$ext", @dirs;	555	my @files = grep -f $_, map "$_/$ext", @dirs;
439		556
440	if (@files) {	557	if (@files) {
441	register_package script_package $files[0];	558	$TERM->register_package (extension_package $files[0], $argv);
442	} else {	559	} else {
443	warn "perl extension '$ext' not found in perl library search path\n";	560	warn "perl extension '$ext' not found in perl library search path\n";
444	}	561	}
445	}	562	}
		563
		564	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		565	warn $@ if $@;
446	}	566	}
447		567
448	$retval = undef;	568	$retval = undef;
449		569
450	if (my $cb = $TERM->{_hook}[$htype]) {	570	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
452	if $verbosity >= 10;	572	if $verbosity >= 10;
453		573
454	keys %$cb;	574	keys %$cb;
455		575
456	while (my ($pkg, $cb) = each %$cb) {	576	while (my ($pkg, $cb) = each %$cb) {
457	$retval = $cb->(	577	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
458	$TERM->{_pkg}{$pkg} \|\|= do {
459	my $proxy = bless { }, urxvt::term::proxy::;
460	Scalar::Util::weaken ($proxy->{term} = $TERM);
461	$proxy
462	},
463	@_,
464	) and last;	578	and last;
		579
		580	if ($@) {
		581	$TERM->ungrab; # better to lose the grab than the session
		582	warn $@;
		583	}
465	}	584	}
466	}	585	}
467		586
468	if ($htype == 1) { # DESTROY	587	if ($htype == 1) { # DESTROY
469	# remove hooks if unused
470	if (my $hook = $TERM->{_hook}) {	588	if (my $hook = delete $TERM->{_hook}) {
471	for my $htype (0..$#$hook) {	589	for my $htype (0..$#$hook) {
472	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
473	or set_should_invoke $htype, 0;	591	or set_should_invoke $htype, 0;
474	}	592	}
475	}	593	}
…		…
482	}	600	}
483		601
484	$retval	602	$retval
485	}	603	}
486		604
487	sub urxvt::term::proxy::AUTOLOAD {	605	# urxvt::term::extension
488	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	606
		607	package urxvt::term::extension;
		608
		609	sub enable {
		610	my ($self, %hook) = @_;
		611	my $pkg = $self->{_pkg};
		612
		613	while (my ($name, $cb) = each %hook) {
		614	my $htype = $HOOKTYPE{uc $name};
		615	defined $htype
		616	or Carp::croak "unsupported hook type '$name'";
		617
		618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		619	$hook_count[$htype]++
		620	or urxvt::set_should_invoke $htype, 1;
		621	}
		622
		623	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		624	}
		625	}
		626
		627	sub disable {
		628	my ($self, @hook) = @_;
		629	my $pkg = $self->{_pkg};
		630
		631	for my $name (@hook) {
		632	my $htype = $HOOKTYPE{uc $name};
		633	defined $htype
		634	or Carp::croak "unsupported hook type '$name'";
		635
		636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		637	--$hook_count[$htype]
		638	or urxvt::set_should_invoke $htype, 0;
		639	}
		640	}
		641	}
		642
		643	our $AUTOLOAD;
		644
		645	sub AUTOLOAD {
		646	$AUTOLOAD =~ /:([^:]+)$/
489	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	647	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
490		648
491	eval qq{	649	eval qq{
492	sub $urxvt::term::proxy::AUTOLOAD {	650	sub $AUTOLOAD {
493	my \$proxy = shift;	651	my \$proxy = shift;
494	\$proxy->{term}->$1 (\@_)	652	\$proxy->{term}->$1 (\@_)
495	}	653	}
496	1	654	1
497	} or die "FATAL: unable to compile method forwarder: $@";	655	} or die "FATAL: unable to compile method forwarder: $@";
498		656
499	goto &$urxvt::term::proxy::AUTOLOAD;	657	goto &$AUTOLOAD;
500	}	658	}
		659
		660	sub DESTROY {
		661	# nop
		662	}
		663
		664	# urxvt::destroy_hook
		665
		666	sub urxvt::destroy_hook::DESTROY {
		667	${$_[0]}->();
		668	}
		669
		670	sub urxvt::destroy_hook(&) {
		671	bless \shift, urxvt::destroy_hook::
		672	}
		673
		674	package urxvt::anyevent;
		675
		676	=head2 The C<urxvt::anyevent> Class
		677
		678	The sole purpose of this class is to deliver an interface to the
		679	C<AnyEvent> module - any module using it will work inside urxvt without
		680	further work. The only exception is that you cannot wait on condition
		681	variables, but non-blocking condvar use is ok. What this means is that you
		682	cannot use blocking APIs, but the non-blocking variant should work.
		683
		684	=cut
		685
		686	our $VERSION = 1;
		687
		688	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		689	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		690
		691	sub timer {
		692	my ($class, %arg) = @_;
		693
		694	my $cb = $arg{cb};
		695
		696	urxvt::timer
		697	->new
		698	->start (urxvt::NOW + $arg{after})
		699	->cb (sub {
		700	$_[0]->stop; # need to cancel manually
		701	$cb->();
		702	})
		703	}
		704
		705	sub io {
		706	my ($class, %arg) = @_;
		707
		708	my $cb = $arg{cb};
		709
		710	bless [$arg{fh}, urxvt::iow
		711	->new
		712	->fd (fileno $arg{fh})
		713	->events (($arg{poll} =~ /r/ ? 1 : 0)
		714	\| ($arg{poll} =~ /w/ ? 2 : 0))
		715	->start
		716	->cb (sub {
		717	$cb->(($_[1] & 1 ? 'r' : '')
		718	. ($_[1] & 2 ? 'w' : ''));
		719	})],
		720	urxvt::anyevent::
		721	}
		722
		723	sub DESTROY {
		724	$_[0][1]->stop;
		725	}
		726
		727	sub condvar {
		728	bless \my $flag, urxvt::anyevent::condvar::
		729	}
		730
		731	sub urxvt::anyevent::condvar::broadcast {
		732	${$_[0]}++;
		733	}
		734
		735	sub urxvt::anyevent::condvar::wait {
		736	unless (${$_[0]}) {
		737	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		738	}
		739	}
		740
		741	package urxvt::term;
501		742
502	=head2 The C<urxvt::term> Class	743	=head2 The C<urxvt::term> Class
503		744
504	=over 4	745	=over 4
		746
		747	=cut
		748
		749	# find on_xxx subs in the package and register them
		750	# as hooks
		751	sub register_package {
		752	my ($self, $pkg, $argv) = @_;
		753
		754	my $proxy = bless {
		755	_pkg => $pkg,
		756	argv => $argv,
		757	}, $pkg;
		758	Scalar::Util::weaken ($proxy->{term} = $self);
		759
		760	$self->{_pkg}{$pkg} = $proxy;
		761
		762	for my $name (@HOOKNAME) {
		763	if (my $ref = $pkg->can ("on_" . lc $name)) {
		764	$proxy->enable ($name => $ref);
		765	}
		766	}
		767	}
		768
		769	=item $term->destroy
		770
		771	Destroy the terminal object (close the window, free resources etc.).
		772
		773	=item $isset = $term->option ($optval[, $set])
		774
		775	Returns true if the option specified by C<$optval> is enabled, and
		776	optionally change it. All option values are stored by name in the hash
		777	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		778
		779	Here is a a likely non-exhaustive list of option names, please see the
		780	source file F</src/optinc.h> to see the actual list:
		781
		782	borderLess console cursorBlink cursorUnderline hold iconic insecure
		783	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		784	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		785	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		786	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		787	tripleclickwords utmpInhibit visualBell
505		788
506	=item $value = $term->resource ($name[, $newval])	789	=item $value = $term->resource ($name[, $newval])
507		790
508	Returns the current resource value associated with a given name and	791	Returns the current resource value associated with a given name and
509	optionally sets a new value. Setting values is most useful in the C<init>	792	optionally sets a new value. Setting values is most useful in the C<init>
…		…
519		802
520	Please note that resource strings will currently only be freed when the	803	Please note that resource strings will currently only be freed when the
521	terminal is destroyed, so changing options frequently will eat memory.	804	terminal is destroyed, so changing options frequently will eat memory.
522		805
523	Here is a a likely non-exhaustive list of resource names, not all of which	806	Here is a a likely non-exhaustive list of resource names, not all of which
524	are supported in every build, please see the source to see the actual	807	are supported in every build, please see the source file F</src/rsinc.h>
525	list:	808	to see the actual list:
526		809
527	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	810	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
528	borderLess color cursorBlink cursorUnderline cutchars delete_key	811	borderLess color cursorBlink cursorUnderline cutchars delete_key
529	display_name embed ext_bwidth fade font geometry hold iconName	812	display_name embed ext_bwidth fade font geometry hold iconName
530	imFont imLocale inputMethod insecure int_bwidth intensityStyles	813	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
537	shade term_name title transparent transparent_all tripleclickwords	820	shade term_name title transparent transparent_all tripleclickwords
538	utmpInhibit visualBell	821	utmpInhibit visualBell
539		822
540	=cut	823	=cut
541		824
542	sub urxvt::term::resource($$;$) {	825	sub resource($$;$) {
543	my ($self, $name) = (shift, shift);	826	my ($self, $name) = (shift, shift);
544	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
545	goto &urxvt::term::_resource;	828	&urxvt::term::_resource
546	}	829	}
		830
		831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		832
		833	Adds a keymap translation exactly as specified via a resource. See the
		834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
547		835
548	=item $rend = $term->rstyle ([$new_rstyle])	836	=item $rend = $term->rstyle ([$new_rstyle])
549		837
550	Return and optionally change the current rendition. Text that is output by	838	Return and optionally change the current rendition. Text that is output by
551	the terminal application will use this style.	839	the terminal application will use this style.
…		…
571		859
572	=item $oldtext = $term->selection ([$newtext])	860	=item $oldtext = $term->selection ([$newtext])
573		861
574	Return the current selection text and optionally replace it by C<$newtext>.	862	Return the current selection text and optionally replace it by C<$newtext>.
575		863
576	#=item $term->overlay ($x, $y, $text)	864	=item $term->overlay_simple ($x, $y, $text)
577	#	865
578	#Create a simple multi-line overlay box. See the next method for details.	866	Create a simple multi-line overlay box. See the next method for details.
579	#	867
580	#=cut	868	=cut
581	#	869
582	#sub urxvt::term::scr_overlay {	870	sub overlay_simple {
583	# my ($self, $x, $y, $text) = @_;	871	my ($self, $x, $y, $text) = @_;
584	#	872
585	# my @lines = split /\n/, $text;	873	my @lines = split /\n/, $text;
586	#	874
587	# my $w = 0;	875	my $w = List::Util::max map $self->strwidth ($_), @lines;
588	# for (map $self->strwidth ($_), @lines) {	876
589	# $w = $_ if $w < $_;
590	# }
591	#
592	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	877	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
593	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	878	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
594	#}	879
		880	$overlay
		881	}
595		882
596	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	883	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
597		884
598	Create a new (empty) overlay at the given position with the given	885	Create a new (empty) overlay at the given position with the given
599	width/height. C<$rstyle> defines the initial rendition style	886	width/height. C<$rstyle> defines the initial rendition style
…		…
626		913
627	If hidden, display the overlay again.	914	If hidden, display the overlay again.
628		915
629	=back	916	=back
630		917
		918	=item $popup = $term->popup ($event)
		919
		920	Creates a new C<urxvt::popup> object that implements a popup menu. The
		921	C<$event> I<must> be the event causing the menu to pop up (a button event,
		922	currently).
		923
		924	=cut
		925
		926	sub popup {
		927	my ($self, $event) = @_;
		928
		929	$self->grab ($event->{time}, 1)
		930	or return;
		931
		932	my $popup = bless {
		933	term => $self,
		934	event => $event,
		935	}, urxvt::popup::;
		936
		937	Scalar::Util::weaken $popup->{term};
		938
		939	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		940	Scalar::Util::weaken $self->{_destroy}{$popup};
		941
		942	$popup
		943	}
		944
631	=item $cellwidth = $term->strwidth $string	945	=item $cellwidth = $term->strwidth ($string)
632		946
633	Returns the number of screen-cells this string would need. Correctly	947	Returns the number of screen-cells this string would need. Correctly
634	accounts for wide and combining characters.	948	accounts for wide and combining characters.
635		949
636	=item $octets = $term->locale_encode $string	950	=item $octets = $term->locale_encode ($string)
637		951
638	Convert the given text string into the corresponding locale encoding.	952	Convert the given text string into the corresponding locale encoding.
639		953
640	=item $string = $term->locale_decode $octets	954	=item $string = $term->locale_decode ($octets)
641		955
642	Convert the given locale-encoded octets into a perl string.	956	Convert the given locale-encoded octets into a perl string.
		957
		958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		959
		960	XORs the rendition values in the given span with the provided value
		961	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		962	to the selection.
		963
		964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		965
		966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		967	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		968	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		969	it instead.
		970
		971	=item $term->scr_bell
		972
		973	Ring the bell!
643		974
644	=item $term->scr_add_lines ($string)	975	=item $term->scr_add_lines ($string)
645		976
646	Write the given text string to the screen, as if output by the application	977	Write the given text string to the screen, as if output by the application
647	running inside the terminal. It may not contain command sequences (escape	978	running inside the terminal. It may not contain command sequences (escape
…		…
650		981
651	Normally its not a good idea to use this function, as programs might be	982	Normally its not a good idea to use this function, as programs might be
652	confused by changes in cursor position or scrolling. Its useful inside a	983	confused by changes in cursor position or scrolling. Its useful inside a
653	C<on_add_lines> hook, though.	984	C<on_add_lines> hook, though.
654		985
		986	=item $term->cmd_parse ($octets)
		987
		988	Similar to C<scr_add_lines>, but the argument must be in the
		989	locale-specific encoding of the terminal and can contain command sequences
		990	(escape codes) that will be interpreted.
		991
655	=item $term->tt_write ($octets)	992	=item $term->tt_write ($octets)
656		993
657	Write the octets given in C<$data> to the tty (i.e. as program input). To	994	Write the octets given in C<$data> to the tty (i.e. as program input). To
658	pass characters instead of octets, you should convert your strings first	995	pass characters instead of octets, you should convert your strings first
659	to the locale-specific encoding using C<< $term->locale_encode >>.	996	to the locale-specific encoding using C<< $term->locale_encode >>.
660		997
		998	=item $old_events = $term->pty_ev_events ([$new_events])
		999
		1000	Replaces the event mask of the pty watcher by the given event mask. Can
		1001	be used to suppress input and output handling to the pty/tty. See the
		1002	description of C<< urxvt::timer->events >>. Make sure to always restore
		1003	the previous value.
		1004
		1005	=item $windowid = $term->parent
		1006
		1007	Return the window id of the toplevel window.
		1008
		1009	=item $windowid = $term->vt
		1010
		1011	Return the window id of the terminal window.
		1012
661	=item $window_width = $term->width	1013	=item $window_width = $term->width
662		1014
663	=item $window_height = $term->height	1015	=item $window_height = $term->height
664		1016
665	=item $font_width = $term->fwidth	1017	=item $font_width = $term->fwidth
…		…
681	=item $nrow_plus_saveLines = $term->total_rows	1033	=item $nrow_plus_saveLines = $term->total_rows
682		1034
683	=item $lines_in_scrollback = $term->nsaved	1035	=item $lines_in_scrollback = $term->nsaved
684		1036
685	Return various integers describing terminal characteristics.	1037	Return various integers describing terminal characteristics.
		1038
		1039	=item $lc_ctype = $term->locale
		1040
		1041	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1042
		1043	=item $x_display = $term->display_id
		1044
		1045	Return the DISPLAY used by rxvt-unicode.
		1046
		1047	=item $modifiermask = $term->ModLevel3Mask
		1048
		1049	=item $modifiermask = $term->ModMetaMask
		1050
		1051	=item $modifiermask = $term->ModNumLockMask
		1052
		1053	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1054	AltGr), the meta key (often Alt) and the num lock key, if applicable.
686		1055
687	=item $view_start = $term->view_start ([$newvalue])	1056	=item $view_start = $term->view_start ([$newvalue])
688		1057
689	Returns the negative row number of the topmost line. Minimum value is	1058	Returns the negative row number of the topmost line. Minimum value is
690	C<0>, which displays the normal terminal contents. Larger values scroll	1059	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
784		1153
785	=back	1154	=back
786		1155
787	=cut	1156	=cut
788		1157
789	sub urxvt::term::line {	1158	sub line {
790	my ($self, $row) = @_;	1159	my ($self, $row) = @_;
791		1160
792	my $maxrow = $self->nrow - 1;	1161	my $maxrow = $self->nrow - 1;
793		1162
794	my ($beg, $end) = ($row, $row);	1163	my ($beg, $end) = ($row, $row);
…		…
858	$offset / $self->{ncol} + $self->{beg},	1227	$offset / $self->{ncol} + $self->{beg},
859	$offset % $self->{ncol}	1228	$offset % $self->{ncol}
860	)	1229	)
861	}	1230	}
862		1231
863	=item ($row, $col) = $line->coord_of ($offset)
864	=item $text = $term->special_encode $string	1232	=item $text = $term->special_encode $string
865		1233
866	Converts a perl string into the special encoding used by rxvt-unicode,	1234	Converts a perl string into the special encoding used by rxvt-unicode,
867	where one character corresponds to one screen cell. See	1235	where one character corresponds to one screen cell. See
868	C<< $term->ROW_t >> for details.	1236	C<< $term->ROW_t >> for details.
…		…
870	=item $string = $term->special_decode $text	1238	=item $string = $term->special_decode $text
871		1239
872	Converts rxvt-unicodes text reprsentation into a perl string. See	1240	Converts rxvt-unicodes text reprsentation into a perl string. See
873	C<< $term->ROW_t >> for details.	1241	C<< $term->ROW_t >> for details.
874		1242
		1243	=item $success = $term->grab_button ($button, $modifiermask)
		1244
		1245	Registers a synchronous button grab. See the XGrabButton manpage.
		1246
		1247	=item $success = $term->grab ($eventtime[, $sync])
		1248
		1249	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1250	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1251
		1252	=item $term->allow_events_async
		1253
		1254	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1255
		1256	=item $term->allow_events_sync
		1257
		1258	Calls XAllowEvents with SyncBoth for the most recent grab.
		1259
		1260	=item $term->allow_events_replay
		1261
		1262	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1263	recent grab.
		1264
		1265	=item $term->ungrab
		1266
		1267	Calls XUngrab for the most recent grab. Is called automatically on
		1268	evaluation errors, as it is better to lose the grab in the error case as
		1269	the session.
		1270
875	=back	1271	=back
		1272
		1273	=cut
		1274
		1275	package urxvt::popup;
		1276
		1277	=head2 The C<urxvt::popup> Class
		1278
		1279	=over 4
		1280
		1281	=cut
		1282
		1283	sub add_item {
		1284	my ($self, $item) = @_;
		1285
		1286	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1287	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1288	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1289
		1290	$item->{render} \|\|= sub { $_[0]{text} };
		1291
		1292	push @{ $self->{item} }, $item;
		1293	}
		1294
		1295	sub add_separator {
		1296	my ($self, $sep) = @_;
		1297
		1298	$sep \|\|= "=";
		1299
		1300	$self->add_item ({
		1301	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1302	text => "",
		1303	render => sub { $sep x $self->{term}->ncol },
		1304	activate => sub { },
		1305	});
		1306	}
		1307
		1308	sub add_title {
		1309	my ($self, $title) = @_;
		1310
		1311	$self->add_item ({
		1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1313	text => $title,
		1314	activate => sub { },
		1315	});
		1316	}
		1317
		1318	sub add_button {
		1319	my ($self, $text, $cb) = @_;
		1320
		1321	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1322	}
		1323
		1324	sub add_toggle {
		1325	my ($self, $text, $cb, $value) = @_;
		1326
		1327	my $item; $item = {
		1328	type => "button",
		1329	text => " $text",
		1330	value => $value,
		1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1333	};
		1334
		1335	$self->add_item ($item);
		1336	}
		1337
		1338	sub show {
		1339	my ($self) = @_;
		1340
		1341	local $urxvt::popup::self = $self;
		1342
		1343	local $ENV{LC_ALL} = $self->{term}->locale;
		1344
		1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1346	"--transient-for" => $self->{term}->parent,
		1347	"-display" => $self->{term}->display_id,
		1348	"-pe" => "urxvt-popup")
		1349	or die "unable to create popup window\n";
		1350	}
		1351
		1352	sub DESTROY {
		1353	my ($self) = @_;
		1354
		1355	delete $self->{term}{_destroy}{$self};
		1356	$self->{term}->ungrab;
		1357	}
876		1358
877	=head2 The C<urxvt::timer> Class	1359	=head2 The C<urxvt::timer> Class
878		1360
879	This class implements timer watchers/events. Time is represented as a	1361	This class implements timer watchers/events. Time is represented as a
880	fractional number of seconds since the epoch. Example:	1362	fractional number of seconds since the epoch. Example:
…		…
933		1415
934	$term->{socket} = ...	1416	$term->{socket} = ...
935	$term->{iow} = urxvt::iow	1417	$term->{iow} = urxvt::iow
936	->new	1418	->new
937	->fd (fileno $term->{socket})	1419	->fd (fileno $term->{socket})
938	->events (1) # wait for read data	1420	->events (urxvt::EVENT_READ)
939	->start	1421	->start
940	->cb (sub {	1422	->cb (sub {
941	my ($iow, $revents) = @_;	1423	my ($iow, $revents) = @_;
942	# $revents must be 1 here, no need to check	1424	# $revents must be 1 here, no need to check
943	sysread $term->{socket}, my $buf, 8192	1425	sysread $term->{socket}, my $buf, 8192
…		…
960		1442
961	Set the filedescriptor (not handle) to watch.	1443	Set the filedescriptor (not handle) to watch.
962		1444
963	=item $iow = $iow->events ($eventmask)	1445	=item $iow = $iow->events ($eventmask)
964		1446
965	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1447	Set the event mask to watch. The only allowed values are
966	data, Bit #1 (value C<2>) enables watching for write data.	1448	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1449	together, or C<urxvt::EVENT_NONE>.
967		1450
968	=item $iow = $iow->start	1451	=item $iow = $iow->start
969		1452
970	Start watching for requested events on the given handle.	1453	Start watching for requested events on the given handle.
971		1454
…		…
982	This variable controls the verbosity level of the perl extension. Higher	1465	This variable controls the verbosity level of the perl extension. Higher
983	numbers indicate more verbose output.	1466	numbers indicate more verbose output.
984		1467
985	=over 4	1468	=over 4
986		1469
987	=item =0 - only fatal messages	1470	=item == 0 - fatal messages
988		1471
989	=item =3 - script loading and management	1472	=item >= 3 - script loading and management
990		1473
991	=item =10 - all events received	1474	=item >=10 - all events received
992		1475
993	=back	1476	=back
994		1477
995	=head1 AUTHOR	1478	=head1 AUTHOR
996		1479

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC vs. Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC vs.
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC