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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
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		39
40	=over 4	40	=over 4
41		41
42	=item selection (enabled by default)	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	now, it tries to select words, urls and complete shell-quoted
47	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
49	It also offers the following bindable event:	53	It also offers the following bindable keyboard command:
50		54
51	=over 4	55	=over 4
52		56
53	=item rot13	57	=item rot13
54		58
…		…
64	runtime.	68	runtime.
65		69
66	=item selection-popup (enabled by default)	70	=item selection-popup (enabled by default)
67		71
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	72	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	73	text into various other formats/action (such as uri unescaping, perl
		74	evalution, web-browser starting etc.), depending on content.
70		75
71	=item searchable-scrollback (enabled by default)	76	=item searchable-scrollback<hotkey> (enabled by default)
72		77
73	Adds regex search functionality to the scrollback buffer, triggered by a	78	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	79	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	suspended, C</> starts an incremental regex search, C<n> searches further,	80	input/output is suspended and a regex is displayed at the bottom of the
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	81	screen.
77	current position and C<escape> returns to the original position.	82
		83	Inputting characters appends them to the regex and continues incremental
		84	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		85	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		86	bottom. C<Escape> leaves search mode and returns to the point where search
		87	was started, while C<Enter> or C<Return> stay at the current position and
		88	additionally stores the first match in the current line into the primary
		89	selection.
78		90
79	=item digital-clock	91	=item digital-clock
80		92
81	Displays a digital clock using the built-in overlay.	93	Displays a digital clock using the built-in overlay.
82		94
83	=item mark-urls	95	=item mark-urls
84		96
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	97	Uses per-line display filtering (C<on_line_update>) to underline urls and
		98	make them clickable. When middle-clicked, the program specified in the
		99	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		100	the URL as first argument.
86		101
87	=item block-graphics-to-ascii	102	=item block-graphics-to-ascii
88		103
89	A not very useful example of filtering all text output to the terminal,	104	A not very useful example of filtering all text output to the terminal,
90	by replacing all line-drawing characters (U+2500 .. U+259F) by a	105	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
95	Displays a very simple digital clock in the upper right corner of the	110	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	111	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	112	overlays or changes.
98		113
99	=back	114	=back
		115
		116	=head1 API DOCUMENTATION
100		117
101	=head2 General API Considerations	118	=head2 General API Considerations
102		119
103	All objects (such as terminals, time watchers etc.) are typical	120	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	121	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	134	=over 4
118		135
119	=item $text	136	=item $text
120		137
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	138	Rxvt-unicodes special way of encoding text, where one "unicode" character
122	always represents one screen cell. See L<row_t> for a discussion of this format.	139	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		140
124	=item $string	141	=item $string
125		142
126	A perl text string, with an emphasis on I<text>. It can store all unicode	143	A perl text string, with an emphasis on I<text>. It can store all unicode
127	characters and is to be distinguished with text encoded in a specific	144	characters and is to be distinguished with text encoded in a specific
…		…
222	=item on_sel_extend $term	239	=item on_sel_extend $term
223		240
224	Called whenever the user tries to extend the selection (e.g. with a double	241	Called whenever the user tries to extend the selection (e.g. with a double
225	click) and is either supposed to return false (normal operation), or	242	click) and is either supposed to return false (normal operation), or
226	should extend the selection itelf and return true to suppress the built-in	243	should extend the selection itelf and return true to suppress the built-in
227	processing.	244	processing. This can happen multiple times, as long as the callback
		245	returns true, it will be called on every further click by the user and is
		246	supposed to enlarge the selection more and more, if possible.
228		247
229	See the F<selection> example extension.	248	See the F<selection> example extension.
230		249
231	=item on_view_change $term, $offset	250	=item on_view_change $term, $offset
232		251
…		…
337		356
338	subwindow.	357	subwindow.
339		358
340	=back	359	=back
341		360
342	=head2 Variables in the C<urxvt> Package
343
344	=over 4
345
346	=item $urxvt::TERM
347
348	The current terminal. This variable stores the current C<urxvt::term>
349	object, whenever a callback/hook is executing.
350
351	=back
352
353	=head2 Functions in the C<urxvt> Package
354
355	=over 4
356
357	=item $term = new urxvt [arg...]
358
359	Creates a new terminal, very similar as if you had started it with
360	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361	if the new instance couldn't be created. Returns C<undef> if the new
362	instance didn't initialise perl, and the terminal object otherwise. The
363	C<init> and C<start> hooks will be called during the call.
364
365	=item urxvt::fatal $errormessage
366
367	Fatally aborts execution with the given error message. Avoid at all
368	costs! The only time this is acceptable is when the terminal process
369	starts up.
370
371	=item urxvt::warn $string
372
373	Calls C<rxvt_warn> with the given string which should not include a
374	newline. The module also overwrites the C<warn> builtin with a function
375	that calls this function.
376
377	Using this function has the advantage that its output ends up in the
378	correct place, e.g. on stderr of the connecting urxvtc client.
379
380	=item $is_safe = urxvt::safe
381
382	Returns true when it is safe to do potentially unsafe things, such as
383	evaluating perl code specified by the user. This is true when urxvt was
384	started setuid or setgid.
385
386	=item $time = urxvt::NOW
387
388	Returns the "current time" (as per the event loop).
389
390	=item urxvt::CurrentTime
391
392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394	Button4Mask, Button5Mask, AnyModifier
395
396	Various constants for use in X calls and event processing.
397
398	=back
399
400	=head2 RENDITION
401
402	Rendition bitsets contain information about colour, font, font styles and
403	similar information for each screen cell.
404
405	The following "macros" deal with changes in rendition sets. You should
406	never just create a bitset, you should always modify an existing one,
407	as they contain important information required for correct operation of
408	rxvt-unicode.
409
410	=over 4
411
412	=item $rend = urxvt::DEFAULT_RSTYLE
413
414	Returns the default rendition, as used when the terminal is starting up or
415	being reset. Useful as a base to start when creating renditions.
416
417	=item $rend = urxvt::OVERLAY_RSTYLE
418
419	Return the rendition mask used for overlays by default.
420
421	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
422
423	Return the bit that enabled bold, italic, blink, reverse-video and
424	underline, respectively. To enable such a style, just logically OR it into
425	the bitset.
426
427	=item $foreground = urxvt::GET_BASEFG $rend
428
429	=item $background = urxvt::GET_BASEBG $rend
430
431	Return the foreground/background colour index, respectively.
432
433	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
434
435	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
436
437	Replace the foreground/background colour in the rendition mask with the
438	specified one.
439
440	=item $value = urxvt::GET_CUSTOM ($rend)
441
442	Return the "custom" value: Every rendition has 5 bits for use by
443	extensions. They can be set and changed as you like and are initially
444	zero.
445
446	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
447
448	Change the custom value.
449
450	=back
451
452	=cut	361	=cut
453		362
454	package urxvt;	363	package urxvt;
455		364
456	use utf8;	365	use utf8;
…		…
467		376
468	our $LIBDIR;	377	our $LIBDIR;
469	our $RESNAME;	378	our $RESNAME;
470	our $RESCLASS;	379	our $RESCLASS;
471	our $RXVTNAME;	380	our $RXVTNAME;
		381
		382	=head2 Variables in the C<urxvt> Package
		383
		384	=over 4
		385
		386	=item $urxvt::LIBDIR
		387
		388	The rxvt-unicode library directory, where, among other things, the perl
		389	modules and scripts are stored.
		390
		391	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		392
		393	The resource class and name rxvt-unicode uses to look up X resources.
		394
		395	=item $urxvt::RXVTNAME
		396
		397	The basename of the installed binaries, usually C<urxvt>.
		398
		399	=item $urxvt::TERM
		400
		401	The current terminal. This variable stores the current C<urxvt::term>
		402	object, whenever a callback/hook is executing.
		403
		404	=back
		405
		406	=head2 Functions in the C<urxvt> Package
		407
		408	=over 4
		409
		410	=item urxvt::fatal $errormessage
		411
		412	Fatally aborts execution with the given error message. Avoid at all
		413	costs! The only time this is acceptable is when the terminal process
		414	starts up.
		415
		416	=item urxvt::warn $string
		417
		418	Calls C<rxvt_warn> with the given string which should not include a
		419	newline. The module also overwrites the C<warn> builtin with a function
		420	that calls this function.
		421
		422	Using this function has the advantage that its output ends up in the
		423	correct place, e.g. on stderr of the connecting urxvtc client.
		424
		425	Messages have a size limit of 1023 bytes currently.
		426
		427	=item $is_safe = urxvt::safe
		428
		429	Returns true when it is safe to do potentially unsafe things, such as
		430	evaluating perl code specified by the user. This is true when urxvt was
		431	started setuid or setgid.
		432
		433	=item $time = urxvt::NOW
		434
		435	Returns the "current time" (as per the event loop).
		436
		437	=item urxvt::CurrentTime
		438
		439	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		440	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		441	Button4Mask, Button5Mask, AnyModifier
		442
		443	Various constants for use in X calls and event processing.
		444
		445	=back
		446
		447	=head2 RENDITION
		448
		449	Rendition bitsets contain information about colour, font, font styles and
		450	similar information for each screen cell.
		451
		452	The following "macros" deal with changes in rendition sets. You should
		453	never just create a bitset, you should always modify an existing one,
		454	as they contain important information required for correct operation of
		455	rxvt-unicode.
		456
		457	=over 4
		458
		459	=item $rend = urxvt::DEFAULT_RSTYLE
		460
		461	Returns the default rendition, as used when the terminal is starting up or
		462	being reset. Useful as a base to start when creating renditions.
		463
		464	=item $rend = urxvt::OVERLAY_RSTYLE
		465
		466	Return the rendition mask used for overlays by default.
		467
		468	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		469
		470	Return the bit that enabled bold, italic, blink, reverse-video and
		471	underline, respectively. To enable such a style, just logically OR it into
		472	the bitset.
		473
		474	=item $foreground = urxvt::GET_BASEFG $rend
		475
		476	=item $background = urxvt::GET_BASEBG $rend
		477
		478	Return the foreground/background colour index, respectively.
		479
		480	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		481
		482	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		483
		484	Replace the foreground/background colour in the rendition mask with the
		485	specified one.
		486
		487	=item $value = urxvt::GET_CUSTOM $rend
		488
		489	Return the "custom" value: Every rendition has 5 bits for use by
		490	extensions. They can be set and changed as you like and are initially
		491	zero.
		492
		493	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		494
		495	Change the custom value.
		496
		497	=back
		498
		499	=cut
472		500
473	BEGIN {	501	BEGIN {
474	urxvt->bootstrap;	502	urxvt->bootstrap;
475		503
476	# overwrite perl's warn	504	# overwrite perl's warn
…		…
479	$msg .= "\n"	507	$msg .= "\n"
480	unless $msg =~ /\n$/;	508	unless $msg =~ /\n$/;
481	urxvt::warn ($msg);	509	urxvt::warn ($msg);
482	};	510	};
483		511
		512	# %ENV is the original startup environment
484	delete $ENV{IFS};	513	delete $ENV{IFS};
485	delete $ENV{CDPATH};	514	delete $ENV{CDPATH};
486	delete $ENV{BASH_ENV};	515	delete $ENV{BASH_ENV};
487	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	516	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
488	}	517	}
…		…
577	if ($@) {	606	if ($@) {
578	$TERM->ungrab; # better to lose the grab than the session	607	$TERM->ungrab; # better to lose the grab than the session
579	warn $@;	608	warn $@;
580	}	609	}
581	}	610	}
		611
		612	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		613	if $verbosity >= 11;
582	}	614	}
583		615
584	if ($htype == 1) { # DESTROY	616	if ($htype == 1) { # DESTROY
585	if (my $hook = delete $TERM->{_hook}) {	617	if (my $hook = delete $TERM->{_hook}) {
586	for my $htype (0..$#$hook) {	618	for my $htype (0..$#$hook) {
…		…
597	}	629	}
598		630
599	$retval	631	$retval
600	}	632	}
601		633
		634	sub exec_async(@) {
		635	my $pid = fork;
		636
		637	return
		638	if !defined $pid or $pid;
		639
		640	%ENV = %{ $TERM->env };
		641
		642	exec @_;
		643	_exit 255;
		644	}
		645
602	# urxvt::term::extension	646	# urxvt::term::extension
603		647
604	package urxvt::term::extension;	648	package urxvt::term::extension;
605		649
606	sub enable {	650	sub enable {
…		…
672		716
673	=head2 The C<urxvt::anyevent> Class	717	=head2 The C<urxvt::anyevent> Class
674		718
675	The sole purpose of this class is to deliver an interface to the	719	The sole purpose of this class is to deliver an interface to the
676	C<AnyEvent> module - any module using it will work inside urxvt without	720	C<AnyEvent> module - any module using it will work inside urxvt without
677	further work. The only exception is that you cannot wait on condition	721	further programming. The only exception is that you cannot wait on
678	variables, but non-blocking condvar use is ok. What this means is that you	722	condition variables, but non-blocking condvar use is ok. What this means
679	cannot use blocking APIs, but the non-blocking variant should work.	723	is that you cannot use blocking APIs, but the non-blocking variant should
		724	work.
680		725
681	=cut	726	=cut
682		727
683	our $VERSION = 1;	728	our $VERSION = 1;
684		729
…		…
761	$proxy->enable ($name => $ref);	806	$proxy->enable ($name => $ref);
762	}	807	}
763	}	808	}
764	}	809	}
765		810
		811	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		812
		813	Creates a new terminal, very similar as if you had started it with system
		814	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		815	hash which defines the environment of the new terminal.
		816
		817	Croaks (and probably outputs an error message) if the new instance
		818	couldn't be created. Returns C<undef> if the new instance didn't
		819	initialise perl, and the terminal object otherwise. The C<init> and
		820	C<start> hooks will be called during this call.
		821
		822	=cut
		823
		824	sub new {
		825	my ($class, $env, @args) = @_;
		826
		827	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		828	}
		829
766	=item $term->destroy	830	=item $term->destroy
767		831
768	Destroy the terminal object (close the window, free resources etc.).	832	Destroy the terminal object (close the window, free resources
		833	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		834	watchers (timers, io watchers) are still active.
769		835
770	=item $isset = $term->option ($optval[, $set])	836	=item $isset = $term->option ($optval[, $set])
771		837
772	Returns true if the option specified by C<$optval> is enabled, and	838	Returns true if the option specified by C<$optval> is enabled, and
773	optionally change it. All option values are stored by name in the hash	839	optionally change it. All option values are stored by name in the hash
…		…
823	my ($self, $name) = (shift, shift);	889	my ($self, $name) = (shift, shift);
824	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	890	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
825	&urxvt::term::_resource	891	&urxvt::term::_resource
826	}	892	}
827		893
		894	=item $value = $term->x_resource ($pattern)
		895
		896	Returns the X-Resource for the given pattern, excluding the program or
		897	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		898	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		899	resource with that pattern exists.
		900
		901	This method should only be called during the C<on_start> hook, as there is
		902	only one resource database per display, and later invocations might return
		903	the wrong resources.
		904
828	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	905	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
829		906
830	Adds a keymap translation exactly as specified via a resource. See the	907	Adds a keymap translation exactly as specified via a resource. See the
831	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	908	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
832		909
…		…
847	=item ($row, $col) = $term->selection_end ([$row, $col])	924	=item ($row, $col) = $term->selection_end ([$row, $col])
848		925
849	Return the current values of the selection mark, begin or end positions,	926	Return the current values of the selection mark, begin or end positions,
850	and optionally set them to new values.	927	and optionally set them to new values.
851		928
		929	=item $term->selection_make ($eventtime[, $rectangular])
		930
		931	Tries to make a selection as set by C<selection_beg> and
		932	C<selection_end>. If C<$rectangular> is true (default: false), a
		933	rectangular selection will be made. This is the prefered function to make
		934	a selection.
		935
852	=item $success = $term->selection_grab ($eventtime)	936	=item $success = $term->selection_grab ($eventtime)
853		937
854	Try to request the primary selection from the server (for example, as set	938	Try to request the primary selection text from the server (for example, as
855	by the next method).	939	set by the next method). No visual feedback will be given. This function
		940	is mostly useful from within C<on_sel_grab> hooks.
856		941
857	=item $oldtext = $term->selection ([$newtext])	942	=item $oldtext = $term->selection ([$newtext])
858		943
859	Return the current selection text and optionally replace it by C<$newtext>.	944	Return the current selection text and optionally replace it by C<$newtext>.
860		945
…		…
953	Convert the given locale-encoded octets into a perl string.	1038	Convert the given locale-encoded octets into a perl string.
954		1039
955	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1040	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
956		1041
957	XORs the rendition values in the given span with the provided value	1042	XORs the rendition values in the given span with the provided value
958	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1043	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
959	to the selection.	1044	refresh hooks to provide effects similar to the selection.
960		1045
961	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1046	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
962		1047
963	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1048	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
964	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1049	whitespace will additionally be xored with the C<$rstyle2>, which defaults
965	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1050	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
966	it instead.	1051	it instead. Both styles I<MUST NOT> contain font styles.
967		1052
968	=item $term->scr_bell	1053	=item $term->scr_bell
969		1054
970	Ring the bell!	1055	Ring the bell!
971		1056
…		…
1031		1116
1032	=item $lines_in_scrollback = $term->nsaved	1117	=item $lines_in_scrollback = $term->nsaved
1033		1118
1034	Return various integers describing terminal characteristics.	1119	Return various integers describing terminal characteristics.
1035		1120
		1121	=item $x_display = $term->display_id
		1122
		1123	Return the DISPLAY used by rxvt-unicode.
		1124
1036	=item $lc_ctype = $term->locale	1125	=item $lc_ctype = $term->locale
1037		1126
1038	Returns the LC_CTYPE category string used by this rxvt-unicode.	1127	Returns the LC_CTYPE category string used by this rxvt-unicode.
1039		1128
1040	=item $x_display = $term->display_id	1129	=item $env = $term->env
1041		1130
1042	Return the DISPLAY used by rxvt-unicode.	1131	Returns a copy of the environment in effect for the terminal as a hashref
		1132	similar to C<\%ENV>.
		1133
		1134	=cut
		1135
		1136	sub env {
		1137	if (my $env = $_[0]->_env) {
		1138	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1139	} else {
		1140	+{ %ENV }
		1141	}
		1142	}
1043		1143
1044	=item $modifiermask = $term->ModLevel3Mask	1144	=item $modifiermask = $term->ModLevel3Mask
1045		1145
1046	=item $modifiermask = $term->ModMetaMask	1146	=item $modifiermask = $term->ModMetaMask
1047		1147
…		…
1140	Return the row number of the first/last row of the line, respectively.	1240	Return the row number of the first/last row of the line, respectively.
1141		1241
1142	=item $offset = $line->offset_of ($row, $col)	1242	=item $offset = $line->offset_of ($row, $col)
1143		1243
1144	Returns the character offset of the given row\|col pair within the logical	1244	Returns the character offset of the given row\|col pair within the logical
1145	line.	1245	line. Works for rows outside the line, too, and returns corresponding
		1246	offsets outside the string.
1146		1247
1147	=item ($row, $col) = $line->coord_of ($offset)	1248	=item ($row, $col) = $line->coord_of ($offset)
1148		1249
1149	Translates a string offset into terminal coordinates again.	1250	Translates a string offset into terminal coordinates again.
1150		1251
…		…
1287	$item->{render} \|\|= sub { $_[0]{text} };	1388	$item->{render} \|\|= sub { $_[0]{text} };
1288		1389
1289	push @{ $self->{item} }, $item;	1390	push @{ $self->{item} }, $item;
1290	}	1391	}
1291		1392
		1393	=item $popup->add_title ($title)
		1394
		1395	Adds a non-clickable title to the popup.
		1396
		1397	=cut
		1398
		1399	sub add_title {
		1400	my ($self, $title) = @_;
		1401
		1402	$self->add_item ({
		1403	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1404	text => $title,
		1405	activate => sub { },
		1406	});
		1407	}
		1408
		1409	=item $popup->add_separator ([$sepchr])
		1410
		1411	Creates a separator, optionally using the character given as C<$sepchr>.
		1412
		1413	=cut
		1414
1292	sub add_separator {	1415	sub add_separator {
1293	my ($self, $sep) = @_;	1416	my ($self, $sep) = @_;
1294		1417
1295	$sep \|\|= "=";	1418	$sep \|\|= "=";
1296		1419
…		…
1300	render => sub { $sep x $self->{term}->ncol },	1423	render => sub { $sep x $self->{term}->ncol },
1301	activate => sub { },	1424	activate => sub { },
1302	});	1425	});
1303	}	1426	}
1304		1427
1305	sub add_title {	1428	=item $popup->add_button ($text, $cb)
1306	my ($self, $title) = @_;
1307		1429
1308	$self->add_item ({	1430	Adds a clickable button to the popup. C<$cb> is called whenever it is
1309	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1431	selected.
1310	text => $title,	1432
1311	activate => sub { },	1433	=cut
1312	});
1313	}
1314		1434
1315	sub add_button {	1435	sub add_button {
1316	my ($self, $text, $cb) = @_;	1436	my ($self, $text, $cb) = @_;
1317		1437
1318	$self->add_item ({ type => "button", text => $text, activate => $cb});	1438	$self->add_item ({ type => "button", text => $text, activate => $cb});
1319	}	1439	}
		1440
		1441	=item $popup->add_toggle ($text, $cb, $initial_value)
		1442
		1443	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1444	whenever it gets toggled, with a boolean indicating its value as its first
		1445	argument.
		1446
		1447	=cut
1320		1448
1321	sub add_toggle {	1449	sub add_toggle {
1322	my ($self, $text, $cb, $value) = @_;	1450	my ($self, $text, $cb, $value) = @_;
1323		1451
1324	my $item; $item = {	1452	my $item; $item = {
1325	type => "button",	1453	type => "button",
1326	text => " $text",	1454	text => " $text",
1327	value => $value,	1455	value => $value,
1328	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1456	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1329	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1457	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1330	};	1458	};
1331		1459
1332	$self->add_item ($item);	1460	$self->add_item ($item);
1333	}	1461	}
		1462
		1463	=item $popup->show
		1464
		1465	Displays the popup (which is initially hidden).
		1466
		1467	=cut
1334		1468
1335	sub show {	1469	sub show {
1336	my ($self) = @_;	1470	my ($self) = @_;
1337		1471
1338	local $urxvt::popup::self = $self;	1472	local $urxvt::popup::self = $self;
1339		1473
		1474	my $env = $self->{term}->env;
		1475	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1476	delete $env->{LC_ALL};
1340	local $ENV{LC_ALL} = $self->{term}->locale;	1477	$env->{LC_CTYPE} = $self->{term}->locale;
1341		1478
		1479	urxvt::term->new ($env, $self->{term}->resource ("name"),
1342	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1480	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1343	"--transient-for" => $self->{term}->parent,	1481	"--transient-for" => $self->{term}->parent,
1344	"-display" => $self->{term}->display_id,	1482	"-display" => $self->{term}->display_id,
1345	"-pe" => "urxvt-popup")	1483	"-pe" => "urxvt-popup")
1346	or die "unable to create popup window\n";	1484	or die "unable to create popup window\n";
1347	}	1485	}
1348		1486
1349	sub DESTROY {	1487	sub DESTROY {
1350	my ($self) = @_;	1488	my ($self) = @_;
1351		1489
1352	delete $self->{term}{_destroy}{$self};	1490	delete $self->{term}{_destroy}{$self};
1353	$self->{term}->ungrab;	1491	$self->{term}->ungrab;
1354	}	1492	}
		1493
		1494	=back
1355		1495
1356	=head2 The C<urxvt::timer> Class	1496	=head2 The C<urxvt::timer> Class
1357		1497
1358	This class implements timer watchers/events. Time is represented as a	1498	This class implements timer watchers/events. Time is represented as a
1359	fractional number of seconds since the epoch. Example:	1499	fractional number of seconds since the epoch. Example:
…		…
1466		1606
1467	=item == 0 - fatal messages	1607	=item == 0 - fatal messages
1468		1608
1469	=item >= 3 - script loading and management	1609	=item >= 3 - script loading and management
1470		1610
1471	=item >=10 - all events received	1611	=item >=10 - all called hooks
		1612
		1613	=item >=11 - hook reutrn values
1472		1614
1473	=back	1615	=back
1474		1616
1475	=head1 AUTHOR	1617	=head1 AUTHOR
1476		1618

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs. Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC