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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC vs.
Revision 1.120 by root, Fri Jan 20 22:05:41 2006 UTC

…		…
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
39		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
…		…
87		91
88	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
89		93
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	96	evaluation, web-browser starting etc.), depending on content.
93		97
94	Other extensions can extend this popup menu by pushing a code reference onto	98	Other extensions can extend this popup menu by pushing a code reference
95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.	99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
96		101
97	It's sole argument is the popup menu, which can be modified. The selection	102	It's sole argument is the popup menu, which can be modified. The selection
98	is in C<$_>, which can be used to decide wether to add something or not.	103	is in C<$_>, which can be used to decide wether to add something or not.
99	It should either return nothing or a string and a code reference. The	104	It should either return nothing or a string and a code reference. The
100	string will be used as button text and the code reference will be called	105	string will be used as button text and the code reference will be called
…		…
102		107
103	The following will add an entry C<a to b> that transforms all C<a>s in	108	The following will add an entry C<a to b> that transforms all C<a>s in
104	the selection to C<b>s, but only if the selection currently contains any	109	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	110	C<a>s:
106		111
107	push urxvt::ext::selection_popup::hook, sub {	112	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	113	/a/ ? ("a to be" => sub { s/a/b/g }
109	: ()	114	: ()
110	};	115	};
111		116
112	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
…		…
143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144		149
145	And this example matches the same,but replaces it with vi-commands you can	150	And this example matches the same,but replaces it with vi-commands you can
146	paste directly into your (vi :) editor:	151	paste directly into your (vi :) editor:
147		152
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149		154
150	Of course, this can be modified to suit your needs and your editor :)	155	Of course, this can be modified to suit your needs and your editor :)
151		156
152	To expand the example above to typical perl error messages ("XXX at	157	To expand the example above to typical perl error messages ("XXX at
153	FILENAME line YYY."), you need a slightly more elaborate solution:	158	FILENAME line YYY."), you need a slightly more elaborate solution:
154		159
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157		162
158	The first line tells the selection code to treat the unchanging part of	163	The first line tells the selection code to treat the unchanging part of
159	every error message as a selection pattern, and the second line transforms	164	every error message as a selection pattern, and the second line transforms
160	the message into vi commands to load the file.	165	the message into vi commands to load the file.
		166
		167	=item tabbed
		168
		169	This transforms the terminal into a tabbar with additional terminals, that
		170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		172	button per tab.
		173
		174	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		175	B<Shift-Right> will switch to the tab left or right of the current one,
		176	while B<Shift-Down> creates a new tab.
161		177
162	=item mark-urls	178	=item mark-urls
163		179
164	Uses per-line display filtering (C<on_line_update>) to underline urls and	180	Uses per-line display filtering (C<on_line_update>) to underline urls and
165	make them clickable. When middle-clicked, the program specified in the	181	make them clickable. When middle-clicked, the program specified in the
166	resource C<urlLauncher> (default C<x-www-browser>) will be started with	182	resource C<urlLauncher> (default C<x-www-browser>) will be started with
167	the URL as first argument.	183	the URL as first argument.
		184
		185	=item automove-background
		186
		187	This is basically a one-line extension that dynamically changes the background pixmap offset
		188	to the window position, in effect creating the same effect as pseudo transparency with
		189	a custom pixmap. No scaling is supported in this mode. Exmaple:
		190
		191	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
168		192
169	=item block-graphics-to-ascii	193	=item block-graphics-to-ascii
170		194
171	A not very useful example of filtering all text output to the terminal,	195	A not very useful example of filtering all text output to the terminal,
172	by replacing all line-drawing characters (U+2500 .. U+259F) by a	196	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
290	called whenever the relevant event happens.	314	called whenever the relevant event happens.
291		315
292	The first argument passed to them is an extension oject as described in	316	The first argument passed to them is an extension oject as described in
293	the in the C<Extension Objects> section.	317	the in the C<Extension Objects> section.
294		318
295	B<All> of these hooks must return a boolean value. If it is true, then the	319	B<All> of these hooks must return a boolean value. If any of the called
296	event counts as being I<consumed>, and the invocation of other hooks is	320	hooks returns true, then the event counts as being I<consumed>, and the
297	skipped, and the relevant action might not be carried out by the C++ code.	321	relevant action might not be carried out by the C++ code.
298		322
299	I<< When in doubt, return a false value (preferably C<()>). >>	323	I<< When in doubt, return a false value (preferably C<()>). >>
300		324
301	=over 4	325	=over 4
302		326
303	=item on_init $term	327	=item on_init $term
304		328
305	Called after a new terminal object has been initialized, but before	329	Called after a new terminal object has been initialized, but before
306	windows are created or the command gets run. Most methods are unsafe to	330	windows are created or the command gets run. Most methods are unsafe to
307	call or deliver senseless data, as terminal size and other characteristics	331	call or deliver senseless data, as terminal size and other characteristics
308	have not yet been determined. You can safely query and change resources,	332	have not yet been determined. You can safely query and change resources
309	though.	333	and options, though. For many purposes the C<on_start> hook is a better
		334	place.
		335
		336	=item on_start $term
		337
		338	Called at the very end of initialisation of a new terminal, just before
		339	trying to map (display) the toplevel and returning to the mainloop.
		340
		341	=item on_destroy $term
		342
		343	Called whenever something tries to destroy terminal, before doing anything
		344	yet. If this hook returns true, then destruction is skipped, but this is
		345	rarely a good idea.
310		346
311	=item on_reset $term	347	=item on_reset $term
312		348
313	Called after the screen is "reset" for any reason, such as resizing or	349	Called after the screen is "reset" for any reason, such as resizing or
314	control sequences. Here is where you can react on changes to size-related	350	control sequences. Here is where you can react on changes to size-related
315	variables.	351	variables.
316		352
317	=item on_start $term	353	=item on_child_start $term, $pid
318		354
319	Called at the very end of initialisation of a new terminal, just before	355	Called just after the child process has been C<fork>ed.
320	returning to the mainloop.	356
		357	=item on_child_exit $term, $status
		358
		359	Called just after the child process has exited. C<$status> is the status
		360	from C<waitpid>.
321		361
322	=item on_sel_make $term, $eventtime	362	=item on_sel_make $term, $eventtime
323		363
324	Called whenever a selection has been made by the user, but before the	364	Called whenever a selection has been made by the user, but before the
325	selection text is copied, so changes to the beginning, end or type of the	365	selection text is copied, so changes to the beginning, end or type of the
…		…
436	Called wheneever the window loses keyboard focus, before rxvt-unicode does	476	Called wheneever the window loses keyboard focus, before rxvt-unicode does
437	focus out processing.	477	focus out processing.
438		478
439	=item on_configure_notify $term, $event	479	=item on_configure_notify $term, $event
440		480
		481	=item on_property_notify $term, $event
		482
441	=item on_key_press $term, $event, $keysym, $octets	483	=item on_key_press $term, $event, $keysym, $octets
442		484
443	=item on_key_release $term, $event, $keysym	485	=item on_key_release $term, $event, $keysym
444		486
445	=item on_button_press $term, $event	487	=item on_button_press $term, $event
…		…
454		496
455	Called whenever the corresponding X event is received for the terminal If	497	Called whenever the corresponding X event is received for the terminal If
456	the hook returns true, then the even will be ignored by rxvt-unicode.	498	the hook returns true, then the even will be ignored by rxvt-unicode.
457		499
458	The event is a hash with most values as named by Xlib (see the XEvent	500	The event is a hash with most values as named by Xlib (see the XEvent
459	manpage), with the additional members C<row> and C<col>, which are the row	501	manpage), with the additional members C<row> and C<col>, which are the
460	and column under the mouse cursor.	502	(real, not screen-based) row and column under the mouse cursor.
461		503
462	C<on_key_press> additionally receives the string rxvt-unicode would	504	C<on_key_press> additionally receives the string rxvt-unicode would
463	output, if any, in locale-specific encoding.	505	output, if any, in locale-specific encoding.
464		506
465	subwindow.	507	subwindow.
		508
		509	=item on_client_message $term, $event
		510
		511	=item on_wm_protocols $term, $event
		512
		513	=item on_wm_delete_window $term, $event
		514
		515	Called when various types of ClientMessage events are received (all with
		516	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
466		517
467	=back	518	=back
468		519
469	=cut	520	=cut
470		521
…		…
476	use Scalar::Util ();	527	use Scalar::Util ();
477	use List::Util ();	528	use List::Util ();
478		529
479	our $VERSION = 1;	530	our $VERSION = 1;
480	our $TERM;	531	our $TERM;
		532	our @TERM_INIT;
		533	our @TERM_EXT;
481	our @HOOKNAME;	534	our @HOOKNAME;
482	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	535	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
483	our %OPTION;	536	our %OPTION;
484		537
485	our $LIBDIR;	538	our $LIBDIR;
…		…
506		559
507	=item $urxvt::TERM	560	=item $urxvt::TERM
508		561
509	The current terminal. This variable stores the current C<urxvt::term>	562	The current terminal. This variable stores the current C<urxvt::term>
510	object, whenever a callback/hook is executing.	563	object, whenever a callback/hook is executing.
		564
		565	=item @urxvt::TERM_INIT
		566
		567	All coderefs in this array will be called as methods of the next newly
		568	created C<urxvt::term> object (during the C<on_init> phase). The array
		569	gets cleared before the codereferences that were in it are being executed,
		570	so coderefs can push themselves onto it again if they so desire.
		571
		572	This complements to the perl-eval commandline option, but gets executed
		573	first.
		574
		575	=item @urxvt::TERM_EXT
		576
		577	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		578	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		579	but before other extensions. Gets cleared just like C<@TERM_INIT>.
511		580
512	=back	581	=back
513		582
514	=head2 Functions in the C<urxvt> Package	583	=head2 Functions in the C<urxvt> Package
515		584
…		…
622	my $msg = join "", @_;	691	my $msg = join "", @_;
623	$msg .= "\n"	692	$msg .= "\n"
624	unless $msg =~ /\n$/;	693	unless $msg =~ /\n$/;
625	urxvt::warn ($msg);	694	urxvt::warn ($msg);
626	};	695	};
627
628	# %ENV is the original startup environment
629	delete $ENV{IFS};
630	delete $ENV{CDPATH};
631	delete $ENV{BASH_ENV};
632	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
633	}	696	}
634		697
635	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	698	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
636		699
637	sub verbose {	700	sub verbose {
…		…
642	my %extension_pkg;	705	my %extension_pkg;
643		706
644	# load a single script into its own package, once only	707	# load a single script into its own package, once only
645	sub extension_package($) {	708	sub extension_package($) {
646	my ($path) = @_;	709	my ($path) = @_;
647
648	no strict 'refs';
649		710
650	$extension_pkg{$path} \|\|= do {	711	$extension_pkg{$path} \|\|= do {
651	$path =~ /([^\/\\]+)$/;	712	$path =~ /([^\/\\]+)$/;
652	my $pkg = $1;	713	my $pkg = $1;
653	$pkg =~ s/[^[:word:]]/_/g;	714	$pkg =~ s/[^[:word:]]/_/g;
…		…
656	verbose 3, "loading extension '$path' into package '$pkg'";	717	verbose 3, "loading extension '$path' into package '$pkg'";
657		718
658	open my $fh, "<:raw", $path	719	open my $fh, "<:raw", $path
659	or die "$path: $!";	720	or die "$path: $!";
660		721
661	@{"$pkg\::ISA"} = urxvt::term::extension::;
662
663	my $source =	722	my $source =
664	"package $pkg; use strict; use utf8;\n"	723	"package $pkg; use strict; use utf8;\n"
665	. "#line 1 \"$path\"\n{\n"	724	. "#line 1 \"$path\"\n{\n"
666	. (do { local $/; <$fh> })	725	. (do { local $/; <$fh> })
667	. "\n};\n1";	726	. "\n};\n1";
…		…
683	if ($htype == 0) { # INIT	742	if ($htype == 0) { # INIT
684	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	743	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
685		744
686	my %ext_arg;	745	my %ext_arg;
687		746
		747	{
		748	my @init = @TERM_INIT;
		749	@TERM_INIT = ();
		750	$_->($TERM) for @init;
		751	my @pkg = @TERM_EXT;
		752	@TERM_EXT = ();
		753	$TERM->register_package ($_) for @pkg;
		754	}
		755
688	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	756	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
689	if ($_ eq "default") {	757	if ($_ eq "default") {
690	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	758	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
691	} elsif (/^-(.*)$/) {	759	} elsif (/^-(.*)$/) {
692	delete $ext_arg{$1};	760	delete $ext_arg{$1};
693	} elsif (/^([^<]+)<(.*)>$/) {	761	} elsif (/^([^<]+)<(.*)>$/) {
…		…
718	if $verbosity >= 10;	786	if $verbosity >= 10;
719		787
720	keys %$cb;	788	keys %$cb;
721		789
722	while (my ($pkg, $cb) = each %$cb) {	790	while (my ($pkg, $cb) = each %$cb) {
723	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	791	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
724	and last;	792	$retval \|\|= $retval_;
725		793
726	if ($@) {	794	if ($@) {
727	$TERM->ungrab; # better to lose the grab than the session	795	$TERM->ungrab; # better to lose the grab than the session
728	warn $@;	796	warn $@;
729	}	797	}
…		…
740	# clear package	808	# clear package
741	%$TERM = ();	809	%$TERM = ();
742	}	810	}
743		811
744	$retval	812	$retval
745	}
746
747	sub exec_async(@) {
748	my $pid = fork;
749
750	return
751	if !defined $pid or $pid;
752
753	%ENV = %{ $TERM->env };
754
755	exec @_;
756	_exit 255;
757	}	813	}
758		814
759	# urxvt::term::extension	815	# urxvt::term::extension
760		816
761	package urxvt::term::extension;	817	package urxvt::term::extension;
…		…
900	# find on_xxx subs in the package and register them	956	# find on_xxx subs in the package and register them
901	# as hooks	957	# as hooks
902	sub register_package {	958	sub register_package {
903	my ($self, $pkg, $argv) = @_;	959	my ($self, $pkg, $argv) = @_;
904		960
		961	no strict 'refs';
		962
		963	urxvt::verbose 6, "register package $pkg to $self";
		964
		965	@{"$pkg\::ISA"} = urxvt::term::extension::;
		966
905	my $proxy = bless {	967	my $proxy = bless {
906	_pkg => $pkg,	968	_pkg => $pkg,
907	argv => $argv,	969	argv => $argv,
908	}, $pkg;	970	}, $pkg;
909	Scalar::Util::weaken ($proxy->{term} = $self);	971	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
940		1002
941	Destroy the terminal object (close the window, free resources	1003	Destroy the terminal object (close the window, free resources
942	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1004	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
943	watchers (timers, io watchers) are still active.	1005	watchers (timers, io watchers) are still active.
944		1006
		1007	=item $term->exec_async ($cmd[, @args])
		1008
		1009	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1010	("starts") programs in the background. This function takes care of setting
		1011	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1012	be preferred over explicit calls to C<exec> or C<system>.
		1013
		1014	Returns the pid of the subprocess or C<undef> on error.
		1015
		1016	=cut
		1017
		1018	sub exec_async {
		1019	my $self = shift;
		1020
		1021	my $pid = fork;
		1022
		1023	return $pid
		1024	if !defined $pid or $pid;
		1025
		1026	%ENV = %{ $self->env };
		1027
		1028	exec @_;
		1029	urxvt::_exit 255;
		1030	}
		1031
945	=item $isset = $term->option ($optval[, $set])	1032	=item $isset = $term->option ($optval[, $set])
946		1033
947	Returns true if the option specified by C<$optval> is enabled, and	1034	Returns true if the option specified by C<$optval> is enabled, and
948	optionally change it. All option values are stored by name in the hash	1035	optionally change it. All option values are stored by name in the hash
949	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1036	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
951	Here is a a likely non-exhaustive list of option names, please see the	1038	Here is a a likely non-exhaustive list of option names, please see the
952	source file F</src/optinc.h> to see the actual list:	1039	source file F</src/optinc.h> to see the actual list:
953		1040
954	borderLess console cursorBlink cursorUnderline hold iconic insecure	1041	borderLess console cursorBlink cursorUnderline hold iconic insecure
955	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1042	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
956	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1043	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
957	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1044	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
958	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1045	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
959	tripleclickwords utmpInhibit visualBell	1046	transparent tripleclickwords utmpInhibit visualBell
960		1047
961	=item $value = $term->resource ($name[, $newval])	1048	=item $value = $term->resource ($name[, $newval])
962		1049
963	Returns the current resource value associated with a given name and	1050	Returns the current resource value associated with a given name and
964	optionally sets a new value. Setting values is most useful in the C<init>	1051	optionally sets a new value. Setting values is most useful in the C<init>
…		…
981		1068
982	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1069	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
983	borderLess color cursorBlink cursorUnderline cutchars delete_key	1070	borderLess color cursorBlink cursorUnderline cutchars delete_key
984	display_name embed ext_bwidth fade font geometry hold iconName	1071	display_name embed ext_bwidth fade font geometry hold iconName
985	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1072	imFont imLocale inputMethod insecure int_bwidth intensityStyles
986	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1073	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
987	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1074	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
988	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1075	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
989	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1076	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
990	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1077	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
991	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1078	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
992	shade term_name title transparent transparent_all tripleclickwords	1079	secondaryScreen secondaryScroll selectstyle shade term_name title
993	utmpInhibit visualBell	1080	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1081	visualBell
994		1082
995	=cut	1083	=cut
996		1084
997	sub resource($$;$) {	1085	sub resource($$;$) {
998	my ($self, $name) = (shift, shift);	1086	my ($self, $name) = (shift, shift);
…		…
1480		1568
1481	Calls XUngrab for the most recent grab. Is called automatically on	1569	Calls XUngrab for the most recent grab. Is called automatically on
1482	evaluation errors, as it is better to lose the grab in the error case as	1570	evaluation errors, as it is better to lose the grab in the error case as
1483	the session.	1571	the session.
1484		1572
		1573	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1574
		1575	=item $atom_name = $term->XGetAtomName ($atom)
		1576
		1577	=item @atoms = $term->XListProperties ($window)
		1578
		1579	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1580
		1581	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1582
		1583	=item $term->XDeleteProperty ($window, $property)
		1584
		1585	=item $window = $term->DefaultRootWindow
		1586
		1587	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1588
		1589	=item $term->XMapWindow ($window)
		1590
		1591	=item $term->XUnmapWindow ($window)
		1592
		1593	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1594
		1595	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1596
		1597	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1598
		1599	Various X or X-related functions. The C<$term> object only serves as
		1600	the source of the display, otherwise those functions map more-or-less
		1601	directory onto the X functions of the same name.
		1602
1485	=back	1603	=back
1486		1604
1487	=cut	1605	=cut
1488		1606
1489	package urxvt::popup;	1607	package urxvt::popup;
…		…
1590	my $env = $self->{term}->env;	1708	my $env = $self->{term}->env;
1591	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1709	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1592	delete $env->{LC_ALL};	1710	delete $env->{LC_ALL};
1593	$env->{LC_CTYPE} = $self->{term}->locale;	1711	$env->{LC_CTYPE} = $self->{term}->locale;
1594		1712
1595	urxvt::term->new ($env, $self->{term}->resource ("name"),	1713	urxvt::term->new ($env, "popup",
1596	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1714	"--perl-lib" => "", "--perl-ext-common" => "",
		1715	"-pty-fd" => -1, "-sl" => 0,
		1716	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1597	"--transient-for" => $self->{term}->parent,	1717	"--transient-for" => $self->{term}->parent,
1598	"-display" => $self->{term}->display_id,	1718	"-display" => $self->{term}->display_id,
1599	"-pe" => "urxvt-popup")	1719	"-pe" => "urxvt-popup")
1600	or die "unable to create popup window\n";	1720	or die "unable to create popup window\n";
1601	}	1721	}
…		…
1606	delete $self->{term}{_destroy}{$self};	1726	delete $self->{term}{_destroy}{$self};
1607	$self->{term}->ungrab;	1727	$self->{term}->ungrab;
1608	}	1728	}
1609		1729
1610	=back	1730	=back
		1731
		1732	=cut
		1733
		1734	package urxvt::watcher;
		1735
		1736	@urxvt::timer::ISA = __PACKAGE__;
		1737	@urxvt::iow::ISA = __PACKAGE__;
		1738	@urxvt::pw::ISA = __PACKAGE__;
		1739	@urxvt::iw::ISA = __PACKAGE__;
1611		1740
1612	=head2 The C<urxvt::timer> Class	1741	=head2 The C<urxvt::timer> Class
1613		1742
1614	This class implements timer watchers/events. Time is represented as a	1743	This class implements timer watchers/events. Time is represented as a
1615	fractional number of seconds since the epoch. Example:	1744	fractional number of seconds since the epoch. Example:
…		…
1653	Start the timer.	1782	Start the timer.
1654		1783
1655	=item $timer = $timer->start ($tstamp)	1784	=item $timer = $timer->start ($tstamp)
1656		1785
1657	Set the event trigger time to C<$tstamp> and start the timer.	1786	Set the event trigger time to C<$tstamp> and start the timer.
		1787
		1788	=item $timer = $timer->after ($delay)
		1789
		1790	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1658		1791
1659	=item $timer = $timer->stop	1792	=item $timer = $timer->stop
1660		1793
1661	Stop the timer.	1794	Stop the timer.
1662		1795
…		…
1709		1842
1710	Stop watching for events on the given filehandle.	1843	Stop watching for events on the given filehandle.
1711		1844
1712	=back	1845	=back
1713		1846
		1847	=head2 The C<urxvt::iw> Class
		1848
		1849	This class implements idle watchers, that get called automatically when
		1850	the process is idle. They should return as fast as possible, after doing
		1851	some useful work.
		1852
		1853	=over 4
		1854
		1855	=item $iw = new urxvt::iw
		1856
		1857	Create a new idle watcher object in stopped state.
		1858
		1859	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1860
		1861	Set the callback to be called when the watcher triggers.
		1862
		1863	=item $timer = $timer->start
		1864
		1865	Start the watcher.
		1866
		1867	=item $timer = $timer->stop
		1868
		1869	Stop the watcher.
		1870
		1871	=back
		1872
		1873	=head2 The C<urxvt::pw> Class
		1874
		1875	This class implements process watchers. They create an event whenever a
		1876	process exits, after which they stop automatically.
		1877
		1878	my $pid = fork;
		1879	...
		1880	$term->{pw} = urxvt::pw
		1881	->new
		1882	->start ($pid)
		1883	->cb (sub {
		1884	my ($pw, $exit_status) = @_;
		1885	...
		1886	});
		1887
		1888	=over 4
		1889
		1890	=item $pw = new urxvt::pw
		1891
		1892	Create a new process watcher in stopped state.
		1893
		1894	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1895
		1896	Set the callback to be called when the timer triggers.
		1897
		1898	=item $pw = $timer->start ($pid)
		1899
		1900	Tells the wqtcher to start watching for process C<$pid>.
		1901
		1902	=item $pw = $pw->stop
		1903
		1904	Stop the watcher.
		1905
		1906	=back
		1907
1714	=head1 ENVIRONMENT	1908	=head1 ENVIRONMENT
1715		1909
1716	=head2 URXVT_PERL_VERBOSITY	1910	=head2 URXVT_PERL_VERBOSITY
1717		1911
1718	This variable controls the verbosity level of the perl extension. Higher	1912	This variable controls the verbosity level of the perl extension. Higher

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC vs. Revision 1.120 by root, Fri Jan 20 22:05:41 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC vs.
Revision 1.120 by root, Fri Jan 20 22:05:41 2006 UTC