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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.64 by root, Mon Jan 9 06:29:47 2006 UTC vs.
Revision 1.102 by root, Wed Jan 18 10:31:37 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
49	It also offers the following bindable event:	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
		71	This extension also offers following bindable keyboard commands:
50		72
51	=over 4	73	=over 4
52		74
53	=item rot13	75	=item rot13
54		76
…		…
64	runtime.	86	runtime.
65		87
66	=item selection-popup (enabled by default)	88	=item selection-popup (enabled by default)
67		89
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
70		93
71	=item digital-clock	94	Other extensions can extend this popup menu by pushing a code reference onto
		95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
72		96
73	Displays a digital clock using the built-in overlay.	97	It's sole argument is the popup menu, which can be modified. The selection
		98	is in C<$_>, which can be used to decide wether to add something or not.
		99	It should either return nothing or a string and a code reference. The
		100	string will be used as button text and the code reference will be called
		101	when the button gets activated and should transform C<$_>.
		102
		103	The following will add an entry C<a to b> that transforms all C<a>s in
		104	the selection to C<b>s, but only if the selection currently contains any
		105	C<a>s:
		106
		107	push urxvt::ext::selection_popup::hook, sub {
		108	/a/ ? ("a to be" => sub { s/a/b/g }
		109	: ()
		110	};
		111
		112	=item searchable-scrollback<hotkey> (enabled by default)
		113
		114	Adds regex search functionality to the scrollback buffer, triggered
		115	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		116	input/output is suspended and a regex is displayed at the bottom of the
		117	screen.
		118
		119	Inputting characters appends them to the regex and continues incremental
		120	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		121	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		122	bottom. C<Escape> leaves search mode and returns to the point where search
		123	was started, while C<Enter> or C<Return> stay at the current position and
		124	additionally stores the first match in the current line into the primary
		125	selection.
		126
		127	=item selection-autotransform
		128
		129	This selection allows you to do automatic transforms on a selection
		130	whenever a selection is made.
		131
		132	It works by specifying perl snippets (most useful is a single C<s///>
		133	operator) that modify C<$_> as resources:
		134
		135	URxvt.selection-autotransform.0: transform
		136	URxvt.selection-autotransform.1: transform
		137	...
		138
		139	For example, the following will transform selections of the form
		140	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		141	$word>:
		142
		143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		144
		145	And this example matches the same,but replaces it with vi-commands you can
		146	paste directly into your (vi :) editor:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		149
		150	Of course, this can be modified to suit your needs and your editor :)
		151
		152	To expand the example above to typical perl error messages ("XXX at
		153	FILENAME line YYY."), you need a slightly more elaborate solution:
		154
		155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		157
		158	The first line tells the selection code to treat the unchanging part of
		159	every error message as a selection pattern, and the second line transforms
		160	the message into vi commands to load the file.
74		161
75	=item mark-urls	162	=item mark-urls
76		163
77	Uses per-line display filtering (C<on_line_update>) to underline urls.	164	Uses per-line display filtering (C<on_line_update>) to underline urls and
		165	make them clickable. When middle-clicked, the program specified in the
		166	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		167	the URL as first argument.
78		168
79	=item block-graphics-to-ascii	169	=item block-graphics-to-ascii
80		170
81	A not very useful example of filtering all text output to the terminal,	171	A not very useful example of filtering all text output to the terminal,
82	by replacing all line-drawing characters (U+2500 .. U+259F) by a	172	by replacing all line-drawing characters (U+2500 .. U+259F) by a
83	similar-looking ascii character.	173	similar-looking ascii character.
84		174
		175	=item digital-clock
		176
		177	Displays a digital clock using the built-in overlay.
		178
85	=item example-refresh-hooks	179	=item example-refresh-hooks
86		180
87	Displays a very simple digital clock in the upper right corner of the	181	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	182	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	183	overlays or changes.
90		184
		185	=item selection-pastebin
		186
		187	This is a little rarely useful extension that Uploads the selection as
		188	textfile to a remote site (or does other things). (The implementation is
		189	not currently secure for use in a multiuser environment as it writes to
		190	F</tmp> directly.).
		191
		192	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		193	i.e.
		194
		195	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		196
		197	Pressing this combination runs a command with C<%> replaced by the name of
		198	the textfile. This command can be set via a resource:
		199
		200	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		201
		202	And the default is likely not useful to anybody but the few people around
		203	here :)
		204
		205	The name of the textfile is the hex encoded md5 sum of the selection, so
		206	the same content should lead to the same filename.
		207
		208	After a successful upload the selection will be replaced by the text given
		209	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		210	for the filename):
		211
		212	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		213
91	=back	214	=back
		215
		216	=head1 API DOCUMENTATION
92		217
93	=head2 General API Considerations	218	=head2 General API Considerations
94		219
95	All objects (such as terminals, time watchers etc.) are typical	220	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	221	reference-to-hash objects. The hash can be used to store anything you
…		…
109	=over 4	234	=over 4
110		235
111	=item $text	236	=item $text
112		237
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	238	Rxvt-unicodes special way of encoding text, where one "unicode" character
114	always represents one screen cell. See L<row_t> for a discussion of this format.	239	always represents one screen cell. See L<ROW_t> for a discussion of this format.
115		240
116	=item $string	241	=item $string
117		242
118	A perl text string, with an emphasis on I<text>. It can store all unicode	243	A perl text string, with an emphasis on I<text>. It can store all unicode
119	characters and is to be distinguished with text encoded in a specific	244	characters and is to be distinguished with text encoded in a specific
…		…
124	Either binary data or - more common - a text string encoded in a	249	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	250	locale-specific way.
126		251
127	=back	252	=back
128		253
		254	=head2 Extension Objects
		255
		256	Very perl extension is a perl class. A separate perl object is created
		257	for each terminal and each extension and passed as the first parameter to
		258	hooks. So extensions can use their C<$self> object without having to think
		259	about other extensions, with the exception of methods and members that
		260	begin with an underscore character C<_>: these are reserved for internal
		261	use.
		262
		263	Although it isn't a C<urxvt::term> object, you can call all methods of the
		264	C<urxvt::term> class on this object.
		265
		266	It has the following methods and data members:
		267
		268	=over 4
		269
		270	=item $urxvt_term = $self->{term}
		271
		272	Returns the C<urxvt::term> object associated with this instance of the
		273	extension. This member I<must not> be changed in any way.
		274
		275	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		276
		277	Dynamically enable the given hooks (named without the C<on_> prefix) for
		278	this extension, replacing any previous hook. This is useful when you want
		279	to overwrite time-critical hooks only temporarily.
		280
		281	=item $self->disable ($hook_name[, $hook_name..])
		282
		283	Dynamically disable the given hooks.
		284
		285	=back
		286
129	=head2 Hooks	287	=head2 Hooks
130		288
131	The following subroutines can be declared in extension files, and will be	289	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	290	called whenever the relevant event happens.
133		291
134	The first argument passed to them is an object private to each terminal	292	The first argument passed to them is an extension oject as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	293	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		294
141	All of them must return a boolean value. If it is true, then the event	295	B<All> of these hooks must return a boolean value. If it is true, then the
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	296	event counts as being I<consumed>, and the invocation of other hooks is
143	and the relevant action might not be carried out by the C++ code.	297	skipped, and the relevant action might not be carried out by the C++ code.
144		298
145	When in doubt, return a false value (preferably C<()>).	299	I<< When in doubt, return a false value (preferably C<()>). >>
146		300
147	=over 4	301	=over 4
148		302
149	=item on_init $term	303	=item on_init $term
150		304
…		…
185	=item on_sel_extend $term	339	=item on_sel_extend $term
186		340
187	Called whenever the user tries to extend the selection (e.g. with a double	341	Called whenever the user tries to extend the selection (e.g. with a double
188	click) and is either supposed to return false (normal operation), or	342	click) and is either supposed to return false (normal operation), or
189	should extend the selection itelf and return true to suppress the built-in	343	should extend the selection itelf and return true to suppress the built-in
190	processing.	344	processing. This can happen multiple times, as long as the callback
		345	returns true, it will be called on every further click by the user and is
		346	supposed to enlarge the selection more and more, if possible.
191		347
192	See the F<selection> example extension.	348	See the F<selection> example extension.
193		349
194	=item on_view_change $term, $offset	350	=item on_view_change $term, $offset
195		351
…		…
226	can filter/change and output the text yourself by returning a true value	382	can filter/change and output the text yourself by returning a true value
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	383	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	384	might be very slow, however, as your hook is called for B<all> text being
229	output.	385	output.
230		386
		387	=item on_tt_write $term, $octets
		388
		389	Called whenever some data is written to the tty/pty and can be used to
		390	suppress or filter tty input.
		391
231	=item on_line_update $term, $row	392	=item on_line_update $term, $row
232		393
233	Called whenever a line was updated or changed. Can be used to filter	394	Called whenever a line was updated or changed. Can be used to filter
234	screen output (e.g. underline urls or other useless stuff). Only lines	395	screen output (e.g. underline urls or other useless stuff). Only lines
235	that are being shown will be filtered, and, due to performance reasons,	396	that are being shown will be filtered, and, due to performance reasons,
…		…
257		418
258	Called whenever the user presses a key combination that has a	419	Called whenever the user presses a key combination that has a
259	C<perl:string> action bound to it (see description of the B<keysym>	420	C<perl:string> action bound to it (see description of the B<keysym>
260	resource in the @@RXVT_NAME@@(1) manpage).	421	resource in the @@RXVT_NAME@@(1) manpage).
261		422
		423	=item on_x_event $term, $event
		424
		425	Called on every X event received on the vt window (and possibly other
		426	windows). Should only be used as a last resort. Most event structure
		427	members are not passed.
		428
262	=item on_focus_in $term	429	=item on_focus_in $term
263		430
264	Called whenever the window gets the keyboard focus, before rxvt-unicode	431	Called whenever the window gets the keyboard focus, before rxvt-unicode
265	does focus in processing.	432	does focus in processing.
266		433
267	=item on_focus_out $term	434	=item on_focus_out $term
268		435
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	436	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	437	focus out processing.
271		438
		439	=item on_configure_notify $term, $event
		440
272	=item on_key_press $term, $event, $octets	441	=item on_key_press $term, $event, $keysym, $octets
273		442
274	=item on_key_release $term, $event	443	=item on_key_release $term, $event, $keysym
275		444
276	=item on_button_press $term, $event	445	=item on_button_press $term, $event
277		446
278	=item on_button_release $term, $event	447	=item on_button_release $term, $event
279		448
…		…
295		464
296	subwindow.	465	subwindow.
297		466
298	=back	467	=back
299		468
		469	=cut
		470
		471	package urxvt;
		472
		473	use utf8;
		474	use strict;
		475	use Carp ();
		476	use Scalar::Util ();
		477	use List::Util ();
		478
		479	our $VERSION = 1;
		480	our $TERM;
		481	our @HOOKNAME;
		482	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		483	our %OPTION;
		484
		485	our $LIBDIR;
		486	our $RESNAME;
		487	our $RESCLASS;
		488	our $RXVTNAME;
		489
300	=head2 Variables in the C<urxvt> Package	490	=head2 Variables in the C<urxvt> Package
301		491
302	=over 4	492	=over 4
		493
		494	=item $urxvt::LIBDIR
		495
		496	The rxvt-unicode library directory, where, among other things, the perl
		497	modules and scripts are stored.
		498
		499	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		500
		501	The resource class and name rxvt-unicode uses to look up X resources.
		502
		503	=item $urxvt::RXVTNAME
		504
		505	The basename of the installed binaries, usually C<urxvt>.
303		506
304	=item $urxvt::TERM	507	=item $urxvt::TERM
305		508
306	The current terminal. This variable stores the current C<urxvt::term>	509	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	510	object, whenever a callback/hook is executing.
…		…
309	=back	512	=back
310		513
311	=head2 Functions in the C<urxvt> Package	514	=head2 Functions in the C<urxvt> Package
312		515
313	=over 4	516	=over 4
314
315	=item $term = new urxvt [arg...]
316
317	Creates a new terminal, very similar as if you had started it with
318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319	if the new instance couldn't be created. Returns C<undef> if the new
320	instance didn't initialise perl, and the terminal object otherwise. The
321	C<init> and C<start> hooks will be called during the call.
322		517
323	=item urxvt::fatal $errormessage	518	=item urxvt::fatal $errormessage
324		519
325	Fatally aborts execution with the given error message. Avoid at all	520	Fatally aborts execution with the given error message. Avoid at all
326	costs! The only time this is acceptable is when the terminal process	521	costs! The only time this is acceptable is when the terminal process
…		…
333	that calls this function.	528	that calls this function.
334		529
335	Using this function has the advantage that its output ends up in the	530	Using this function has the advantage that its output ends up in the
336	correct place, e.g. on stderr of the connecting urxvtc client.	531	correct place, e.g. on stderr of the connecting urxvtc client.
337		532
338	=item $is_safe = urxvt::safe	533	Messages have a size limit of 1023 bytes currently.
339
340	Returns true when it is safe to do potentially unsafe things, such as
341	evaluating perl code specified by the user. This is true when urxvt was
342	started setuid or setgid.
343		534
344	=item $time = urxvt::NOW	535	=item $time = urxvt::NOW
345		536
346	Returns the "current time" (as per the event loop).	537	Returns the "current time" (as per the event loop).
347		538
348	=item urxvt::CurrentTime	539	=item urxvt::CurrentTime
349		540
350	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	541	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
351	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	542	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
352	Button4Mask, Button5Mask, AnyModifier	543	Button4Mask, Button5Mask, AnyModifier
		544
		545	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		546	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		547	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		548	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		549	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		550	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		551	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		552
		553	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		554	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		555	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		556	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		557	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		558	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		559	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
353		560
354	Various constants for use in X calls and event processing.	561	Various constants for use in X calls and event processing.
355		562
356	=back	563	=back
357		564
…		…
386		593
387	=item $background = urxvt::GET_BASEBG $rend	594	=item $background = urxvt::GET_BASEBG $rend
388		595
389	Return the foreground/background colour index, respectively.	596	Return the foreground/background colour index, respectively.
390		597
391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	598	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392		599
393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	600	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
394		601
395	Replace the foreground/background colour in the rendition mask with the	602	Replace the foreground/background colour in the rendition mask with the
396	specified one.	603	specified one.
397		604
398	=item $value = urxvt::GET_CUSTOM ($rend)	605	=item $value = urxvt::GET_CUSTOM $rend
399		606
400	Return the "custom" value: Every rendition has 5 bits for use by	607	Return the "custom" value: Every rendition has 5 bits for use by
401	extensions. They can be set and changed as you like and are initially	608	extensions. They can be set and changed as you like and are initially
402	zero.	609	zero.
403		610
404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	611	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405		612
406	Change the custom value.	613	Change the custom value.
407		614
408	=back	615	=back
409		616
410	=cut	617	=cut
411		618
412	package urxvt;
413
414	use utf8;
415	use strict;
416	use Scalar::Util ();
417	use List::Util ();
418
419	our $VERSION = 1;
420	our $TERM;
421	our @HOOKNAME;
422	our %OPTION;
423	our $LIBDIR;
424
425	BEGIN {	619	BEGIN {
426	urxvt->bootstrap;
427
428	# overwrite perl's warn	620	# overwrite perl's warn
429	*CORE::GLOBAL::warn = sub {	621	*CORE::GLOBAL::warn = sub {
430	my $msg = join "", @_;	622	my $msg = join "", @_;
431	$msg .= "\n"	623	$msg .= "\n"
432	unless $msg =~ /\n$/;	624	unless $msg =~ /\n$/;
433	urxvt::warn ($msg);	625	urxvt::warn ($msg);
434	};	626	};
435		627
		628	# %ENV is the original startup environment
436	delete $ENV{IFS};	629	delete $ENV{IFS};
437	delete $ENV{CDPATH};	630	delete $ENV{CDPATH};
438	delete $ENV{BASH_ENV};	631	delete $ENV{BASH_ENV};
439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	632	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
440	}	633	}
441		634
442	my @hook_count;
443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	635	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
444		636
445	sub verbose {	637	sub verbose {
446	my ($level, $msg) = @_;	638	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	639	warn "$msg\n" if $level <= $verbosity;
448	}	640	}
449		641
450	# find on_xxx subs in the package and register them
451	# as hooks
452	sub register_package($) {
453	my ($pkg) = @_;
454
455	for my $htype (0.. $#HOOKNAME) {
456	my $name = $HOOKNAME[$htype];
457
458	my $ref = $pkg->can ("on_" . lc $name)
459	or next;
460
461	$TERM->{_hook}[$htype]{$pkg} = $ref;
462	$hook_count[$htype]++
463	or set_should_invoke $htype, 1;
464	}
465	}
466
467	my $extension_pkg = "extension0000";
468	my %extension_pkg;	642	my %extension_pkg;
469		643
470	# load a single script into its own package, once only	644	# load a single script into its own package, once only
471	sub extension_package($) {	645	sub extension_package($) {
472	my ($path) = @_;	646	my ($path) = @_;
473		647
		648	no strict 'refs';
		649
474	$extension_pkg{$path} \|\|= do {	650	$extension_pkg{$path} \|\|= do {
475	my $pkg = "urxvt::" . ($extension_pkg++);	651	$path =~ /([^\/\\]+)$/;
		652	my $pkg = $1;
		653	$pkg =~ s/[^[:word:]]/_/g;
		654	$pkg = "urxvt::ext::$pkg";
476		655
477	verbose 3, "loading extension '$path' into package '$pkg'";	656	verbose 3, "loading extension '$path' into package '$pkg'";
478		657
479	open my $fh, "<:raw", $path	658	open my $fh, "<:raw", $path
480	or die "$path: $!";	659	or die "$path: $!";
481		660
		661	@{"$pkg\::ISA"} = urxvt::term::extension::;
		662
		663	my $source =
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	664	"package $pkg; use strict; use utf8;\n"
483	. "use base urxvt::term::proxy::;\n"
484	. "#line 1 \"$path\"\n{\n"	665	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	666	. (do { local $/; <$fh> })
486	. "\n};\n1";	667	. "\n};\n1";
487		668
		669	eval $source
488	eval $source or die "$path: $@";	670	or die "$path: $@";
489		671
490	$pkg	672	$pkg
491	}	673	}
492	}	674	}
493		675
…		…
499	my $htype = shift;	681	my $htype = shift;
500		682
501	if ($htype == 0) { # INIT	683	if ($htype == 0) { # INIT
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	684	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503		685
504	my %want_ext;	686	my %ext_arg;
505		687
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	688	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507	if ($_ eq "default") {	689	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	690	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
509	} elsif (/^-(.*)$/) {	691	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	692	delete $ext_arg{$1};
		693	} elsif (/^([^<]+)<(.*)>$/) {
		694	push @{ $ext_arg{$1} }, $2;
511	} else {	695	} else {
512	$want_ext{$_}++;	696	$ext_arg{$_} \|\|= [];
513	}	697	}
514	}	698	}
515		699
516	for my $ext (keys %want_ext) {	700	while (my ($ext, $argv) = each %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	701	my @files = grep -f $_, map "$_/$ext", @dirs;
518		702
519	if (@files) {	703	if (@files) {
520	register_package extension_package $files[0];	704	$TERM->register_package (extension_package $files[0], $argv);
521	} else {	705	} else {
522	warn "perl extension '$ext' not found in perl library search path\n";	706	warn "perl extension '$ext' not found in perl library search path\n";
523	}	707	}
524	}	708	}
525		709
…		…
534	if $verbosity >= 10;	718	if $verbosity >= 10;
535		719
536	keys %$cb;	720	keys %$cb;
537		721
538	while (my ($pkg, $cb) = each %$cb) {	722	while (my ($pkg, $cb) = each %$cb) {
539	eval {	723	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
540	$retval = $cb->(
541	$TERM->{_pkg}{$pkg} \|\|= do {
542	my $proxy = bless { }, $pkg;
543	Scalar::Util::weaken ($proxy->{term} = $TERM);
544	$proxy
545	},
546	@_,
547	) and last;	724	and last;
548	};	725
549	if ($@) {	726	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	727	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	728	warn $@;
552	}	729	}
553	}	730	}
		731
		732	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		733	if $verbosity >= 11;
554	}	734	}
555		735
556	if ($htype == 1) { # DESTROY	736	if ($htype == 1) { # DESTROY
557	# remove hooks if unused
558	if (my $hook = $TERM->{_hook}) {
559	for my $htype (0..$#$hook) {
560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
561	or set_should_invoke $htype, 0;
562	}
563	}
564
565	# clear package objects	737	# clear package objects
566	%$_ = () for values %{ $TERM->{_pkg} };	738	%$_ = () for values %{ $TERM->{_pkg} };
567		739
568	# clear package	740	# clear package
569	%$TERM = ();	741	%$TERM = ();
570	}	742	}
571		743
572	$retval	744	$retval
573	}	745	}
574		746
575	# urxvt::term::proxy	747	sub exec_async(@) {
		748	my $pid = fork;
576		749
577	sub urxvt::term::proxy::AUTOLOAD {	750	return
578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	751	if !defined $pid or $pid;
		752
		753	%ENV = %{ $TERM->env };
		754
		755	exec @_;
		756	_exit 255;
		757	}
		758
		759	# urxvt::term::extension
		760
		761	package urxvt::term::extension;
		762
		763	sub enable {
		764	my ($self, %hook) = @_;
		765	my $pkg = $self->{_pkg};
		766
		767	while (my ($name, $cb) = each %hook) {
		768	my $htype = $HOOKTYPE{uc $name};
		769	defined $htype
		770	or Carp::croak "unsupported hook type '$name'";
		771
		772	$self->set_should_invoke ($htype, +1)
		773	unless exists $self->{term}{_hook}[$htype]{$pkg};
		774
		775	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		776	}
		777	}
		778
		779	sub disable {
		780	my ($self, @hook) = @_;
		781	my $pkg = $self->{_pkg};
		782
		783	for my $name (@hook) {
		784	my $htype = $HOOKTYPE{uc $name};
		785	defined $htype
		786	or Carp::croak "unsupported hook type '$name'";
		787
		788	$self->set_should_invoke ($htype, -1)
		789	if delete $self->{term}{_hook}[$htype]{$pkg};
		790	}
		791	}
		792
		793	our $AUTOLOAD;
		794
		795	sub AUTOLOAD {
		796	$AUTOLOAD =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	797	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		798
581	eval qq{	799	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	800	sub $AUTOLOAD {
583	my \$proxy = shift;	801	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	802	\$proxy->{term}->$1 (\@_)
585	}	803	}
586	1	804	1
587	} or die "FATAL: unable to compile method forwarder: $@";	805	} or die "FATAL: unable to compile method forwarder: $@";
588		806
589	goto &$urxvt::term::proxy::AUTOLOAD;	807	goto &$AUTOLOAD;
590	}	808	}
591		809
592	sub urxvt::term::proxy::DESTROY {	810	sub DESTROY {
593	# nop	811	# nop
594	}	812	}
595		813
596	# urxvt::destroy_hook	814	# urxvt::destroy_hook
597		815
…		…
607		825
608	=head2 The C<urxvt::anyevent> Class	826	=head2 The C<urxvt::anyevent> Class
609		827
610	The sole purpose of this class is to deliver an interface to the	828	The sole purpose of this class is to deliver an interface to the
611	C<AnyEvent> module - any module using it will work inside urxvt without	829	C<AnyEvent> module - any module using it will work inside urxvt without
612	further work. The only exception is that you cannot wait on condition	830	further programming. The only exception is that you cannot wait on
613	variables, but non-blocking condvar use is ok. What this means is that you	831	condition variables, but non-blocking condvar use is ok. What this means
614	cannot use blocking APIs, but the non-blocking variant should work.	832	is that you cannot use blocking APIs, but the non-blocking variant should
		833	work.
615		834
616	=cut	835	=cut
617		836
618	our $VERSION = 1;	837	our $VERSION = 1;
619		838
…		…
664	${$_[0]}++;	883	${$_[0]}++;
665	}	884	}
666		885
667	sub urxvt::anyevent::condvar::wait {	886	sub urxvt::anyevent::condvar::wait {
668	unless (${$_[0]}) {	887	unless (${$_[0]}) {
669	require Carp;
670	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	888	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
671	}	889	}
672	}	890	}
673		891
674	package urxvt::term;	892	package urxvt::term;
675		893
676	=head2 The C<urxvt::term> Class	894	=head2 The C<urxvt::term> Class
677		895
678	=over 4	896	=over 4
679		897
		898	=cut
		899
		900	# find on_xxx subs in the package and register them
		901	# as hooks
		902	sub register_package {
		903	my ($self, $pkg, $argv) = @_;
		904
		905	my $proxy = bless {
		906	_pkg => $pkg,
		907	argv => $argv,
		908	}, $pkg;
		909	Scalar::Util::weaken ($proxy->{term} = $self);
		910
		911	$self->{_pkg}{$pkg} = $proxy;
		912
		913	for my $name (@HOOKNAME) {
		914	if (my $ref = $pkg->can ("on_" . lc $name)) {
		915	$proxy->enable ($name => $ref);
		916	}
		917	}
		918	}
		919
		920	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		921
		922	Creates a new terminal, very similar as if you had started it with system
		923	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		924	hash which defines the environment of the new terminal.
		925
		926	Croaks (and probably outputs an error message) if the new instance
		927	couldn't be created. Returns C<undef> if the new instance didn't
		928	initialise perl, and the terminal object otherwise. The C<init> and
		929	C<start> hooks will be called during this call.
		930
		931	=cut
		932
		933	sub new {
		934	my ($class, $env, @args) = @_;
		935
		936	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		937	}
		938
680	=item $term->destroy	939	=item $term->destroy
681		940
682	Destroy the terminal object (close the window, free resources etc.).	941	Destroy the terminal object (close the window, free resources
		942	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		943	watchers (timers, io watchers) are still active.
683		944
684	=item $isset = $term->option ($optval[, $set])	945	=item $isset = $term->option ($optval[, $set])
685		946
686	Returns true if the option specified by C<$optval> is enabled, and	947	Returns true if the option specified by C<$optval> is enabled, and
687	optionally change it. All option values are stored by name in the hash	948	optionally change it. All option values are stored by name in the hash
…		…
737	my ($self, $name) = (shift, shift);	998	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	999	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	1000	&urxvt::term::_resource
740	}	1001	}
741		1002
		1003	=item $value = $term->x_resource ($pattern)
		1004
		1005	Returns the X-Resource for the given pattern, excluding the program or
		1006	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1007	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1008	resource with that pattern exists.
		1009
		1010	This method should only be called during the C<on_start> hook, as there is
		1011	only one resource database per display, and later invocations might return
		1012	the wrong resources.
		1013
		1014	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1015
		1016	Adds a keymap translation exactly as specified via a resource. See the
		1017	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1018
742	=item $rend = $term->rstyle ([$new_rstyle])	1019	=item $rend = $term->rstyle ([$new_rstyle])
743		1020
744	Return and optionally change the current rendition. Text that is output by	1021	Return and optionally change the current rendition. Text that is output by
745	the terminal application will use this style.	1022	the terminal application will use this style.
746		1023
…		…
756	=item ($row, $col) = $term->selection_end ([$row, $col])	1033	=item ($row, $col) = $term->selection_end ([$row, $col])
757		1034
758	Return the current values of the selection mark, begin or end positions,	1035	Return the current values of the selection mark, begin or end positions,
759	and optionally set them to new values.	1036	and optionally set them to new values.
760		1037
		1038	=item $term->selection_make ($eventtime[, $rectangular])
		1039
		1040	Tries to make a selection as set by C<selection_beg> and
		1041	C<selection_end>. If C<$rectangular> is true (default: false), a
		1042	rectangular selection will be made. This is the prefered function to make
		1043	a selection.
		1044
761	=item $success = $term->selection_grab ($eventtime)	1045	=item $success = $term->selection_grab ($eventtime)
762		1046
763	Try to request the primary selection from the server (for example, as set	1047	Try to request the primary selection text from the server (for example, as
764	by the next method).	1048	set by the next method). No visual feedback will be given. This function
		1049	is mostly useful from within C<on_sel_grab> hooks.
765		1050
766	=item $oldtext = $term->selection ([$newtext])	1051	=item $oldtext = $term->selection ([$newtext])
767		1052
768	Return the current selection text and optionally replace it by C<$newtext>.	1053	Return the current selection text and optionally replace it by C<$newtext>.
769		1054
770	#=item $term->overlay ($x, $y, $text)	1055	=item $term->overlay_simple ($x, $y, $text)
771	#	1056
772	#Create a simple multi-line overlay box. See the next method for details.	1057	Create a simple multi-line overlay box. See the next method for details.
773	#	1058
774	#=cut	1059	=cut
775	#	1060
776	#sub urxvt::term::scr_overlay {	1061	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	1062	my ($self, $x, $y, $text) = @_;
778	#	1063
779	# my @lines = split /\n/, $text;	1064	my @lines = split /\n/, $text;
780	#	1065
781	# my $w = 0;	1066	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	1067
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1068	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1069	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	1070
		1071	$overlay
		1072	}
789		1073
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1074	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		1075
792	Create a new (empty) overlay at the given position with the given	1076	Create a new (empty) overlay at the given position with the given
793	width/height. C<$rstyle> defines the initial rendition style	1077	width/height. C<$rstyle> defines the initial rendition style
…		…
860		1144
861	=item $string = $term->locale_decode ($octets)	1145	=item $string = $term->locale_decode ($octets)
862		1146
863	Convert the given locale-encoded octets into a perl string.	1147	Convert the given locale-encoded octets into a perl string.
864		1148
		1149	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1150
		1151	XORs the rendition values in the given span with the provided value
		1152	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1153	refresh hooks to provide effects similar to the selection.
		1154
		1155	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1156
		1157	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1158	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1159	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1160	it instead. Both styles I<MUST NOT> contain font styles.
		1161
		1162	=item $term->scr_bell
		1163
		1164	Ring the bell!
		1165
865	=item $term->scr_add_lines ($string)	1166	=item $term->scr_add_lines ($string)
866		1167
867	Write the given text string to the screen, as if output by the application	1168	Write the given text string to the screen, as if output by the application
868	running inside the terminal. It may not contain command sequences (escape	1169	running inside the terminal. It may not contain command sequences (escape
869	codes), but is free to use line feeds, carriage returns and tabs. The	1170	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
883		1184
884	Write the octets given in C<$data> to the tty (i.e. as program input). To	1185	Write the octets given in C<$data> to the tty (i.e. as program input). To
885	pass characters instead of octets, you should convert your strings first	1186	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	1187	to the locale-specific encoding using C<< $term->locale_encode >>.
887		1188
		1189	=item $old_events = $term->pty_ev_events ([$new_events])
		1190
		1191	Replaces the event mask of the pty watcher by the given event mask. Can
		1192	be used to suppress input and output handling to the pty/tty. See the
		1193	description of C<< urxvt::timer->events >>. Make sure to always restore
		1194	the previous value.
		1195
888	=item $windowid = $term->parent	1196	=item $windowid = $term->parent
889		1197
890	Return the window id of the toplevel window.	1198	Return the window id of the toplevel window.
891		1199
892	=item $windowid = $term->vt	1200	=item $windowid = $term->vt
893		1201
894	Return the window id of the terminal window.	1202	Return the window id of the terminal window.
895		1203
		1204	=item $term->vt_emask_add ($x_event_mask)
		1205
		1206	Adds the specified events to the vt event mask. Useful e.g. when you want
		1207	to receive pointer events all the times:
		1208
		1209	$term->vt_emask_add (urxvt::PointerMotionMask);
		1210
896	=item $window_width = $term->width	1211	=item $window_width = $term->width
897		1212
898	=item $window_height = $term->height	1213	=item $window_height = $term->height
899		1214
900	=item $font_width = $term->fwidth	1215	=item $font_width = $term->fwidth
…		…
913		1228
914	=item $max_scrollback = $term->saveLines	1229	=item $max_scrollback = $term->saveLines
915		1230
916	=item $nrow_plus_saveLines = $term->total_rows	1231	=item $nrow_plus_saveLines = $term->total_rows
917		1232
918	=item $lines_in_scrollback = $term->nsaved	1233	=item $topmost_scrollback_row = $term->top_row
919		1234
920	Return various integers describing terminal characteristics.	1235	Return various integers describing terminal characteristics.
		1236
		1237	=item $x_display = $term->display_id
		1238
		1239	Return the DISPLAY used by rxvt-unicode.
		1240
		1241	=item $lc_ctype = $term->locale
		1242
		1243	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1244
		1245	=item $env = $term->env
		1246
		1247	Returns a copy of the environment in effect for the terminal as a hashref
		1248	similar to C<\%ENV>.
		1249
		1250	=cut
		1251
		1252	sub env {
		1253	if (my $env = $_[0]->_env) {
		1254	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1255	} else {
		1256	+{ %ENV }
		1257	}
		1258	}
921		1259
922	=item $modifiermask = $term->ModLevel3Mask	1260	=item $modifiermask = $term->ModLevel3Mask
923		1261
924	=item $modifiermask = $term->ModMetaMask	1262	=item $modifiermask = $term->ModMetaMask
925		1263
…		…
928	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1266	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
929	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1267	AltGr), the meta key (often Alt) and the num lock key, if applicable.
930		1268
931	=item $view_start = $term->view_start ([$newvalue])	1269	=item $view_start = $term->view_start ([$newvalue])
932		1270
933	Returns the negative row number of the topmost line. Minimum value is	1271	Returns the row number of the topmost displayed line. Maximum value is
934	C<0>, which displays the normal terminal contents. Larger values scroll	1272	C<0>, which displays the normal terminal contents. Lower values scroll
935	this many lines into the scrollback buffer.	1273	this many lines into the scrollback buffer.
936		1274
937	=item $term->want_refresh	1275	=item $term->want_refresh
938		1276
939	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1277	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1018	Return the row number of the first/last row of the line, respectively.	1356	Return the row number of the first/last row of the line, respectively.
1019		1357
1020	=item $offset = $line->offset_of ($row, $col)	1358	=item $offset = $line->offset_of ($row, $col)
1021		1359
1022	Returns the character offset of the given row\|col pair within the logical	1360	Returns the character offset of the given row\|col pair within the logical
1023	line.	1361	line. Works for rows outside the line, too, and returns corresponding
		1362	offsets outside the string.
1024		1363
1025	=item ($row, $col) = $line->coord_of ($offset)	1364	=item ($row, $col) = $line->coord_of ($offset)
1026		1365
1027	Translates a string offset into terminal coordinates again.	1366	Translates a string offset into terminal coordinates again.
1028		1367
…		…
1165	$item->{render} \|\|= sub { $_[0]{text} };	1504	$item->{render} \|\|= sub { $_[0]{text} };
1166		1505
1167	push @{ $self->{item} }, $item;	1506	push @{ $self->{item} }, $item;
1168	}	1507	}
1169		1508
1170	sub add_separator {	1509	=item $popup->add_title ($title)
1171	my ($self, $sep) = @_;
1172		1510
1173	$sep \|\|= "═";	1511	Adds a non-clickable title to the popup.
1174		1512
1175	$self->add_item ({	1513	=cut
1176	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1177	text => "",
1178	render => sub { $sep x $urxvt::TERM->ncol },
1179	activate => sub { },
1180	});
1181	}
1182		1514
1183	sub add_title {	1515	sub add_title {
1184	my ($self, $title) = @_;	1516	my ($self, $title) = @_;
1185		1517
1186	$self->add_item ({	1518	$self->add_item ({
…		…
1188	text => $title,	1520	text => $title,
1189	activate => sub { },	1521	activate => sub { },
1190	});	1522	});
1191	}	1523	}
1192		1524
		1525	=item $popup->add_separator ([$sepchr])
		1526
		1527	Creates a separator, optionally using the character given as C<$sepchr>.
		1528
		1529	=cut
		1530
		1531	sub add_separator {
		1532	my ($self, $sep) = @_;
		1533
		1534	$sep \|\|= "=";
		1535
		1536	$self->add_item ({
		1537	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1538	text => "",
		1539	render => sub { $sep x $self->{term}->ncol },
		1540	activate => sub { },
		1541	});
		1542	}
		1543
		1544	=item $popup->add_button ($text, $cb)
		1545
		1546	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1547	selected.
		1548
		1549	=cut
		1550
1193	sub add_button {	1551	sub add_button {
1194	my ($self, $text, $cb) = @_;	1552	my ($self, $text, $cb) = @_;
1195		1553
1196	$self->add_item ({ type => "button", text => $text, activate => $cb});	1554	$self->add_item ({ type => "button", text => $text, activate => $cb});
1197	}	1555	}
		1556
		1557	=item $popup->add_toggle ($text, $cb, $initial_value)
		1558
		1559	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1560	whenever it gets toggled, with a boolean indicating its value as its first
		1561	argument.
		1562
		1563	=cut
1198		1564
1199	sub add_toggle {	1565	sub add_toggle {
1200	my ($self, $text, $cb, $value) = @_;	1566	my ($self, $text, $cb, $value) = @_;
1201		1567
1202	my $item; $item = {	1568	my $item; $item = {
1203	type => "button",	1569	type => "button",
1204	text => " $text",	1570	text => " $text",
1205	value => $value,	1571	value => $value,
1206	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1572	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1207	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1573	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1208	};	1574	};
1209		1575
1210	$self->add_item ($item);	1576	$self->add_item ($item);
1211	}	1577	}
		1578
		1579	=item $popup->show
		1580
		1581	Displays the popup (which is initially hidden).
		1582
		1583	=cut
1212		1584
1213	sub show {	1585	sub show {
1214	my ($self) = @_;	1586	my ($self) = @_;
1215		1587
1216	local $urxvt::popup::self = $self;	1588	local $urxvt::popup::self = $self;
1217		1589
		1590	my $env = $self->{term}->env;
		1591	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1592	delete $env->{LC_ALL};
		1593	$env->{LC_CTYPE} = $self->{term}->locale;
		1594
		1595	urxvt::term->new ($env, $self->{term}->resource ("name"),
1218	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1596	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1219	"--transient-for" => $self->{term}->parent,	1597	"--transient-for" => $self->{term}->parent,
1220	"-display" => $self->{term}->display_id,	1598	"-display" => $self->{term}->display_id,
1221	"-pe" => "urxvt-popup")	1599	"-pe" => "urxvt-popup")
1222	or die "unable to create popup window\n";	1600	or die "unable to create popup window\n";
1223	}	1601	}
1224		1602
1225	sub DESTROY {	1603	sub DESTROY {
1226	my ($self) = @_;	1604	my ($self) = @_;
1227		1605
1228	delete $self->{term}{_destroy}{$self};	1606	delete $self->{term}{_destroy}{$self};
1229	$self->{term}->ungrab;	1607	$self->{term}->ungrab;
1230	}	1608	}
		1609
		1610	=back
1231		1611
1232	=head2 The C<urxvt::timer> Class	1612	=head2 The C<urxvt::timer> Class
1233		1613
1234	This class implements timer watchers/events. Time is represented as a	1614	This class implements timer watchers/events. Time is represented as a
1235	fractional number of seconds since the epoch. Example:	1615	fractional number of seconds since the epoch. Example:
…		…
1288		1668
1289	$term->{socket} = ...	1669	$term->{socket} = ...
1290	$term->{iow} = urxvt::iow	1670	$term->{iow} = urxvt::iow
1291	->new	1671	->new
1292	->fd (fileno $term->{socket})	1672	->fd (fileno $term->{socket})
1293	->events (1) # wait for read data	1673	->events (urxvt::EVENT_READ)
1294	->start	1674	->start
1295	->cb (sub {	1675	->cb (sub {
1296	my ($iow, $revents) = @_;	1676	my ($iow, $revents) = @_;
1297	# $revents must be 1 here, no need to check	1677	# $revents must be 1 here, no need to check
1298	sysread $term->{socket}, my $buf, 8192	1678	sysread $term->{socket}, my $buf, 8192
…		…
1315		1695
1316	Set the filedescriptor (not handle) to watch.	1696	Set the filedescriptor (not handle) to watch.
1317		1697
1318	=item $iow = $iow->events ($eventmask)	1698	=item $iow = $iow->events ($eventmask)
1319		1699
1320	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1700	Set the event mask to watch. The only allowed values are
1321	data, Bit #1 (value C<2>) enables watching for write data.	1701	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1702	together, or C<urxvt::EVENT_NONE>.
1322		1703
1323	=item $iow = $iow->start	1704	=item $iow = $iow->start
1324		1705
1325	Start watching for requested events on the given handle.	1706	Start watching for requested events on the given handle.
1326		1707
…		…
1341		1722
1342	=item == 0 - fatal messages	1723	=item == 0 - fatal messages
1343		1724
1344	=item >= 3 - script loading and management	1725	=item >= 3 - script loading and management
1345		1726
1346	=item >=10 - all events received	1727	=item >=10 - all called hooks
		1728
		1729	=item >=11 - hook reutrn values
1347		1730
1348	=back	1731	=back
1349		1732
1350	=head1 AUTHOR	1733	=head1 AUTHOR
1351		1734

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.64 by root, Mon Jan 9 06:29:47 2006 UTC vs. Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.64 by root, Mon Jan 9 06:29:47 2006 UTC vs.
Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC