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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.66 by root, Mon Jan 9 19:28:39 2006 UTC vs.
Revision 1.101 by root, Wed Jan 18 10:11:03 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
272	=item on_key_press $term, $event, $octets	439	=item on_key_press $term, $event, $keysym, $octets
273		440
274	=item on_key_release $term, $event	441	=item on_key_release $term, $event, $keysym
275		442
276	=item on_button_press $term, $event	443	=item on_button_press $term, $event
277		444
278	=item on_button_release $term, $event	445	=item on_button_release $term, $event
279		446
…		…
295		462
296	subwindow.	463	subwindow.
297		464
298	=back	465	=back
299		466
		467	=cut
		468
		469	package urxvt;
		470
		471	use utf8;
		472	use strict;
		473	use Carp ();
		474	use Scalar::Util ();
		475	use List::Util ();
		476
		477	our $VERSION = 1;
		478	our $TERM;
		479	our @HOOKNAME;
		480	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		481	our %OPTION;
		482
		483	our $LIBDIR;
		484	our $RESNAME;
		485	our $RESCLASS;
		486	our $RXVTNAME;
		487
300	=head2 Variables in the C<urxvt> Package	488	=head2 Variables in the C<urxvt> Package
301		489
302	=over 4	490	=over 4
		491
		492	=item $urxvt::LIBDIR
		493
		494	The rxvt-unicode library directory, where, among other things, the perl
		495	modules and scripts are stored.
		496
		497	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		498
		499	The resource class and name rxvt-unicode uses to look up X resources.
		500
		501	=item $urxvt::RXVTNAME
		502
		503	The basename of the installed binaries, usually C<urxvt>.
303		504
304	=item $urxvt::TERM	505	=item $urxvt::TERM
305		506
306	The current terminal. This variable stores the current C<urxvt::term>	507	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	508	object, whenever a callback/hook is executing.
…		…
309	=back	510	=back
310		511
311	=head2 Functions in the C<urxvt> Package	512	=head2 Functions in the C<urxvt> Package
312		513
313	=over 4	514	=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		515
323	=item urxvt::fatal $errormessage	516	=item urxvt::fatal $errormessage
324		517
325	Fatally aborts execution with the given error message. Avoid at all	518	Fatally aborts execution with the given error message. Avoid at all
326	costs! The only time this is acceptable is when the terminal process	519	costs! The only time this is acceptable is when the terminal process
…		…
333	that calls this function.	526	that calls this function.
334		527
335	Using this function has the advantage that its output ends up in the	528	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.	529	correct place, e.g. on stderr of the connecting urxvtc client.
337		530
338	=item $is_safe = urxvt::safe	531	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		532
344	=item $time = urxvt::NOW	533	=item $time = urxvt::NOW
345		534
346	Returns the "current time" (as per the event loop).	535	Returns the "current time" (as per the event loop).
347		536
348	=item urxvt::CurrentTime	537	=item urxvt::CurrentTime
349		538
350	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	539	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
351	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	540	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
352	Button4Mask, Button5Mask, AnyModifier	541	Button4Mask, Button5Mask, AnyModifier
		542
		543	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		544	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		545	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		546	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		547	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		548	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		549	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		550
		551	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		552	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		553	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		554	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		555	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		556	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		557	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
353		558
354	Various constants for use in X calls and event processing.	559	Various constants for use in X calls and event processing.
355		560
356	=back	561	=back
357		562
…		…
386		591
387	=item $background = urxvt::GET_BASEBG $rend	592	=item $background = urxvt::GET_BASEBG $rend
388		593
389	Return the foreground/background colour index, respectively.	594	Return the foreground/background colour index, respectively.
390		595
391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	596	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392		597
393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	598	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
394		599
395	Replace the foreground/background colour in the rendition mask with the	600	Replace the foreground/background colour in the rendition mask with the
396	specified one.	601	specified one.
397		602
398	=item $value = urxvt::GET_CUSTOM ($rend)	603	=item $value = urxvt::GET_CUSTOM $rend
399		604
400	Return the "custom" value: Every rendition has 5 bits for use by	605	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	606	extensions. They can be set and changed as you like and are initially
402	zero.	607	zero.
403		608
404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	609	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405		610
406	Change the custom value.	611	Change the custom value.
407		612
408	=back	613	=back
409		614
410	=cut	615	=cut
411		616
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 {	617	BEGIN {
426	urxvt->bootstrap;
427
428	# overwrite perl's warn	618	# overwrite perl's warn
429	*CORE::GLOBAL::warn = sub {	619	*CORE::GLOBAL::warn = sub {
430	my $msg = join "", @_;	620	my $msg = join "", @_;
431	$msg .= "\n"	621	$msg .= "\n"
432	unless $msg =~ /\n$/;	622	unless $msg =~ /\n$/;
433	urxvt::warn ($msg);	623	urxvt::warn ($msg);
434	};	624	};
435		625
		626	# %ENV is the original startup environment
436	delete $ENV{IFS};	627	delete $ENV{IFS};
437	delete $ENV{CDPATH};	628	delete $ENV{CDPATH};
438	delete $ENV{BASH_ENV};	629	delete $ENV{BASH_ENV};
439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	630	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
440	}	631	}
441		632
442	my @hook_count;
443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	633	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
444		634
445	sub verbose {	635	sub verbose {
446	my ($level, $msg) = @_;	636	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	637	warn "$msg\n" if $level <= $verbosity;
448	}	638	}
449		639
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;	640	my %extension_pkg;
469		641
470	# load a single script into its own package, once only	642	# load a single script into its own package, once only
471	sub extension_package($) {	643	sub extension_package($) {
472	my ($path) = @_;	644	my ($path) = @_;
473		645
		646	no strict 'refs';
		647
474	$extension_pkg{$path} \|\|= do {	648	$extension_pkg{$path} \|\|= do {
475	my $pkg = "urxvt::" . ($extension_pkg++);	649	$path =~ /([^\/\\]+)$/;
		650	my $pkg = $1;
		651	$pkg =~ s/[^[:word:]]/_/g;
		652	$pkg = "urxvt::ext::$pkg";
476		653
477	verbose 3, "loading extension '$path' into package '$pkg'";	654	verbose 3, "loading extension '$path' into package '$pkg'";
478		655
479	open my $fh, "<:raw", $path	656	open my $fh, "<:raw", $path
480	or die "$path: $!";	657	or die "$path: $!";
481		658
		659	@{"$pkg\::ISA"} = urxvt::term::extension::;
		660
		661	my $source =
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	662	"package $pkg; use strict; use utf8;\n"
483	. "use base urxvt::term::proxy::;\n"
484	. "#line 1 \"$path\"\n{\n"	663	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	664	. (do { local $/; <$fh> })
486	. "\n};\n1";	665	. "\n};\n1";
487		666
		667	eval $source
488	eval $source or die "$path: $@";	668	or die "$path: $@";
489		669
490	$pkg	670	$pkg
491	}	671	}
492	}	672	}
493		673
…		…
499	my $htype = shift;	679	my $htype = shift;
500		680
501	if ($htype == 0) { # INIT	681	if ($htype == 0) { # INIT
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	682	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503		683
504	my %want_ext;	684	my %ext_arg;
505		685
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	686	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507	if ($_ eq "default") {	687	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	688	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
509	} elsif (/^-(.*)$/) {	689	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	690	delete $ext_arg{$1};
		691	} elsif (/^([^<]+)<(.*)>$/) {
		692	push @{ $ext_arg{$1} }, $2;
511	} else {	693	} else {
512	$want_ext{$_}++;	694	$ext_arg{$_} \|\|= [];
513	}	695	}
514	}	696	}
515		697
516	for my $ext (keys %want_ext) {	698	while (my ($ext, $argv) = each %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	699	my @files = grep -f $_, map "$_/$ext", @dirs;
518		700
519	if (@files) {	701	if (@files) {
520	register_package extension_package $files[0];	702	$TERM->register_package (extension_package $files[0], $argv);
521	} else {	703	} else {
522	warn "perl extension '$ext' not found in perl library search path\n";	704	warn "perl extension '$ext' not found in perl library search path\n";
523	}	705	}
524	}	706	}
525		707
…		…
534	if $verbosity >= 10;	716	if $verbosity >= 10;
535		717
536	keys %$cb;	718	keys %$cb;
537		719
538	while (my ($pkg, $cb) = each %$cb) {	720	while (my ($pkg, $cb) = each %$cb) {
539	eval {	721	$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;	722	and last;
548	};	723
549	if ($@) {	724	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	725	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	726	warn $@;
552	}	727	}
553	}	728	}
		729
		730	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		731	if $verbosity >= 11;
554	}	732	}
555		733
556	if ($htype == 1) { # DESTROY	734	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	735	# clear package objects
566	%$_ = () for values %{ $TERM->{_pkg} };	736	%$_ = () for values %{ $TERM->{_pkg} };
567		737
568	# clear package	738	# clear package
569	%$TERM = ();	739	%$TERM = ();
570	}	740	}
571		741
572	$retval	742	$retval
573	}	743	}
574		744
575	# urxvt::term::proxy	745	sub exec_async(@) {
		746	my $pid = fork;
576		747
577	sub urxvt::term::proxy::AUTOLOAD {	748	return
578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	749	if !defined $pid or $pid;
		750
		751	%ENV = %{ $TERM->env };
		752
		753	exec @_;
		754	_exit 255;
		755	}
		756
		757	# urxvt::term::extension
		758
		759	package urxvt::term::extension;
		760
		761	sub enable {
		762	my ($self, %hook) = @_;
		763	my $pkg = $self->{_pkg};
		764
		765	while (my ($name, $cb) = each %hook) {
		766	my $htype = $HOOKTYPE{uc $name};
		767	defined $htype
		768	or Carp::croak "unsupported hook type '$name'";
		769
		770	$self->set_should_invoke ($htype, +1)
		771	unless exists $self->{term}{_hook}[$htype]{$pkg};
		772
		773	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		774	}
		775	}
		776
		777	sub disable {
		778	my ($self, @hook) = @_;
		779	my $pkg = $self->{_pkg};
		780
		781	for my $name (@hook) {
		782	my $htype = $HOOKTYPE{uc $name};
		783	defined $htype
		784	or Carp::croak "unsupported hook type '$name'";
		785
		786	$self->set_should_invoke ($htype, -1)
		787	if delete $self->{term}{_hook}[$htype]{$pkg};
		788	}
		789	}
		790
		791	our $AUTOLOAD;
		792
		793	sub AUTOLOAD {
		794	$AUTOLOAD =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	795	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		796
581	eval qq{	797	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	798	sub $AUTOLOAD {
583	my \$proxy = shift;	799	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	800	\$proxy->{term}->$1 (\@_)
585	}	801	}
586	1	802	1
587	} or die "FATAL: unable to compile method forwarder: $@";	803	} or die "FATAL: unable to compile method forwarder: $@";
588		804
589	goto &$urxvt::term::proxy::AUTOLOAD;	805	goto &$AUTOLOAD;
590	}	806	}
591		807
592	sub urxvt::term::proxy::DESTROY {	808	sub DESTROY {
593	# nop	809	# nop
594	}	810	}
595		811
596	# urxvt::destroy_hook	812	# urxvt::destroy_hook
597		813
…		…
607		823
608	=head2 The C<urxvt::anyevent> Class	824	=head2 The C<urxvt::anyevent> Class
609		825
610	The sole purpose of this class is to deliver an interface to the	826	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	827	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	828	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	829	condition variables, but non-blocking condvar use is ok. What this means
614	cannot use blocking APIs, but the non-blocking variant should work.	830	is that you cannot use blocking APIs, but the non-blocking variant should
		831	work.
615		832
616	=cut	833	=cut
617		834
618	our $VERSION = 1;	835	our $VERSION = 1;
619		836
…		…
664	${$_[0]}++;	881	${$_[0]}++;
665	}	882	}
666		883
667	sub urxvt::anyevent::condvar::wait {	884	sub urxvt::anyevent::condvar::wait {
668	unless (${$_[0]}) {	885	unless (${$_[0]}) {
669	require Carp;
670	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	886	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
671	}	887	}
672	}	888	}
673		889
674	package urxvt::term;	890	package urxvt::term;
675		891
676	=head2 The C<urxvt::term> Class	892	=head2 The C<urxvt::term> Class
677		893
678	=over 4	894	=over 4
679		895
		896	=cut
		897
		898	# find on_xxx subs in the package and register them
		899	# as hooks
		900	sub register_package {
		901	my ($self, $pkg, $argv) = @_;
		902
		903	my $proxy = bless {
		904	_pkg => $pkg,
		905	argv => $argv,
		906	}, $pkg;
		907	Scalar::Util::weaken ($proxy->{term} = $self);
		908
		909	$self->{_pkg}{$pkg} = $proxy;
		910
		911	for my $name (@HOOKNAME) {
		912	if (my $ref = $pkg->can ("on_" . lc $name)) {
		913	$proxy->enable ($name => $ref);
		914	}
		915	}
		916	}
		917
		918	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		919
		920	Creates a new terminal, very similar as if you had started it with system
		921	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		922	hash which defines the environment of the new terminal.
		923
		924	Croaks (and probably outputs an error message) if the new instance
		925	couldn't be created. Returns C<undef> if the new instance didn't
		926	initialise perl, and the terminal object otherwise. The C<init> and
		927	C<start> hooks will be called during this call.
		928
		929	=cut
		930
		931	sub new {
		932	my ($class, $env, @args) = @_;
		933
		934	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		935	}
		936
680	=item $term->destroy	937	=item $term->destroy
681		938
682	Destroy the terminal object (close the window, free resources etc.).	939	Destroy the terminal object (close the window, free resources
		940	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		941	watchers (timers, io watchers) are still active.
683		942
684	=item $isset = $term->option ($optval[, $set])	943	=item $isset = $term->option ($optval[, $set])
685		944
686	Returns true if the option specified by C<$optval> is enabled, and	945	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	946	optionally change it. All option values are stored by name in the hash
…		…
737	my ($self, $name) = (shift, shift);	996	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	997	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	998	&urxvt::term::_resource
740	}	999	}
741		1000
		1001	=item $value = $term->x_resource ($pattern)
		1002
		1003	Returns the X-Resource for the given pattern, excluding the program or
		1004	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1005	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1006	resource with that pattern exists.
		1007
		1008	This method should only be called during the C<on_start> hook, as there is
		1009	only one resource database per display, and later invocations might return
		1010	the wrong resources.
		1011
		1012	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1013
		1014	Adds a keymap translation exactly as specified via a resource. See the
		1015	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1016
742	=item $rend = $term->rstyle ([$new_rstyle])	1017	=item $rend = $term->rstyle ([$new_rstyle])
743		1018
744	Return and optionally change the current rendition. Text that is output by	1019	Return and optionally change the current rendition. Text that is output by
745	the terminal application will use this style.	1020	the terminal application will use this style.
746		1021
…		…
756	=item ($row, $col) = $term->selection_end ([$row, $col])	1031	=item ($row, $col) = $term->selection_end ([$row, $col])
757		1032
758	Return the current values of the selection mark, begin or end positions,	1033	Return the current values of the selection mark, begin or end positions,
759	and optionally set them to new values.	1034	and optionally set them to new values.
760		1035
		1036	=item $term->selection_make ($eventtime[, $rectangular])
		1037
		1038	Tries to make a selection as set by C<selection_beg> and
		1039	C<selection_end>. If C<$rectangular> is true (default: false), a
		1040	rectangular selection will be made. This is the prefered function to make
		1041	a selection.
		1042
761	=item $success = $term->selection_grab ($eventtime)	1043	=item $success = $term->selection_grab ($eventtime)
762		1044
763	Try to request the primary selection from the server (for example, as set	1045	Try to request the primary selection text from the server (for example, as
764	by the next method).	1046	set by the next method). No visual feedback will be given. This function
		1047	is mostly useful from within C<on_sel_grab> hooks.
765		1048
766	=item $oldtext = $term->selection ([$newtext])	1049	=item $oldtext = $term->selection ([$newtext])
767		1050
768	Return the current selection text and optionally replace it by C<$newtext>.	1051	Return the current selection text and optionally replace it by C<$newtext>.
769		1052
770	#=item $term->overlay ($x, $y, $text)	1053	=item $term->overlay_simple ($x, $y, $text)
771	#	1054
772	#Create a simple multi-line overlay box. See the next method for details.	1055	Create a simple multi-line overlay box. See the next method for details.
773	#	1056
774	#=cut	1057	=cut
775	#	1058
776	#sub urxvt::term::scr_overlay {	1059	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	1060	my ($self, $x, $y, $text) = @_;
778	#	1061
779	# my @lines = split /\n/, $text;	1062	my @lines = split /\n/, $text;
780	#	1063
781	# my $w = 0;	1064	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	1065
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1066	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1067	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	1068
		1069	$overlay
		1070	}
789		1071
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1072	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		1073
792	Create a new (empty) overlay at the given position with the given	1074	Create a new (empty) overlay at the given position with the given
793	width/height. C<$rstyle> defines the initial rendition style	1075	width/height. C<$rstyle> defines the initial rendition style
…		…
860		1142
861	=item $string = $term->locale_decode ($octets)	1143	=item $string = $term->locale_decode ($octets)
862		1144
863	Convert the given locale-encoded octets into a perl string.	1145	Convert the given locale-encoded octets into a perl string.
864		1146
		1147	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1148
		1149	XORs the rendition values in the given span with the provided value
		1150	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1151	refresh hooks to provide effects similar to the selection.
		1152
		1153	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1154
		1155	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1156	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1157	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1158	it instead. Both styles I<MUST NOT> contain font styles.
		1159
		1160	=item $term->scr_bell
		1161
		1162	Ring the bell!
		1163
865	=item $term->scr_add_lines ($string)	1164	=item $term->scr_add_lines ($string)
866		1165
867	Write the given text string to the screen, as if output by the application	1166	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	1167	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	1168	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
883		1182
884	Write the octets given in C<$data> to the tty (i.e. as program input). To	1183	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	1184	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	1185	to the locale-specific encoding using C<< $term->locale_encode >>.
887		1186
		1187	=item $old_events = $term->pty_ev_events ([$new_events])
		1188
		1189	Replaces the event mask of the pty watcher by the given event mask. Can
		1190	be used to suppress input and output handling to the pty/tty. See the
		1191	description of C<< urxvt::timer->events >>. Make sure to always restore
		1192	the previous value.
		1193
888	=item $windowid = $term->parent	1194	=item $windowid = $term->parent
889		1195
890	Return the window id of the toplevel window.	1196	Return the window id of the toplevel window.
891		1197
892	=item $windowid = $term->vt	1198	=item $windowid = $term->vt
893		1199
894	Return the window id of the terminal window.	1200	Return the window id of the terminal window.
895		1201
		1202	=item $term->vt_emask_add ($x_event_mask)
		1203
		1204	Adds the specified events to the vt event mask. Useful e.g. when you want
		1205	to receive pointer events all the times:
		1206
		1207	$term->vt_emask_add (urxvt::PointerMotionMask);
		1208
896	=item $window_width = $term->width	1209	=item $window_width = $term->width
897		1210
898	=item $window_height = $term->height	1211	=item $window_height = $term->height
899		1212
900	=item $font_width = $term->fwidth	1213	=item $font_width = $term->fwidth
…		…
913		1226
914	=item $max_scrollback = $term->saveLines	1227	=item $max_scrollback = $term->saveLines
915		1228
916	=item $nrow_plus_saveLines = $term->total_rows	1229	=item $nrow_plus_saveLines = $term->total_rows
917		1230
918	=item $lines_in_scrollback = $term->nsaved	1231	=item $topmost_scrollback_row = $term->top_row
919		1232
920	Return various integers describing terminal characteristics.	1233	Return various integers describing terminal characteristics.
921		1234
		1235	=item $x_display = $term->display_id
		1236
		1237	Return the DISPLAY used by rxvt-unicode.
		1238
922	=item $lc_ctype = $term->locale	1239	=item $lc_ctype = $term->locale
923		1240
924	Returns the LC_CTYPE category string used by this rxvt-unicode.	1241	Returns the LC_CTYPE category string used by this rxvt-unicode.
925		1242
926	=item $x_display = $term->display_id	1243	=item $env = $term->env
927		1244
928	Return the DISPLAY used by rxvt-unicode.	1245	Returns a copy of the environment in effect for the terminal as a hashref
		1246	similar to C<\%ENV>.
		1247
		1248	=cut
		1249
		1250	sub env {
		1251	if (my $env = $_[0]->_env) {
		1252	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1253	} else {
		1254	+{ %ENV }
		1255	}
		1256	}
929		1257
930	=item $modifiermask = $term->ModLevel3Mask	1258	=item $modifiermask = $term->ModLevel3Mask
931		1259
932	=item $modifiermask = $term->ModMetaMask	1260	=item $modifiermask = $term->ModMetaMask
933		1261
…		…
936	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1264	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
937	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1265	AltGr), the meta key (often Alt) and the num lock key, if applicable.
938		1266
939	=item $view_start = $term->view_start ([$newvalue])	1267	=item $view_start = $term->view_start ([$newvalue])
940		1268
941	Returns the negative row number of the topmost line. Minimum value is	1269	Returns the row number of the topmost displayed line. Maximum value is
942	C<0>, which displays the normal terminal contents. Larger values scroll	1270	C<0>, which displays the normal terminal contents. Lower values scroll
943	this many lines into the scrollback buffer.	1271	this many lines into the scrollback buffer.
944		1272
945	=item $term->want_refresh	1273	=item $term->want_refresh
946		1274
947	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1275	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1026	Return the row number of the first/last row of the line, respectively.	1354	Return the row number of the first/last row of the line, respectively.
1027		1355
1028	=item $offset = $line->offset_of ($row, $col)	1356	=item $offset = $line->offset_of ($row, $col)
1029		1357
1030	Returns the character offset of the given row\|col pair within the logical	1358	Returns the character offset of the given row\|col pair within the logical
1031	line.	1359	line. Works for rows outside the line, too, and returns corresponding
		1360	offsets outside the string.
1032		1361
1033	=item ($row, $col) = $line->coord_of ($offset)	1362	=item ($row, $col) = $line->coord_of ($offset)
1034		1363
1035	Translates a string offset into terminal coordinates again.	1364	Translates a string offset into terminal coordinates again.
1036		1365
…		…
1173	$item->{render} \|\|= sub { $_[0]{text} };	1502	$item->{render} \|\|= sub { $_[0]{text} };
1174		1503
1175	push @{ $self->{item} }, $item;	1504	push @{ $self->{item} }, $item;
1176	}	1505	}
1177		1506
		1507	=item $popup->add_title ($title)
		1508
		1509	Adds a non-clickable title to the popup.
		1510
		1511	=cut
		1512
		1513	sub add_title {
		1514	my ($self, $title) = @_;
		1515
		1516	$self->add_item ({
		1517	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1518	text => $title,
		1519	activate => sub { },
		1520	});
		1521	}
		1522
		1523	=item $popup->add_separator ([$sepchr])
		1524
		1525	Creates a separator, optionally using the character given as C<$sepchr>.
		1526
		1527	=cut
		1528
1178	sub add_separator {	1529	sub add_separator {
1179	my ($self, $sep) = @_;	1530	my ($self, $sep) = @_;
1180		1531
1181	$sep \|\|= "═";	1532	$sep \|\|= "=";
1182		1533
1183	$self->add_item ({	1534	$self->add_item ({
1184	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },	1535	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1185	text => "",	1536	text => "",
1186	render => sub { $sep x $self->{term}->ncol },	1537	render => sub { $sep x $self->{term}->ncol },
1187	activate => sub { },	1538	activate => sub { },
1188	});	1539	});
1189	}	1540	}
1190		1541
1191	sub add_title {	1542	=item $popup->add_button ($text, $cb)
1192	my ($self, $title) = @_;
1193		1543
1194	$self->add_item ({	1544	Adds a clickable button to the popup. C<$cb> is called whenever it is
1195	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1545	selected.
1196	text => $title,	1546
1197	activate => sub { },	1547	=cut
1198	});
1199	}
1200		1548
1201	sub add_button {	1549	sub add_button {
1202	my ($self, $text, $cb) = @_;	1550	my ($self, $text, $cb) = @_;
1203		1551
1204	$self->add_item ({ type => "button", text => $text, activate => $cb});	1552	$self->add_item ({ type => "button", text => $text, activate => $cb});
1205	}	1553	}
		1554
		1555	=item $popup->add_toggle ($text, $cb, $initial_value)
		1556
		1557	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1558	whenever it gets toggled, with a boolean indicating its value as its first
		1559	argument.
		1560
		1561	=cut
1206		1562
1207	sub add_toggle {	1563	sub add_toggle {
1208	my ($self, $text, $cb, $value) = @_;	1564	my ($self, $text, $cb, $value) = @_;
1209		1565
1210	my $item; $item = {	1566	my $item; $item = {
1211	type => "button",	1567	type => "button",
1212	text => " $text",	1568	text => " $text",
1213	value => $value,	1569	value => $value,
1214	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1570	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1215	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1571	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1216	};	1572	};
1217		1573
1218	$self->add_item ($item);	1574	$self->add_item ($item);
1219	}	1575	}
		1576
		1577	=item $popup->show
		1578
		1579	Displays the popup (which is initially hidden).
		1580
		1581	=cut
1220		1582
1221	sub show {	1583	sub show {
1222	my ($self) = @_;	1584	my ($self) = @_;
1223		1585
1224	local $urxvt::popup::self = $self;	1586	local $urxvt::popup::self = $self;
1225		1587
		1588	my $env = $self->{term}->env;
		1589	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1590	delete $env->{LC_ALL};
1226	local $ENV{LC_ALL} = $self->{term}->locale;	1591	$env->{LC_CTYPE} = $self->{term}->locale;
1227		1592
		1593	urxvt::term->new ($env, $self->{term}->resource ("name"),
1228	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1594	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1229	"--transient-for" => $self->{term}->parent,	1595	"--transient-for" => $self->{term}->parent,
1230	"-display" => $self->{term}->display_id,	1596	"-display" => $self->{term}->display_id,
1231	"-pe" => "urxvt-popup")	1597	"-pe" => "urxvt-popup")
1232	or die "unable to create popup window\n";	1598	or die "unable to create popup window\n";
1233	}	1599	}
1234		1600
1235	sub DESTROY {	1601	sub DESTROY {
1236	my ($self) = @_;	1602	my ($self) = @_;
1237		1603
1238	delete $self->{term}{_destroy}{$self};	1604	delete $self->{term}{_destroy}{$self};
1239	$self->{term}->ungrab;	1605	$self->{term}->ungrab;
1240	}	1606	}
		1607
		1608	=back
1241		1609
1242	=head2 The C<urxvt::timer> Class	1610	=head2 The C<urxvt::timer> Class
1243		1611
1244	This class implements timer watchers/events. Time is represented as a	1612	This class implements timer watchers/events. Time is represented as a
1245	fractional number of seconds since the epoch. Example:	1613	fractional number of seconds since the epoch. Example:
…		…
1298		1666
1299	$term->{socket} = ...	1667	$term->{socket} = ...
1300	$term->{iow} = urxvt::iow	1668	$term->{iow} = urxvt::iow
1301	->new	1669	->new
1302	->fd (fileno $term->{socket})	1670	->fd (fileno $term->{socket})
1303	->events (1) # wait for read data	1671	->events (urxvt::EVENT_READ)
1304	->start	1672	->start
1305	->cb (sub {	1673	->cb (sub {
1306	my ($iow, $revents) = @_;	1674	my ($iow, $revents) = @_;
1307	# $revents must be 1 here, no need to check	1675	# $revents must be 1 here, no need to check
1308	sysread $term->{socket}, my $buf, 8192	1676	sysread $term->{socket}, my $buf, 8192
…		…
1325		1693
1326	Set the filedescriptor (not handle) to watch.	1694	Set the filedescriptor (not handle) to watch.
1327		1695
1328	=item $iow = $iow->events ($eventmask)	1696	=item $iow = $iow->events ($eventmask)
1329		1697
1330	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1698	Set the event mask to watch. The only allowed values are
1331	data, Bit #1 (value C<2>) enables watching for write data.	1699	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1700	together, or C<urxvt::EVENT_NONE>.
1332		1701
1333	=item $iow = $iow->start	1702	=item $iow = $iow->start
1334		1703
1335	Start watching for requested events on the given handle.	1704	Start watching for requested events on the given handle.
1336		1705
…		…
1351		1720
1352	=item == 0 - fatal messages	1721	=item == 0 - fatal messages
1353		1722
1354	=item >= 3 - script loading and management	1723	=item >= 3 - script loading and management
1355		1724
1356	=item >=10 - all events received	1725	=item >=10 - all called hooks
		1726
		1727	=item >=11 - hook reutrn values
1357		1728
1358	=back	1729	=back
1359		1730
1360	=head1 AUTHOR	1731	=head1 AUTHOR
1361		1732

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.66 by root, Mon Jan 9 19:28:39 2006 UTC vs. Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.66 by root, Mon Jan 9 19:28:39 2006 UTC vs.
Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC