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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC vs.
Revision 1.112 by root, Thu Jan 19 21:02:06 2006 UTC

…		…
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		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
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	49	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	50	now, it tries to select words, urls and complete shell-quoted
47	too, if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
		54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the followign adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		71
		72	You can look at the source of the selection extension to see more
		73	interesting uses, such as parsing a line from beginning to end.
		74
49	It also offers the following bindable keyboard command:	75	This extension also offers following bindable keyboard commands:
50		76
51	=over 4	77	=over 4
52		78
53	=item rot13	79	=item rot13
54		80
…		…
67		93
68	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
69	text into various other formats/action (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
70	evalution, web-browser starting etc.), depending on content.	96	evalution, web-browser starting etc.), depending on content.
71		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
		116
72	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
73		118
74	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	121	input/output is suspended and a regex is displayed at the bottom of the
		122	screen.
77		123
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	124	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	127	bottom. C<Escape> leaves search mode and returns to the point where search
		128	was started, while C<Enter> or C<Return> stay at the current position and
		129	additionally stores the first match in the current line into the primary
		130	selection.
82		131
83	=item digital-clock	132	=item selection-autotransform
84		133
85	Displays a digital clock using the built-in overlay.	134	This selection allows you to do automatic transforms on a selection
		135	whenever a selection is made.
		136
		137	It works by specifying perl snippets (most useful is a single C<s///>
		138	operator) that modify C<$_> as resources:
		139
		140	URxvt.selection-autotransform.0: transform
		141	URxvt.selection-autotransform.1: transform
		142	...
		143
		144	For example, the following will transform selections of the form
		145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		149
		150	And this example matches the same,but replaces it with vi-commands you can
		151	paste directly into your (vi :) editor:
		152
		153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
86		166
87	=item mark-urls	167	=item mark-urls
88		168
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	169	Uses per-line display filtering (C<on_line_update>) to underline urls and
		170	make them clickable. When middle-clicked, the program specified in the
		171	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		172	the URL as first argument.
		173
		174	=item automove-background
		175
		176	This is basically a one-line extension that dynamically changes the background pixmap offset
		177	to the window position, in effect creating the same effect as pseudo transparency with
		178	a custom pixmap. No scaling is supported in this mode. Exmaple:
		179
		180	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90		181
91	=item block-graphics-to-ascii	182	=item block-graphics-to-ascii
92		183
93	A not very useful example of filtering all text output to the terminal,	184	A not very useful example of filtering all text output to the terminal,
94	by replacing all line-drawing characters (U+2500 .. U+259F) by a	185	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	186	similar-looking ascii character.
96		187
		188	=item digital-clock
		189
		190	Displays a digital clock using the built-in overlay.
		191
97	=item example-refresh-hooks	192	=item example-refresh-hooks
98		193
99	Displays a very simple digital clock in the upper right corner of the	194	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	195	window. Illustrates overwriting the refresh callbacks to create your own
101	overlays or changes.	196	overlays or changes.
		197
		198	=item selection-pastebin
		199
		200	This is a little rarely useful extension that Uploads the selection as
		201	textfile to a remote site (or does other things). (The implementation is
		202	not currently secure for use in a multiuser environment as it writes to
		203	F</tmp> directly.).
		204
		205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		206	i.e.
		207
		208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		209
		210	Pressing this combination runs a command with C<%> replaced by the name of
		211	the textfile. This command can be set via a resource:
		212
		213	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		214
		215	And the default is likely not useful to anybody but the few people around
		216	here :)
		217
		218	The name of the textfile is the hex encoded md5 sum of the selection, so
		219	the same content should lead to the same filename.
		220
		221	After a successful upload the selection will be replaced by the text given
		222	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		223	for the filename):
		224
		225	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
102		226
103	=back	227	=back
104		228
105	=head1 API DOCUMENTATION	229	=head1 API DOCUMENTATION
106		230
…		…
179	called whenever the relevant event happens.	303	called whenever the relevant event happens.
180		304
181	The first argument passed to them is an extension oject as described in	305	The first argument passed to them is an extension oject as described in
182	the in the C<Extension Objects> section.	306	the in the C<Extension Objects> section.
183		307
184	B<All> of these hooks must return a boolean value. If it is true, then the	308	B<All> of these hooks must return a boolean value. If any of the called
185	event counts as being I<consumed>, and the invocation of other hooks is	309	hooks returns true, then the event counts as being I<consumed>, and the
186	skipped, and the relevant action might not be carried out by the C++ code.	310	relevant action might not be carried out by the C++ code.
187		311
188	I<< When in doubt, return a false value (preferably C<()>). >>	312	I<< When in doubt, return a false value (preferably C<()>). >>
189		313
190	=over 4	314	=over 4
191		315
192	=item on_init $term	316	=item on_init $term
193		317
194	Called after a new terminal object has been initialized, but before	318	Called after a new terminal object has been initialized, but before
195	windows are created or the command gets run. Most methods are unsafe to	319	windows are created or the command gets run. Most methods are unsafe to
196	call or deliver senseless data, as terminal size and other characteristics	320	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	321	have not yet been determined. You can safely query and change resources
198	though.	322	and options, though. For many purposes the C<on_start> hook is a better
		323	place.
		324
		325	=item on_start $term
		326
		327	Called at the very end of initialisation of a new terminal, just before
		328	returning to the mainloop.
199		329
200	=item on_reset $term	330	=item on_reset $term
201		331
202	Called after the screen is "reset" for any reason, such as resizing or	332	Called after the screen is "reset" for any reason, such as resizing or
203	control sequences. Here is where you can react on changes to size-related	333	control sequences. Here is where you can react on changes to size-related
204	variables.	334	variables.
205		335
206	=item on_start $term	336	=item on_child_start $term, $pid
207		337
208	Called at the very end of initialisation of a new terminal, just before	338	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	339
		340	=item on_child_exit $term, $status
		341
		342	Called just after the child process has exited. C<$status> is the status
		343	from C<waitpid>.
210		344
211	=item on_sel_make $term, $eventtime	345	=item on_sel_make $term, $eventtime
212		346
213	Called whenever a selection has been made by the user, but before the	347	Called whenever a selection has been made by the user, but before the
214	selection text is copied, so changes to the beginning, end or type of the	348	selection text is copied, so changes to the beginning, end or type of the
…		…
228	=item on_sel_extend $term	362	=item on_sel_extend $term
229		363
230	Called whenever the user tries to extend the selection (e.g. with a double	364	Called whenever the user tries to extend the selection (e.g. with a double
231	click) and is either supposed to return false (normal operation), or	365	click) and is either supposed to return false (normal operation), or
232	should extend the selection itelf and return true to suppress the built-in	366	should extend the selection itelf and return true to suppress the built-in
233	processing.	367	processing. This can happen multiple times, as long as the callback
		368	returns true, it will be called on every further click by the user and is
		369	supposed to enlarge the selection more and more, if possible.
234		370
235	See the F<selection> example extension.	371	See the F<selection> example extension.
236		372
237	=item on_view_change $term, $offset	373	=item on_view_change $term, $offset
238		374
…		…
305		441
306	Called whenever the user presses a key combination that has a	442	Called whenever the user presses a key combination that has a
307	C<perl:string> action bound to it (see description of the B<keysym>	443	C<perl:string> action bound to it (see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	444	resource in the @@RXVT_NAME@@(1) manpage).
309		445
		446	=item on_x_event $term, $event
		447
		448	Called on every X event received on the vt window (and possibly other
		449	windows). Should only be used as a last resort. Most event structure
		450	members are not passed.
		451
310	=item on_focus_in $term	452	=item on_focus_in $term
311		453
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	454	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	455	does focus in processing.
314		456
315	=item on_focus_out $term	457	=item on_focus_out $term
316		458
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	459	Called wheneever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	460	focus out processing.
		461
		462	=item on_configure_notify $term, $event
319		463
320	=item on_key_press $term, $event, $keysym, $octets	464	=item on_key_press $term, $event, $keysym, $octets
321		465
322	=item on_key_release $term, $event, $keysym	466	=item on_key_release $term, $event, $keysym
323		467
…		…
409	Using this function has the advantage that its output ends up in the	553	Using this function has the advantage that its output ends up in the
410	correct place, e.g. on stderr of the connecting urxvtc client.	554	correct place, e.g. on stderr of the connecting urxvtc client.
411		555
412	Messages have a size limit of 1023 bytes currently.	556	Messages have a size limit of 1023 bytes currently.
413		557
414	=item $is_safe = urxvt::safe
415
416	Returns true when it is safe to do potentially unsafe things, such as
417	evaluating perl code specified by the user. This is true when urxvt was
418	started setuid or setgid.
419
420	=item $time = urxvt::NOW	558	=item $time = urxvt::NOW
421		559
422	Returns the "current time" (as per the event loop).	560	Returns the "current time" (as per the event loop).
423		561
424	=item urxvt::CurrentTime	562	=item urxvt::CurrentTime
425		563
426	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	564	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
427	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	565	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
428	Button4Mask, Button5Mask, AnyModifier	566	Button4Mask, Button5Mask, AnyModifier
		567
		568	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		569	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		570	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		571	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		572	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		573	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		574	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		575
		576	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		577	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		578	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		579	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		580	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		581	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		582	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
429		583
430	Various constants for use in X calls and event processing.	584	Various constants for use in X calls and event processing.
431		585
432	=back	586	=back
433		587
…		…
484	=back	638	=back
485		639
486	=cut	640	=cut
487		641
488	BEGIN {	642	BEGIN {
489	urxvt->bootstrap;
490
491	# overwrite perl's warn	643	# overwrite perl's warn
492	*CORE::GLOBAL::warn = sub {	644	*CORE::GLOBAL::warn = sub {
493	my $msg = join "", @_;	645	my $msg = join "", @_;
494	$msg .= "\n"	646	$msg .= "\n"
495	unless $msg =~ /\n$/;	647	unless $msg =~ /\n$/;
496	urxvt::warn ($msg);	648	urxvt::warn ($msg);
497	};	649	};
498
499	delete $ENV{IFS};
500	delete $ENV{CDPATH};
501	delete $ENV{BASH_ENV};
502	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
503	}	650	}
504		651
505	my @hook_count;
506	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	652	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
507		653
508	sub verbose {	654	sub verbose {
509	my ($level, $msg) = @_;	655	my ($level, $msg) = @_;
510	warn "$msg\n" if $level <= $verbosity;	656	warn "$msg\n" if $level <= $verbosity;
511	}	657	}
512		658
513	my $extension_pkg = "extension0000";
514	my %extension_pkg;	659	my %extension_pkg;
515		660
516	# load a single script into its own package, once only	661	# load a single script into its own package, once only
517	sub extension_package($) {	662	sub extension_package($) {
518	my ($path) = @_;	663	my ($path) = @_;
519		664
		665	no strict 'refs';
		666
520	$extension_pkg{$path} \|\|= do {	667	$extension_pkg{$path} \|\|= do {
521	my $pkg = "urxvt::" . ($extension_pkg++);	668	$path =~ /([^\/\\]+)$/;
		669	my $pkg = $1;
		670	$pkg =~ s/[^[:word:]]/_/g;
		671	$pkg = "urxvt::ext::$pkg";
522		672
523	verbose 3, "loading extension '$path' into package '$pkg'";	673	verbose 3, "loading extension '$path' into package '$pkg'";
524		674
525	open my $fh, "<:raw", $path	675	open my $fh, "<:raw", $path
526	or die "$path: $!";	676	or die "$path: $!";
527		677
		678	@{"$pkg\::ISA"} = urxvt::term::extension::;
		679
528	my $source = untaint	680	my $source =
529	"package $pkg; use strict; use utf8;\n"	681	"package $pkg; use strict; use utf8;\n"
530	. "use base urxvt::term::extension::;\n"
531	. "#line 1 \"$path\"\n{\n"	682	. "#line 1 \"$path\"\n{\n"
532	. (do { local $/; <$fh> })	683	. (do { local $/; <$fh> })
533	. "\n};\n1";	684	. "\n};\n1";
534		685
535	eval $source	686	eval $source
…		…
584	if $verbosity >= 10;	735	if $verbosity >= 10;
585		736
586	keys %$cb;	737	keys %$cb;
587		738
588	while (my ($pkg, $cb) = each %$cb) {	739	while (my ($pkg, $cb) = each %$cb) {
589	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	740	$retval \|\|= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
590	and last;
591		741
592	if ($@) {	742	if ($@) {
593	$TERM->ungrab; # better to lose the grab than the session	743	$TERM->ungrab; # better to lose the grab than the session
594	warn $@;	744	warn $@;
595	}	745	}
596	}	746	}
		747
		748	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		749	if $verbosity >= 11;
597	}	750	}
598		751
599	if ($htype == 1) { # DESTROY	752	if ($htype == 1) { # DESTROY
600	if (my $hook = delete $TERM->{_hook}) {
601	for my $htype (0..$#$hook) {
602	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
603	or set_should_invoke $htype, 0;
604	}
605	}
606
607	# clear package objects	753	# clear package objects
608	%$_ = () for values %{ $TERM->{_pkg} };	754	%$_ = () for values %{ $TERM->{_pkg} };
609		755
610	# clear package	756	# clear package
611	%$TERM = ();	757	%$TERM = ();
…		…
625	while (my ($name, $cb) = each %hook) {	771	while (my ($name, $cb) = each %hook) {
626	my $htype = $HOOKTYPE{uc $name};	772	my $htype = $HOOKTYPE{uc $name};
627	defined $htype	773	defined $htype
628	or Carp::croak "unsupported hook type '$name'";	774	or Carp::croak "unsupported hook type '$name'";
629		775
		776	$self->set_should_invoke ($htype, +1)
630	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	777	unless exists $self->{term}{_hook}[$htype]{$pkg};
631	$hook_count[$htype]++
632	or urxvt::set_should_invoke $htype, 1;
633	}
634		778
635	$self->{term}{_hook}[$htype]{$pkg} = $cb;	779	$self->{term}{_hook}[$htype]{$pkg} = $cb;
636	}	780	}
637	}	781	}
638		782
…		…
643	for my $name (@hook) {	787	for my $name (@hook) {
644	my $htype = $HOOKTYPE{uc $name};	788	my $htype = $HOOKTYPE{uc $name};
645	defined $htype	789	defined $htype
646	or Carp::croak "unsupported hook type '$name'";	790	or Carp::croak "unsupported hook type '$name'";
647		791
		792	$self->set_should_invoke ($htype, -1)
648	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	793	if delete $self->{term}{_hook}[$htype]{$pkg};
649	--$hook_count[$htype]
650	or urxvt::set_should_invoke $htype, 0;
651	}
652	}	794	}
653	}	795	}
654		796
655	our $AUTOLOAD;	797	our $AUTOLOAD;
656		798
…		…
802		944
803	Destroy the terminal object (close the window, free resources	945	Destroy the terminal object (close the window, free resources
804	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	946	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
805	watchers (timers, io watchers) are still active.	947	watchers (timers, io watchers) are still active.
806		948
		949	=item $term->exec_async ($cmd[, @args])
		950
		951	Works like the combination of the C<fork>/C<exec> builtins, which executes
		952	("starts") programs in the background. This function takes care of setting
		953	the user environment before exec'ing the command (e.g. C<PATH>) and should
		954	be preferred over explicit calls to C<exec> or C<system>.
		955
		956	Returns the pid of the subprocess or C<undef> on error.
		957
		958	=cut
		959
		960	sub exec_async {
		961	my $self = shift;
		962
		963	my $pid = fork;
		964
		965	return $pid
		966	if !defined $pid or $pid;
		967
		968	%ENV = %{ $self->env };
		969
		970	exec @_;
		971	urxvt::_exit 255;
		972	}
		973
807	=item $isset = $term->option ($optval[, $set])	974	=item $isset = $term->option ($optval[, $set])
808		975
809	Returns true if the option specified by C<$optval> is enabled, and	976	Returns true if the option specified by C<$optval> is enabled, and
810	optionally change it. All option values are stored by name in the hash	977	optionally change it. All option values are stored by name in the hash
811	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	978	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
813	Here is a a likely non-exhaustive list of option names, please see the	980	Here is a a likely non-exhaustive list of option names, please see the
814	source file F</src/optinc.h> to see the actual list:	981	source file F</src/optinc.h> to see the actual list:
815		982
816	borderLess console cursorBlink cursorUnderline hold iconic insecure	983	borderLess console cursorBlink cursorUnderline hold iconic insecure
817	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	984	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
818	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	985	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
819	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	986	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
820	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	987	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
821	tripleclickwords utmpInhibit visualBell	988	transparent tripleclickwords utmpInhibit visualBell
822		989
823	=item $value = $term->resource ($name[, $newval])	990	=item $value = $term->resource ($name[, $newval])
824		991
825	Returns the current resource value associated with a given name and	992	Returns the current resource value associated with a given name and
826	optionally sets a new value. Setting values is most useful in the C<init>	993	optionally sets a new value. Setting values is most useful in the C<init>
…		…
843		1010
844	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1011	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
845	borderLess color cursorBlink cursorUnderline cutchars delete_key	1012	borderLess color cursorBlink cursorUnderline cutchars delete_key
846	display_name embed ext_bwidth fade font geometry hold iconName	1013	display_name embed ext_bwidth fade font geometry hold iconName
847	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1014	imFont imLocale inputMethod insecure int_bwidth intensityStyles
848	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1015	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
849	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1016	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
850	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1017	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
851	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1018	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
852	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1019	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
853	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1020	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
854	shade term_name title transparent transparent_all tripleclickwords	1021	secondaryScreen secondaryScroll selectstyle shade term_name title
855	utmpInhibit visualBell	1022	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1023	visualBell
856		1024
857	=cut	1025	=cut
858		1026
859	sub resource($$;$) {	1027	sub resource($$;$) {
860	my ($self, $name) = (shift, shift);	1028	my ($self, $name) = (shift, shift);
861	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1029	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
862	&urxvt::term::_resource	1030	&urxvt::term::_resource
863	}	1031	}
864		1032
		1033	=item $value = $term->x_resource ($pattern)
		1034
		1035	Returns the X-Resource for the given pattern, excluding the program or
		1036	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1037	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1038	resource with that pattern exists.
		1039
		1040	This method should only be called during the C<on_start> hook, as there is
		1041	only one resource database per display, and later invocations might return
		1042	the wrong resources.
		1043
865	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1044	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
866		1045
867	Adds a keymap translation exactly as specified via a resource. See the	1046	Adds a keymap translation exactly as specified via a resource. See the
868	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1047	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
869		1048
…		…
884	=item ($row, $col) = $term->selection_end ([$row, $col])	1063	=item ($row, $col) = $term->selection_end ([$row, $col])
885		1064
886	Return the current values of the selection mark, begin or end positions,	1065	Return the current values of the selection mark, begin or end positions,
887	and optionally set them to new values.	1066	and optionally set them to new values.
888		1067
		1068	=item $term->selection_make ($eventtime[, $rectangular])
		1069
		1070	Tries to make a selection as set by C<selection_beg> and
		1071	C<selection_end>. If C<$rectangular> is true (default: false), a
		1072	rectangular selection will be made. This is the prefered function to make
		1073	a selection.
		1074
889	=item $success = $term->selection_grab ($eventtime)	1075	=item $success = $term->selection_grab ($eventtime)
890		1076
891	Try to request the primary selection from the server (for example, as set	1077	Try to request the primary selection text from the server (for example, as
892	by the next method).	1078	set by the next method). No visual feedback will be given. This function
		1079	is mostly useful from within C<on_sel_grab> hooks.
893		1080
894	=item $oldtext = $term->selection ([$newtext])	1081	=item $oldtext = $term->selection ([$newtext])
895		1082
896	Return the current selection text and optionally replace it by C<$newtext>.	1083	Return the current selection text and optionally replace it by C<$newtext>.
897		1084
…		…
990	Convert the given locale-encoded octets into a perl string.	1177	Convert the given locale-encoded octets into a perl string.
991		1178
992	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1179	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
993		1180
994	XORs the rendition values in the given span with the provided value	1181	XORs the rendition values in the given span with the provided value
995	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1182	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
996	to the selection.	1183	refresh hooks to provide effects similar to the selection.
997		1184
998	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1185	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
999		1186
1000	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1187	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1001	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1188	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1002	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1189	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
1003	it instead.	1190	it instead. Both styles I<MUST NOT> contain font styles.
1004		1191
1005	=item $term->scr_bell	1192	=item $term->scr_bell
1006		1193
1007	Ring the bell!	1194	Ring the bell!
1008		1195
…		…
1042		1229
1043	=item $windowid = $term->vt	1230	=item $windowid = $term->vt
1044		1231
1045	Return the window id of the terminal window.	1232	Return the window id of the terminal window.
1046		1233
		1234	=item $term->vt_emask_add ($x_event_mask)
		1235
		1236	Adds the specified events to the vt event mask. Useful e.g. when you want
		1237	to receive pointer events all the times:
		1238
		1239	$term->vt_emask_add (urxvt::PointerMotionMask);
		1240
1047	=item $window_width = $term->width	1241	=item $window_width = $term->width
1048		1242
1049	=item $window_height = $term->height	1243	=item $window_height = $term->height
1050		1244
1051	=item $font_width = $term->fwidth	1245	=item $font_width = $term->fwidth
…		…
1064		1258
1065	=item $max_scrollback = $term->saveLines	1259	=item $max_scrollback = $term->saveLines
1066		1260
1067	=item $nrow_plus_saveLines = $term->total_rows	1261	=item $nrow_plus_saveLines = $term->total_rows
1068		1262
1069	=item $lines_in_scrollback = $term->nsaved	1263	=item $topmost_scrollback_row = $term->top_row
1070		1264
1071	Return various integers describing terminal characteristics.	1265	Return various integers describing terminal characteristics.
1072		1266
1073	=item $x_display = $term->display_id	1267	=item $x_display = $term->display_id
1074		1268
…		…
1102	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1296	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1103	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1297	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1104		1298
1105	=item $view_start = $term->view_start ([$newvalue])	1299	=item $view_start = $term->view_start ([$newvalue])
1106		1300
1107	Returns the negative row number of the topmost line. Minimum value is	1301	Returns the row number of the topmost displayed line. Maximum value is
1108	C<0>, which displays the normal terminal contents. Larger values scroll	1302	C<0>, which displays the normal terminal contents. Lower values scroll
1109	this many lines into the scrollback buffer.	1303	this many lines into the scrollback buffer.
1110		1304
1111	=item $term->want_refresh	1305	=item $term->want_refresh
1112		1306
1113	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1307	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1192	Return the row number of the first/last row of the line, respectively.	1386	Return the row number of the first/last row of the line, respectively.
1193		1387
1194	=item $offset = $line->offset_of ($row, $col)	1388	=item $offset = $line->offset_of ($row, $col)
1195		1389
1196	Returns the character offset of the given row\|col pair within the logical	1390	Returns the character offset of the given row\|col pair within the logical
1197	line.	1391	line. Works for rows outside the line, too, and returns corresponding
		1392	offsets outside the string.
1198		1393
1199	=item ($row, $col) = $line->coord_of ($offset)	1394	=item ($row, $col) = $line->coord_of ($offset)
1200		1395
1201	Translates a string offset into terminal coordinates again.	1396	Translates a string offset into terminal coordinates again.
1202		1397
…		…
1425	my $env = $self->{term}->env;	1620	my $env = $self->{term}->env;
1426	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1621	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1427	delete $env->{LC_ALL};	1622	delete $env->{LC_ALL};
1428	$env->{LC_CTYPE} = $self->{term}->locale;	1623	$env->{LC_CTYPE} = $self->{term}->locale;
1429		1624
1430	urxvt::term->new ($env, $self->{term}->resource ("name"),	1625	urxvt::term->new ($env, "popup",
1431	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1626	"--perl-lib" => "", "--perl-ext-common" => "",
		1627	"-pty-fd" => -1, "-sl" => 0,
		1628	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1432	"--transient-for" => $self->{term}->parent,	1629	"--transient-for" => $self->{term}->parent,
1433	"-display" => $self->{term}->display_id,	1630	"-display" => $self->{term}->display_id,
1434	"-pe" => "urxvt-popup")	1631	"-pe" => "urxvt-popup")
1435	or die "unable to create popup window\n";	1632	or die "unable to create popup window\n";
1436	}	1633	}
…		…
1488	Start the timer.	1685	Start the timer.
1489		1686
1490	=item $timer = $timer->start ($tstamp)	1687	=item $timer = $timer->start ($tstamp)
1491		1688
1492	Set the event trigger time to C<$tstamp> and start the timer.	1689	Set the event trigger time to C<$tstamp> and start the timer.
		1690
		1691	=item $timer = $timer->after ($delay)
		1692
		1693	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1493		1694
1494	=item $timer = $timer->stop	1695	=item $timer = $timer->stop
1495		1696
1496	Stop the timer.	1697	Stop the timer.
1497		1698
…		…
1557		1758
1558	=item == 0 - fatal messages	1759	=item == 0 - fatal messages
1559		1760
1560	=item >= 3 - script loading and management	1761	=item >= 3 - script loading and management
1561		1762
1562	=item >=10 - all events received	1763	=item >=10 - all called hooks
		1764
		1765	=item >=11 - hook reutrn values
1563		1766
1564	=back	1767	=back
1565		1768
1566	=head1 AUTHOR	1769	=head1 AUTHOR
1567		1770

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC vs. Revision 1.112 by root, Thu Jan 19 21:02:06 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC vs.
Revision 1.112 by root, Thu Jan 19 21:02:06 2006 UTC