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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC

…		…
40	=over 4	40	=over 4
41		41
42	=item selection (enabled by default)	42	=item selection (enabled by default)
43		43
44	(More) intelligent selection. This extension tries to be more intelligent	44	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	45	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	46	now, it tries to select words, urls and complete shell-quoted
47	too, if your F<ls> supports C<--quoting-style=shell>.	47	arguments, which is very convenient, too, if your F<ls> supports
		48	C<--quoting-style=shell>.
48		49
		50	A double-click usually selects the word under the cursor, further clicks
		51	will enlarge the selection.
		52
		53	The selection works by trying to match a number of regexes and displaying
		54	them in increasing order of length. You can add your own regexes by
		55	specifying resources of the form:
		56
		57	URxvt.selection.pattern-0: perl-regex
		58	URxvt.selection.pattern-1: perl-regex
		59	...
		60
		61	The index number (0, 1...) must not have any holes, and each regex must
		62	contain at least one pair of capturing parentheses, which will be used for
		63	the match. For example, the followign adds a regex that matches everything
		64	between two vertical bars:
		65
		66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		67
		68	You can look at the source of the selection extension to see more
		69	interesting uses, such as parsing a line from beginning to end.
		70
49	It also offers the following bindable keyboard command:	71	This extension also offers the following bindable keyboard command:
50		72
51	=over 4	73	=over 4
52		74
53	=item rot13	75	=item rot13
54		76
…		…
70	evalution, web-browser starting etc.), depending on content.	92	evalution, web-browser starting etc.), depending on content.
71		93
72	=item searchable-scrollback<hotkey> (enabled by default)	94	=item searchable-scrollback<hotkey> (enabled by default)
73		95
74	Adds regex search functionality to the scrollback buffer, triggered	96	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	98	input/output is suspended and a regex is displayed at the bottom of the
		99	screen.
77		100
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	101	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	102	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>	103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	104	bottom. C<Escape> leaves search mode and returns to the point where search
		105	was started, while C<Enter> or C<Return> stay at the current position and
		106	additionally stores the first match in the current line into the primary
		107	selection.
82		108
83	=item digital-clock	109	=item selection-autotransform
84		110
85	Displays a digital clock using the built-in overlay.	111	This selection allows you to do automatic transforms on a selection
		112	whenever a selection is made.
		113
		114	It works by specifying perl snippets (most useful is a single C<s///>
		115	operator) that modify C<$_> as resources:
		116
		117	URxvt.selection-autotransform.0: transform
		118	URxvt.selection-autotransform.1: transform
		119	...
		120
		121	For example, the following will transform selections of the form
		122	C<word:number> into C<vi +$number $word>:
		123
		124	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/
		125
		126	And this example matches the same,but replaces it with vi-commands you can
		127	paste directory into your (vi :) editor:
		128
		129	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/
86		130
87	=item mark-urls	131	=item mark-urls
88		132
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	133	Uses per-line display filtering (C<on_line_update>) to underline urls and
		134	make them clickable. When middle-clicked, the program specified in the
		135	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		136	the URL as first argument.
90		137
91	=item block-graphics-to-ascii	138	=item block-graphics-to-ascii
92		139
93	A not very useful example of filtering all text output to the terminal,	140	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	141	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	142	similar-looking ascii character.
		143
		144	=item digital-clock
		145
		146	Displays a digital clock using the built-in overlay.
96		147
97	=item example-refresh-hooks	148	=item example-refresh-hooks
98		149
99	Displays a very simple digital clock in the upper right corner of the	150	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	151	window. Illustrates overwriting the refresh callbacks to create your own
…		…
123	=over 4	174	=over 4
124		175
125	=item $text	176	=item $text
126		177
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	178	Rxvt-unicodes special way of encoding text, where one "unicode" character
128	always represents one screen cell. See L<row_t> for a discussion of this format.	179	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		180
130	=item $string	181	=item $string
131		182
132	A perl text string, with an emphasis on I<text>. It can store all unicode	183	A perl text string, with an emphasis on I<text>. It can store all unicode
133	characters and is to be distinguished with text encoded in a specific	184	characters and is to be distinguished with text encoded in a specific
…		…
228	=item on_sel_extend $term	279	=item on_sel_extend $term
229		280
230	Called whenever the user tries to extend the selection (e.g. with a double	281	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	282	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	283	should extend the selection itelf and return true to suppress the built-in
233	processing.	284	processing. This can happen multiple times, as long as the callback
		285	returns true, it will be called on every further click by the user and is
		286	supposed to enlarge the selection more and more, if possible.
234		287
235	See the F<selection> example extension.	288	See the F<selection> example extension.
236		289
237	=item on_view_change $term, $offset	290	=item on_view_change $term, $offset
238		291
…		…
343		396
344	subwindow.	397	subwindow.
345		398
346	=back	399	=back
347		400
348	=head2 Variables in the C<urxvt> Package
349
350	=over 4
351
352	=item $urxvt::LIBDIR
353
354	The rxvt-unicode library directory, where, among other things, the perl
355	modules and scripts are stored.
356
357	=item $urxvt::RESCLASS, $urxvt::RESCLASS
358
359	The resource class and name rxvt-unicode uses to look up X resources.
360
361	=item $urxvt::RXVTNAME
362
363	The basename of the installed binaries, usually C<urxvt>.
364
365	=item $urxvt::TERM
366
367	The current terminal. This variable stores the current C<urxvt::term>
368	object, whenever a callback/hook is executing.
369
370	=item
371
372	=back
373
374	=head2 Functions in the C<urxvt> Package
375
376	=over 4
377
378	=item $term = new urxvt [arg...]
379
380	Creates a new terminal, very similar as if you had started it with
381	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
382	if the new instance couldn't be created. Returns C<undef> if the new
383	instance didn't initialise perl, and the terminal object otherwise. The
384	C<init> and C<start> hooks will be called during the call.
385
386	=item urxvt::fatal $errormessage
387
388	Fatally aborts execution with the given error message. Avoid at all
389	costs! The only time this is acceptable is when the terminal process
390	starts up.
391
392	=item urxvt::warn $string
393
394	Calls C<rxvt_warn> with the given string which should not include a
395	newline. The module also overwrites the C<warn> builtin with a function
396	that calls this function.
397
398	Using this function has the advantage that its output ends up in the
399	correct place, e.g. on stderr of the connecting urxvtc client.
400
401	=item $is_safe = urxvt::safe
402
403	Returns true when it is safe to do potentially unsafe things, such as
404	evaluating perl code specified by the user. This is true when urxvt was
405	started setuid or setgid.
406
407	=item $time = urxvt::NOW
408
409	Returns the "current time" (as per the event loop).
410
411	=item urxvt::CurrentTime
412
413	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
414	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
415	Button4Mask, Button5Mask, AnyModifier
416
417	Various constants for use in X calls and event processing.
418
419	=back
420
421	=head2 RENDITION
422
423	Rendition bitsets contain information about colour, font, font styles and
424	similar information for each screen cell.
425
426	The following "macros" deal with changes in rendition sets. You should
427	never just create a bitset, you should always modify an existing one,
428	as they contain important information required for correct operation of
429	rxvt-unicode.
430
431	=over 4
432
433	=item $rend = urxvt::DEFAULT_RSTYLE
434
435	Returns the default rendition, as used when the terminal is starting up or
436	being reset. Useful as a base to start when creating renditions.
437
438	=item $rend = urxvt::OVERLAY_RSTYLE
439
440	Return the rendition mask used for overlays by default.
441
442	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
443
444	Return the bit that enabled bold, italic, blink, reverse-video and
445	underline, respectively. To enable such a style, just logically OR it into
446	the bitset.
447
448	=item $foreground = urxvt::GET_BASEFG $rend
449
450	=item $background = urxvt::GET_BASEBG $rend
451
452	Return the foreground/background colour index, respectively.
453
454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
455
456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
457
458	Replace the foreground/background colour in the rendition mask with the
459	specified one.
460
461	=item $value = urxvt::GET_CUSTOM $rend
462
463	Return the "custom" value: Every rendition has 5 bits for use by
464	extensions. They can be set and changed as you like and are initially
465	zero.
466
467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
468
469	Change the custom value.
470
471	=back
472
473	=cut	401	=cut
474		402
475	package urxvt;	403	package urxvt;
476		404
477	use utf8;	405	use utf8;
…		…
488		416
489	our $LIBDIR;	417	our $LIBDIR;
490	our $RESNAME;	418	our $RESNAME;
491	our $RESCLASS;	419	our $RESCLASS;
492	our $RXVTNAME;	420	our $RXVTNAME;
		421
		422	=head2 Variables in the C<urxvt> Package
		423
		424	=over 4
		425
		426	=item $urxvt::LIBDIR
		427
		428	The rxvt-unicode library directory, where, among other things, the perl
		429	modules and scripts are stored.
		430
		431	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		432
		433	The resource class and name rxvt-unicode uses to look up X resources.
		434
		435	=item $urxvt::RXVTNAME
		436
		437	The basename of the installed binaries, usually C<urxvt>.
		438
		439	=item $urxvt::TERM
		440
		441	The current terminal. This variable stores the current C<urxvt::term>
		442	object, whenever a callback/hook is executing.
		443
		444	=back
		445
		446	=head2 Functions in the C<urxvt> Package
		447
		448	=over 4
		449
		450	=item urxvt::fatal $errormessage
		451
		452	Fatally aborts execution with the given error message. Avoid at all
		453	costs! The only time this is acceptable is when the terminal process
		454	starts up.
		455
		456	=item urxvt::warn $string
		457
		458	Calls C<rxvt_warn> with the given string which should not include a
		459	newline. The module also overwrites the C<warn> builtin with a function
		460	that calls this function.
		461
		462	Using this function has the advantage that its output ends up in the
		463	correct place, e.g. on stderr of the connecting urxvtc client.
		464
		465	Messages have a size limit of 1023 bytes currently.
		466
		467	=item $is_safe = urxvt::safe
		468
		469	Returns true when it is safe to do potentially unsafe things, such as
		470	evaluating perl code specified by the user. This is true when urxvt was
		471	started setuid or setgid.
		472
		473	=item $time = urxvt::NOW
		474
		475	Returns the "current time" (as per the event loop).
		476
		477	=item urxvt::CurrentTime
		478
		479	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		480	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		481	Button4Mask, Button5Mask, AnyModifier
		482
		483	Various constants for use in X calls and event processing.
		484
		485	=back
		486
		487	=head2 RENDITION
		488
		489	Rendition bitsets contain information about colour, font, font styles and
		490	similar information for each screen cell.
		491
		492	The following "macros" deal with changes in rendition sets. You should
		493	never just create a bitset, you should always modify an existing one,
		494	as they contain important information required for correct operation of
		495	rxvt-unicode.
		496
		497	=over 4
		498
		499	=item $rend = urxvt::DEFAULT_RSTYLE
		500
		501	Returns the default rendition, as used when the terminal is starting up or
		502	being reset. Useful as a base to start when creating renditions.
		503
		504	=item $rend = urxvt::OVERLAY_RSTYLE
		505
		506	Return the rendition mask used for overlays by default.
		507
		508	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		509
		510	Return the bit that enabled bold, italic, blink, reverse-video and
		511	underline, respectively. To enable such a style, just logically OR it into
		512	the bitset.
		513
		514	=item $foreground = urxvt::GET_BASEFG $rend
		515
		516	=item $background = urxvt::GET_BASEBG $rend
		517
		518	Return the foreground/background colour index, respectively.
		519
		520	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		521
		522	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		523
		524	Replace the foreground/background colour in the rendition mask with the
		525	specified one.
		526
		527	=item $value = urxvt::GET_CUSTOM $rend
		528
		529	Return the "custom" value: Every rendition has 5 bits for use by
		530	extensions. They can be set and changed as you like and are initially
		531	zero.
		532
		533	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		534
		535	Change the custom value.
		536
		537	=back
		538
		539	=cut
493		540
494	BEGIN {	541	BEGIN {
495	urxvt->bootstrap;	542	urxvt->bootstrap;
496		543
497	# overwrite perl's warn	544	# overwrite perl's warn
…		…
500	$msg .= "\n"	547	$msg .= "\n"
501	unless $msg =~ /\n$/;	548	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	549	urxvt::warn ($msg);
503	};	550	};
504		551
		552	# %ENV is the original startup environment
505	delete $ENV{IFS};	553	delete $ENV{IFS};
506	delete $ENV{CDPATH};	554	delete $ENV{CDPATH};
507	delete $ENV{BASH_ENV};	555	delete $ENV{BASH_ENV};
508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	556	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509	}	557	}
…		…
598	if ($@) {	646	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	647	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	648	warn $@;
601	}	649	}
602	}	650	}
		651
		652	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		653	if $verbosity >= 11;
603	}	654	}
604		655
605	if ($htype == 1) { # DESTROY	656	if ($htype == 1) { # DESTROY
606	if (my $hook = delete $TERM->{_hook}) {	657	if (my $hook = delete $TERM->{_hook}) {
607	for my $htype (0..$#$hook) {	658	for my $htype (0..$#$hook) {
…		…
616	# clear package	667	# clear package
617	%$TERM = ();	668	%$TERM = ();
618	}	669	}
619		670
620	$retval	671	$retval
		672	}
		673
		674	sub exec_async(@) {
		675	my $pid = fork;
		676
		677	return
		678	if !defined $pid or $pid;
		679
		680	%ENV = %{ $TERM->env };
		681
		682	exec @_;
		683	_exit 255;
621	}	684	}
622		685
623	# urxvt::term::extension	686	# urxvt::term::extension
624		687
625	package urxvt::term::extension;	688	package urxvt::term::extension;
…		…
781	for my $name (@HOOKNAME) {	844	for my $name (@HOOKNAME) {
782	if (my $ref = $pkg->can ("on_" . lc $name)) {	845	if (my $ref = $pkg->can ("on_" . lc $name)) {
783	$proxy->enable ($name => $ref);	846	$proxy->enable ($name => $ref);
784	}	847	}
785	}	848	}
		849	}
		850
		851	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		852
		853	Creates a new terminal, very similar as if you had started it with system
		854	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		855	hash which defines the environment of the new terminal.
		856
		857	Croaks (and probably outputs an error message) if the new instance
		858	couldn't be created. Returns C<undef> if the new instance didn't
		859	initialise perl, and the terminal object otherwise. The C<init> and
		860	C<start> hooks will be called during this call.
		861
		862	=cut
		863
		864	sub new {
		865	my ($class, $env, @args) = @_;
		866
		867	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
786	}	868	}
787		869
788	=item $term->destroy	870	=item $term->destroy
789		871
790	Destroy the terminal object (close the window, free resources	872	Destroy the terminal object (close the window, free resources
…		…
847	my ($self, $name) = (shift, shift);	929	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	930	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	931	&urxvt::term::_resource
850	}	932	}
851		933
		934	=item $value = $term->x_resource ($pattern)
		935
		936	Returns the X-Resource for the given pattern, excluding the program or
		937	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		938	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		939	resource with that pattern exists.
		940
		941	This method should only be called during the C<on_start> hook, as there is
		942	only one resource database per display, and later invocations might return
		943	the wrong resources.
		944
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	945	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		946
854	Adds a keymap translation exactly as specified via a resource. See the	947	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	948	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		949
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	964	=item ($row, $col) = $term->selection_end ([$row, $col])
872		965
873	Return the current values of the selection mark, begin or end positions,	966	Return the current values of the selection mark, begin or end positions,
874	and optionally set them to new values.	967	and optionally set them to new values.
875		968
		969	=item $term->selection_make ($eventtime[, $rectangular])
		970
		971	Tries to make a selection as set by C<selection_beg> and
		972	C<selection_end>. If C<$rectangular> is true (default: false), a
		973	rectangular selection will be made. This is the prefered function to make
		974	a selection.
		975
876	=item $success = $term->selection_grab ($eventtime)	976	=item $success = $term->selection_grab ($eventtime)
877		977
878	Try to request the primary selection from the server (for example, as set	978	Try to request the primary selection text from the server (for example, as
879	by the next method).	979	set by the next method). No visual feedback will be given. This function
		980	is mostly useful from within C<on_sel_grab> hooks.
880		981
881	=item $oldtext = $term->selection ([$newtext])	982	=item $oldtext = $term->selection ([$newtext])
882		983
883	Return the current selection text and optionally replace it by C<$newtext>.	984	Return the current selection text and optionally replace it by C<$newtext>.
884		985
…		…
977	Convert the given locale-encoded octets into a perl string.	1078	Convert the given locale-encoded octets into a perl string.
978		1079
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1080	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1081
981	XORs the rendition values in the given span with the provided value	1082	XORs the rendition values in the given span with the provided value
982	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1083	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1084	refresh hooks to provide effects similar to the selection.
984		1085
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1086	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1087
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1088	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1089	whitespace will additionally be xored with the C<$rstyle2>, which defaults
989	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1090	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
990	it instead.	1091	it instead. Both styles I<MUST NOT> contain font styles.
991		1092
992	=item $term->scr_bell	1093	=item $term->scr_bell
993		1094
994	Ring the bell!	1095	Ring the bell!
995		1096
…		…
1055		1156
1056	=item $lines_in_scrollback = $term->nsaved	1157	=item $lines_in_scrollback = $term->nsaved
1057		1158
1058	Return various integers describing terminal characteristics.	1159	Return various integers describing terminal characteristics.
1059		1160
		1161	=item $x_display = $term->display_id
		1162
		1163	Return the DISPLAY used by rxvt-unicode.
		1164
1060	=item $lc_ctype = $term->locale	1165	=item $lc_ctype = $term->locale
1061		1166
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1167	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1168
1064	=item $x_display = $term->display_id	1169	=item $env = $term->env
1065		1170
1066	Return the DISPLAY used by rxvt-unicode.	1171	Returns a copy of the environment in effect for the terminal as a hashref
		1172	similar to C<\%ENV>.
		1173
		1174	=cut
		1175
		1176	sub env {
		1177	if (my $env = $_[0]->_env) {
		1178	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1179	} else {
		1180	+{ %ENV }
		1181	}
		1182	}
1067		1183
1068	=item $modifiermask = $term->ModLevel3Mask	1184	=item $modifiermask = $term->ModLevel3Mask
1069		1185
1070	=item $modifiermask = $term->ModMetaMask	1186	=item $modifiermask = $term->ModMetaMask
1071		1187
…		…
1164	Return the row number of the first/last row of the line, respectively.	1280	Return the row number of the first/last row of the line, respectively.
1165		1281
1166	=item $offset = $line->offset_of ($row, $col)	1282	=item $offset = $line->offset_of ($row, $col)
1167		1283
1168	Returns the character offset of the given row\|col pair within the logical	1284	Returns the character offset of the given row\|col pair within the logical
1169	line.	1285	line. Works for rows outside the line, too, and returns corresponding
		1286	offsets outside the string.
1170		1287
1171	=item ($row, $col) = $line->coord_of ($offset)	1288	=item ($row, $col) = $line->coord_of ($offset)
1172		1289
1173	Translates a string offset into terminal coordinates again.	1290	Translates a string offset into terminal coordinates again.
1174		1291
…		…
1311	$item->{render} \|\|= sub { $_[0]{text} };	1428	$item->{render} \|\|= sub { $_[0]{text} };
1312		1429
1313	push @{ $self->{item} }, $item;	1430	push @{ $self->{item} }, $item;
1314	}	1431	}
1315		1432
		1433	=item $popup->add_title ($title)
		1434
		1435	Adds a non-clickable title to the popup.
		1436
		1437	=cut
		1438
		1439	sub add_title {
		1440	my ($self, $title) = @_;
		1441
		1442	$self->add_item ({
		1443	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1444	text => $title,
		1445	activate => sub { },
		1446	});
		1447	}
		1448
		1449	=item $popup->add_separator ([$sepchr])
		1450
		1451	Creates a separator, optionally using the character given as C<$sepchr>.
		1452
		1453	=cut
		1454
1316	sub add_separator {	1455	sub add_separator {
1317	my ($self, $sep) = @_;	1456	my ($self, $sep) = @_;
1318		1457
1319	$sep \|\|= "=";	1458	$sep \|\|= "=";
1320		1459
…		…
1324	render => sub { $sep x $self->{term}->ncol },	1463	render => sub { $sep x $self->{term}->ncol },
1325	activate => sub { },	1464	activate => sub { },
1326	});	1465	});
1327	}	1466	}
1328		1467
1329	sub add_title {	1468	=item $popup->add_button ($text, $cb)
1330	my ($self, $title) = @_;
1331		1469
1332	$self->add_item ({	1470	Adds a clickable button to the popup. C<$cb> is called whenever it is
1333	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1471	selected.
1334	text => $title,	1472
1335	activate => sub { },	1473	=cut
1336	});
1337	}
1338		1474
1339	sub add_button {	1475	sub add_button {
1340	my ($self, $text, $cb) = @_;	1476	my ($self, $text, $cb) = @_;
1341		1477
1342	$self->add_item ({ type => "button", text => $text, activate => $cb});	1478	$self->add_item ({ type => "button", text => $text, activate => $cb});
1343	}	1479	}
		1480
		1481	=item $popup->add_toggle ($text, $cb, $initial_value)
		1482
		1483	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1484	whenever it gets toggled, with a boolean indicating its value as its first
		1485	argument.
		1486
		1487	=cut
1344		1488
1345	sub add_toggle {	1489	sub add_toggle {
1346	my ($self, $text, $cb, $value) = @_;	1490	my ($self, $text, $cb, $value) = @_;
1347		1491
1348	my $item; $item = {	1492	my $item; $item = {
1349	type => "button",	1493	type => "button",
1350	text => " $text",	1494	text => " $text",
1351	value => $value,	1495	value => $value,
1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1496	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1497	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354	};	1498	};
1355		1499
1356	$self->add_item ($item);	1500	$self->add_item ($item);
1357	}	1501	}
		1502
		1503	=item $popup->show
		1504
		1505	Displays the popup (which is initially hidden).
		1506
		1507	=cut
1358		1508
1359	sub show {	1509	sub show {
1360	my ($self) = @_;	1510	my ($self) = @_;
1361		1511
1362	local $urxvt::popup::self = $self;	1512	local $urxvt::popup::self = $self;
1363		1513
		1514	my $env = $self->{term}->env;
		1515	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1516	delete $env->{LC_ALL};
1364	local $ENV{LC_ALL} = $self->{term}->locale;	1517	$env->{LC_CTYPE} = $self->{term}->locale;
1365		1518
		1519	urxvt::term->new ($env, $self->{term}->resource ("name"),
1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1520	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1367	"--transient-for" => $self->{term}->parent,	1521	"--transient-for" => $self->{term}->parent,
1368	"-display" => $self->{term}->display_id,	1522	"-display" => $self->{term}->display_id,
1369	"-pe" => "urxvt-popup")	1523	"-pe" => "urxvt-popup")
1370	or die "unable to create popup window\n";	1524	or die "unable to create popup window\n";
1371	}	1525	}
1372		1526
1373	sub DESTROY {	1527	sub DESTROY {
1374	my ($self) = @_;	1528	my ($self) = @_;
1375		1529
1376	delete $self->{term}{_destroy}{$self};	1530	delete $self->{term}{_destroy}{$self};
1377	$self->{term}->ungrab;	1531	$self->{term}->ungrab;
1378	}	1532	}
		1533
		1534	=back
1379		1535
1380	=head2 The C<urxvt::timer> Class	1536	=head2 The C<urxvt::timer> Class
1381		1537
1382	This class implements timer watchers/events. Time is represented as a	1538	This class implements timer watchers/events. Time is represented as a
1383	fractional number of seconds since the epoch. Example:	1539	fractional number of seconds since the epoch. Example:
…		…
1490		1646
1491	=item == 0 - fatal messages	1647	=item == 0 - fatal messages
1492		1648
1493	=item >= 3 - script loading and management	1649	=item >= 3 - script loading and management
1494		1650
1495	=item >=10 - all events received	1651	=item >=10 - all called hooks
		1652
		1653	=item >=11 - hook reutrn values
1496		1654
1497	=back	1655	=back
1498		1656
1499	=head1 AUTHOR	1657	=head1 AUTHOR
1500		1658

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs. Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC