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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.65 by root, Mon Jan 9 19:25:57 2006 UTC vs.
Revision 1.108 by root, Thu Jan 19 09:47:15 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+):?$/: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+)[,.]$/: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.
		168
		169	=item automove-background
		170
		171	This is basically a one-line extension that dynamically changes the background pixmap offset
		172	to the window position, in effect creating the same effect as pseudo transparency with
		173	a custom pixmap. No scaling is supported in this mode. Exmaple:
		174
		175	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
78		176
79	=item block-graphics-to-ascii	177	=item block-graphics-to-ascii
80		178
81	A not very useful example of filtering all text output to the terminal,	179	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	180	by replacing all line-drawing characters (U+2500 .. U+259F) by a
83	similar-looking ascii character.	181	similar-looking ascii character.
84		182
		183	=item digital-clock
		184
		185	Displays a digital clock using the built-in overlay.
		186
85	=item example-refresh-hooks	187	=item example-refresh-hooks
86		188
87	Displays a very simple digital clock in the upper right corner of the	189	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	190	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	191	overlays or changes.
90		192
		193	=item selection-pastebin
		194
		195	This is a little rarely useful extension that Uploads the selection as
		196	textfile to a remote site (or does other things). (The implementation is
		197	not currently secure for use in a multiuser environment as it writes to
		198	F</tmp> directly.).
		199
		200	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		201	i.e.
		202
		203	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		204
		205	Pressing this combination runs a command with C<%> replaced by the name of
		206	the textfile. This command can be set via a resource:
		207
		208	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		209
		210	And the default is likely not useful to anybody but the few people around
		211	here :)
		212
		213	The name of the textfile is the hex encoded md5 sum of the selection, so
		214	the same content should lead to the same filename.
		215
		216	After a successful upload the selection will be replaced by the text given
		217	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		218	for the filename):
		219
		220	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		221
91	=back	222	=back
		223
		224	=head1 API DOCUMENTATION
92		225
93	=head2 General API Considerations	226	=head2 General API Considerations
94		227
95	All objects (such as terminals, time watchers etc.) are typical	228	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	229	reference-to-hash objects. The hash can be used to store anything you
…		…
109	=over 4	242	=over 4
110		243
111	=item $text	244	=item $text
112		245
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	246	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.	247	always represents one screen cell. See L<ROW_t> for a discussion of this format.
115		248
116	=item $string	249	=item $string
117		250
118	A perl text string, with an emphasis on I<text>. It can store all unicode	251	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	252	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	257	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	258	locale-specific way.
126		259
127	=back	260	=back
128		261
		262	=head2 Extension Objects
		263
		264	Very perl extension is a perl class. A separate perl object is created
		265	for each terminal and each extension and passed as the first parameter to
		266	hooks. So extensions can use their C<$self> object without having to think
		267	about other extensions, with the exception of methods and members that
		268	begin with an underscore character C<_>: these are reserved for internal
		269	use.
		270
		271	Although it isn't a C<urxvt::term> object, you can call all methods of the
		272	C<urxvt::term> class on this object.
		273
		274	It has the following methods and data members:
		275
		276	=over 4
		277
		278	=item $urxvt_term = $self->{term}
		279
		280	Returns the C<urxvt::term> object associated with this instance of the
		281	extension. This member I<must not> be changed in any way.
		282
		283	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		284
		285	Dynamically enable the given hooks (named without the C<on_> prefix) for
		286	this extension, replacing any previous hook. This is useful when you want
		287	to overwrite time-critical hooks only temporarily.
		288
		289	=item $self->disable ($hook_name[, $hook_name..])
		290
		291	Dynamically disable the given hooks.
		292
		293	=back
		294
129	=head2 Hooks	295	=head2 Hooks
130		296
131	The following subroutines can be declared in extension files, and will be	297	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	298	called whenever the relevant event happens.
133		299
134	The first argument passed to them is an object private to each terminal	300	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	301	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		302
141	All of them must return a boolean value. If it is true, then the event	303	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,	304	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.	305	skipped, and the relevant action might not be carried out by the C++ code.
144		306
145	When in doubt, return a false value (preferably C<()>).	307	I<< When in doubt, return a false value (preferably C<()>). >>
146		308
147	=over 4	309	=over 4
148		310
149	=item on_init $term	311	=item on_init $term
150		312
…		…
163	=item on_start $term	325	=item on_start $term
164		326
165	Called at the very end of initialisation of a new terminal, just before	327	Called at the very end of initialisation of a new terminal, just before
166	returning to the mainloop.	328	returning to the mainloop.
167		329
		330	=item on_child_start $term, $pid
		331
		332	Called just after the child process has been C<fork>ed.
		333
		334	=item on_child_exit $term, $status
		335
		336	Called just after the child process has exited. C<$status> is the status
		337	from C<waitpid>.
		338
168	=item on_sel_make $term, $eventtime	339	=item on_sel_make $term, $eventtime
169		340
170	Called whenever a selection has been made by the user, but before the	341	Called whenever a selection has been made by the user, but before the
171	selection text is copied, so changes to the beginning, end or type of the	342	selection text is copied, so changes to the beginning, end or type of the
172	selection will be honored.	343	selection will be honored.
…		…
185	=item on_sel_extend $term	356	=item on_sel_extend $term
186		357
187	Called whenever the user tries to extend the selection (e.g. with a double	358	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	359	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	360	should extend the selection itelf and return true to suppress the built-in
190	processing.	361	processing. This can happen multiple times, as long as the callback
		362	returns true, it will be called on every further click by the user and is
		363	supposed to enlarge the selection more and more, if possible.
191		364
192	See the F<selection> example extension.	365	See the F<selection> example extension.
193		366
194	=item on_view_change $term, $offset	367	=item on_view_change $term, $offset
195		368
…		…
226	can filter/change and output the text yourself by returning a true value	399	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	400	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	401	might be very slow, however, as your hook is called for B<all> text being
229	output.	402	output.
230		403
		404	=item on_tt_write $term, $octets
		405
		406	Called whenever some data is written to the tty/pty and can be used to
		407	suppress or filter tty input.
		408
231	=item on_line_update $term, $row	409	=item on_line_update $term, $row
232		410
233	Called whenever a line was updated or changed. Can be used to filter	411	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	412	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,	413	that are being shown will be filtered, and, due to performance reasons,
…		…
257		435
258	Called whenever the user presses a key combination that has a	436	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>	437	C<perl:string> action bound to it (see description of the B<keysym>
260	resource in the @@RXVT_NAME@@(1) manpage).	438	resource in the @@RXVT_NAME@@(1) manpage).
261		439
		440	=item on_x_event $term, $event
		441
		442	Called on every X event received on the vt window (and possibly other
		443	windows). Should only be used as a last resort. Most event structure
		444	members are not passed.
		445
262	=item on_focus_in $term	446	=item on_focus_in $term
263		447
264	Called whenever the window gets the keyboard focus, before rxvt-unicode	448	Called whenever the window gets the keyboard focus, before rxvt-unicode
265	does focus in processing.	449	does focus in processing.
266		450
267	=item on_focus_out $term	451	=item on_focus_out $term
268		452
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	453	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	454	focus out processing.
271		455
		456	=item on_configure_notify $term, $event
		457
272	=item on_key_press $term, $event, $octets	458	=item on_key_press $term, $event, $keysym, $octets
273		459
274	=item on_key_release $term, $event	460	=item on_key_release $term, $event, $keysym
275		461
276	=item on_button_press $term, $event	462	=item on_button_press $term, $event
277		463
278	=item on_button_release $term, $event	464	=item on_button_release $term, $event
279		465
…		…
295		481
296	subwindow.	482	subwindow.
297		483
298	=back	484	=back
299		485
		486	=cut
		487
		488	package urxvt;
		489
		490	use utf8;
		491	use strict;
		492	use Carp ();
		493	use Scalar::Util ();
		494	use List::Util ();
		495
		496	our $VERSION = 1;
		497	our $TERM;
		498	our @HOOKNAME;
		499	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		500	our %OPTION;
		501
		502	our $LIBDIR;
		503	our $RESNAME;
		504	our $RESCLASS;
		505	our $RXVTNAME;
		506
300	=head2 Variables in the C<urxvt> Package	507	=head2 Variables in the C<urxvt> Package
301		508
302	=over 4	509	=over 4
		510
		511	=item $urxvt::LIBDIR
		512
		513	The rxvt-unicode library directory, where, among other things, the perl
		514	modules and scripts are stored.
		515
		516	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		517
		518	The resource class and name rxvt-unicode uses to look up X resources.
		519
		520	=item $urxvt::RXVTNAME
		521
		522	The basename of the installed binaries, usually C<urxvt>.
303		523
304	=item $urxvt::TERM	524	=item $urxvt::TERM
305		525
306	The current terminal. This variable stores the current C<urxvt::term>	526	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	527	object, whenever a callback/hook is executing.
…		…
309	=back	529	=back
310		530
311	=head2 Functions in the C<urxvt> Package	531	=head2 Functions in the C<urxvt> Package
312		532
313	=over 4	533	=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		534
323	=item urxvt::fatal $errormessage	535	=item urxvt::fatal $errormessage
324		536
325	Fatally aborts execution with the given error message. Avoid at all	537	Fatally aborts execution with the given error message. Avoid at all
326	costs! The only time this is acceptable is when the terminal process	538	costs! The only time this is acceptable is when the terminal process
…		…
333	that calls this function.	545	that calls this function.
334		546
335	Using this function has the advantage that its output ends up in the	547	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.	548	correct place, e.g. on stderr of the connecting urxvtc client.
337		549
338	=item $is_safe = urxvt::safe	550	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		551
344	=item $time = urxvt::NOW	552	=item $time = urxvt::NOW
345		553
346	Returns the "current time" (as per the event loop).	554	Returns the "current time" (as per the event loop).
347		555
348	=item urxvt::CurrentTime	556	=item urxvt::CurrentTime
349		557
350	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	558	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
351	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	559	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
352	Button4Mask, Button5Mask, AnyModifier	560	Button4Mask, Button5Mask, AnyModifier
		561
		562	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		563	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		564	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		565	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		566	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		567	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		568	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		569
		570	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		571	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		572	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		573	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		574	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		575	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		576	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
353		577
354	Various constants for use in X calls and event processing.	578	Various constants for use in X calls and event processing.
355		579
356	=back	580	=back
357		581
…		…
386		610
387	=item $background = urxvt::GET_BASEBG $rend	611	=item $background = urxvt::GET_BASEBG $rend
388		612
389	Return the foreground/background colour index, respectively.	613	Return the foreground/background colour index, respectively.
390		614
391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	615	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392		616
393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	617	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
394		618
395	Replace the foreground/background colour in the rendition mask with the	619	Replace the foreground/background colour in the rendition mask with the
396	specified one.	620	specified one.
397		621
398	=item $value = urxvt::GET_CUSTOM ($rend)	622	=item $value = urxvt::GET_CUSTOM $rend
399		623
400	Return the "custom" value: Every rendition has 5 bits for use by	624	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	625	extensions. They can be set and changed as you like and are initially
402	zero.	626	zero.
403		627
404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	628	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405		629
406	Change the custom value.	630	Change the custom value.
407		631
408	=back	632	=back
409		633
410	=cut	634	=cut
411		635
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 {	636	BEGIN {
426	urxvt->bootstrap;
427
428	# overwrite perl's warn	637	# overwrite perl's warn
429	*CORE::GLOBAL::warn = sub {	638	*CORE::GLOBAL::warn = sub {
430	my $msg = join "", @_;	639	my $msg = join "", @_;
431	$msg .= "\n"	640	$msg .= "\n"
432	unless $msg =~ /\n$/;	641	unless $msg =~ /\n$/;
433	urxvt::warn ($msg);	642	urxvt::warn ($msg);
434	};	643	};
435
436	delete $ENV{IFS};
437	delete $ENV{CDPATH};
438	delete $ENV{BASH_ENV};
439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
440	}	644	}
441		645
442	my @hook_count;
443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	646	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
444		647
445	sub verbose {	648	sub verbose {
446	my ($level, $msg) = @_;	649	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	650	warn "$msg\n" if $level <= $verbosity;
448	}	651	}
449		652
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;	653	my %extension_pkg;
469		654
470	# load a single script into its own package, once only	655	# load a single script into its own package, once only
471	sub extension_package($) {	656	sub extension_package($) {
472	my ($path) = @_;	657	my ($path) = @_;
473		658
		659	no strict 'refs';
		660
474	$extension_pkg{$path} \|\|= do {	661	$extension_pkg{$path} \|\|= do {
475	my $pkg = "urxvt::" . ($extension_pkg++);	662	$path =~ /([^\/\\]+)$/;
		663	my $pkg = $1;
		664	$pkg =~ s/[^[:word:]]/_/g;
		665	$pkg = "urxvt::ext::$pkg";
476		666
477	verbose 3, "loading extension '$path' into package '$pkg'";	667	verbose 3, "loading extension '$path' into package '$pkg'";
478		668
479	open my $fh, "<:raw", $path	669	open my $fh, "<:raw", $path
480	or die "$path: $!";	670	or die "$path: $!";
481		671
		672	@{"$pkg\::ISA"} = urxvt::term::extension::;
		673
		674	my $source =
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	675	"package $pkg; use strict; use utf8;\n"
483	. "use base urxvt::term::proxy::;\n"
484	. "#line 1 \"$path\"\n{\n"	676	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	677	. (do { local $/; <$fh> })
486	. "\n};\n1";	678	. "\n};\n1";
487		679
		680	eval $source
488	eval $source or die "$path: $@";	681	or die "$path: $@";
489		682
490	$pkg	683	$pkg
491	}	684	}
492	}	685	}
493		686
…		…
499	my $htype = shift;	692	my $htype = shift;
500		693
501	if ($htype == 0) { # INIT	694	if ($htype == 0) { # INIT
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	695	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503		696
504	my %want_ext;	697	my %ext_arg;
505		698
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	699	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507	if ($_ eq "default") {	700	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	701	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
509	} elsif (/^-(.*)$/) {	702	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	703	delete $ext_arg{$1};
		704	} elsif (/^([^<]+)<(.*)>$/) {
		705	push @{ $ext_arg{$1} }, $2;
511	} else {	706	} else {
512	$want_ext{$_}++;	707	$ext_arg{$_} \|\|= [];
513	}	708	}
514	}	709	}
515		710
516	for my $ext (keys %want_ext) {	711	while (my ($ext, $argv) = each %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	712	my @files = grep -f $_, map "$_/$ext", @dirs;
518		713
519	if (@files) {	714	if (@files) {
520	register_package extension_package $files[0];	715	$TERM->register_package (extension_package $files[0], $argv);
521	} else {	716	} else {
522	warn "perl extension '$ext' not found in perl library search path\n";	717	warn "perl extension '$ext' not found in perl library search path\n";
523	}	718	}
524	}	719	}
525		720
…		…
534	if $verbosity >= 10;	729	if $verbosity >= 10;
535		730
536	keys %$cb;	731	keys %$cb;
537		732
538	while (my ($pkg, $cb) = each %$cb) {	733	while (my ($pkg, $cb) = each %$cb) {
539	eval {	734	$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;	735	and last;
548	};	736
549	if ($@) {	737	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	738	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	739	warn $@;
552	}	740	}
553	}	741	}
		742
		743	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		744	if $verbosity >= 11;
554	}	745	}
555		746
556	if ($htype == 1) { # DESTROY	747	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	748	# clear package objects
566	%$_ = () for values %{ $TERM->{_pkg} };	749	%$_ = () for values %{ $TERM->{_pkg} };
567		750
568	# clear package	751	# clear package
569	%$TERM = ();	752	%$TERM = ();
570	}	753	}
571		754
572	$retval	755	$retval
573	}	756	}
574		757
575	# urxvt::term::proxy	758	# urxvt::term::extension
576		759
577	sub urxvt::term::proxy::AUTOLOAD {	760	package urxvt::term::extension;
578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	761
		762	sub enable {
		763	my ($self, %hook) = @_;
		764	my $pkg = $self->{_pkg};
		765
		766	while (my ($name, $cb) = each %hook) {
		767	my $htype = $HOOKTYPE{uc $name};
		768	defined $htype
		769	or Carp::croak "unsupported hook type '$name'";
		770
		771	$self->set_should_invoke ($htype, +1)
		772	unless exists $self->{term}{_hook}[$htype]{$pkg};
		773
		774	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		775	}
		776	}
		777
		778	sub disable {
		779	my ($self, @hook) = @_;
		780	my $pkg = $self->{_pkg};
		781
		782	for my $name (@hook) {
		783	my $htype = $HOOKTYPE{uc $name};
		784	defined $htype
		785	or Carp::croak "unsupported hook type '$name'";
		786
		787	$self->set_should_invoke ($htype, -1)
		788	if delete $self->{term}{_hook}[$htype]{$pkg};
		789	}
		790	}
		791
		792	our $AUTOLOAD;
		793
		794	sub AUTOLOAD {
		795	$AUTOLOAD =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	796	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		797
581	eval qq{	798	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	799	sub $AUTOLOAD {
583	my \$proxy = shift;	800	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	801	\$proxy->{term}->$1 (\@_)
585	}	802	}
586	1	803	1
587	} or die "FATAL: unable to compile method forwarder: $@";	804	} or die "FATAL: unable to compile method forwarder: $@";
588		805
589	goto &$urxvt::term::proxy::AUTOLOAD;	806	goto &$AUTOLOAD;
590	}	807	}
591		808
592	sub urxvt::term::proxy::DESTROY {	809	sub DESTROY {
593	# nop	810	# nop
594	}	811	}
595		812
596	# urxvt::destroy_hook	813	# urxvt::destroy_hook
597		814
…		…
607		824
608	=head2 The C<urxvt::anyevent> Class	825	=head2 The C<urxvt::anyevent> Class
609		826
610	The sole purpose of this class is to deliver an interface to the	827	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	828	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	829	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	830	condition variables, but non-blocking condvar use is ok. What this means
614	cannot use blocking APIs, but the non-blocking variant should work.	831	is that you cannot use blocking APIs, but the non-blocking variant should
		832	work.
615		833
616	=cut	834	=cut
617		835
618	our $VERSION = 1;	836	our $VERSION = 1;
619		837
…		…
664	${$_[0]}++;	882	${$_[0]}++;
665	}	883	}
666		884
667	sub urxvt::anyevent::condvar::wait {	885	sub urxvt::anyevent::condvar::wait {
668	unless (${$_[0]}) {	886	unless (${$_[0]}) {
669	require Carp;
670	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	887	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
671	}	888	}
672	}	889	}
673		890
674	package urxvt::term;	891	package urxvt::term;
675		892
676	=head2 The C<urxvt::term> Class	893	=head2 The C<urxvt::term> Class
677		894
678	=over 4	895	=over 4
679		896
		897	=cut
		898
		899	# find on_xxx subs in the package and register them
		900	# as hooks
		901	sub register_package {
		902	my ($self, $pkg, $argv) = @_;
		903
		904	my $proxy = bless {
		905	_pkg => $pkg,
		906	argv => $argv,
		907	}, $pkg;
		908	Scalar::Util::weaken ($proxy->{term} = $self);
		909
		910	$self->{_pkg}{$pkg} = $proxy;
		911
		912	for my $name (@HOOKNAME) {
		913	if (my $ref = $pkg->can ("on_" . lc $name)) {
		914	$proxy->enable ($name => $ref);
		915	}
		916	}
		917	}
		918
		919	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		920
		921	Creates a new terminal, very similar as if you had started it with system
		922	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		923	hash which defines the environment of the new terminal.
		924
		925	Croaks (and probably outputs an error message) if the new instance
		926	couldn't be created. Returns C<undef> if the new instance didn't
		927	initialise perl, and the terminal object otherwise. The C<init> and
		928	C<start> hooks will be called during this call.
		929
		930	=cut
		931
		932	sub new {
		933	my ($class, $env, @args) = @_;
		934
		935	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		936	}
		937
680	=item $term->destroy	938	=item $term->destroy
681		939
682	Destroy the terminal object (close the window, free resources etc.).	940	Destroy the terminal object (close the window, free resources
		941	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		942	watchers (timers, io watchers) are still active.
		943
		944	=item $term->exec_async ($cmd[, @args])
		945
		946	Works like the combination of the C<fork>/C<exec> builtins, which executes
		947	("starts") programs in the background. This function takes care of setting
		948	the user environment before exec'ing the command (e.g. C<PATH>) and should
		949	be preferred over explicit calls to C<exec> or C<system>.
		950
		951	Returns the pid of the subprocess or C<undef> on error.
		952
		953	=cut
		954
		955	sub exec_async {
		956	my $self = shift;
		957
		958	my $pid = fork;
		959
		960	return $pid
		961	if !defined $pid or $pid;
		962
		963	%ENV = %{ $self->env };
		964
		965	exec @_;
		966	urxvt::_exit 255;
		967	}
683		968
684	=item $isset = $term->option ($optval[, $set])	969	=item $isset = $term->option ($optval[, $set])
685		970
686	Returns true if the option specified by C<$optval> is enabled, and	971	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	972	optionally change it. All option values are stored by name in the hash
…		…
690	Here is a a likely non-exhaustive list of option names, please see the	975	Here is a a likely non-exhaustive list of option names, please see the
691	source file F</src/optinc.h> to see the actual list:	976	source file F</src/optinc.h> to see the actual list:
692		977
693	borderLess console cursorBlink cursorUnderline hold iconic insecure	978	borderLess console cursorBlink cursorUnderline hold iconic insecure
694	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	979	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
695	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	980	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
696	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	981	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
697	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	982	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
698	tripleclickwords utmpInhibit visualBell	983	transparent tripleclickwords utmpInhibit visualBell
699		984
700	=item $value = $term->resource ($name[, $newval])	985	=item $value = $term->resource ($name[, $newval])
701		986
702	Returns the current resource value associated with a given name and	987	Returns the current resource value associated with a given name and
703	optionally sets a new value. Setting values is most useful in the C<init>	988	optionally sets a new value. Setting values is most useful in the C<init>
…		…
720		1005
721	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1006	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
722	borderLess color cursorBlink cursorUnderline cutchars delete_key	1007	borderLess color cursorBlink cursorUnderline cutchars delete_key
723	display_name embed ext_bwidth fade font geometry hold iconName	1008	display_name embed ext_bwidth fade font geometry hold iconName
724	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1009	imFont imLocale inputMethod insecure int_bwidth intensityStyles
725	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1010	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
726	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1011	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
727	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1012	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
728	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1013	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
729	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1014	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
730	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1015	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
731	shade term_name title transparent transparent_all tripleclickwords	1016	secondaryScreen secondaryScroll selectstyle shade term_name title
732	utmpInhibit visualBell	1017	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1018	visualBell
733		1019
734	=cut	1020	=cut
735		1021
736	sub resource($$;$) {	1022	sub resource($$;$) {
737	my ($self, $name) = (shift, shift);	1023	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1024	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	1025	&urxvt::term::_resource
740	}	1026	}
741		1027
		1028	=item $value = $term->x_resource ($pattern)
		1029
		1030	Returns the X-Resource for the given pattern, excluding the program or
		1031	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1032	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1033	resource with that pattern exists.
		1034
		1035	This method should only be called during the C<on_start> hook, as there is
		1036	only one resource database per display, and later invocations might return
		1037	the wrong resources.
		1038
		1039	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1040
		1041	Adds a keymap translation exactly as specified via a resource. See the
		1042	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1043
742	=item $rend = $term->rstyle ([$new_rstyle])	1044	=item $rend = $term->rstyle ([$new_rstyle])
743		1045
744	Return and optionally change the current rendition. Text that is output by	1046	Return and optionally change the current rendition. Text that is output by
745	the terminal application will use this style.	1047	the terminal application will use this style.
746		1048
…		…
756	=item ($row, $col) = $term->selection_end ([$row, $col])	1058	=item ($row, $col) = $term->selection_end ([$row, $col])
757		1059
758	Return the current values of the selection mark, begin or end positions,	1060	Return the current values of the selection mark, begin or end positions,
759	and optionally set them to new values.	1061	and optionally set them to new values.
760		1062
		1063	=item $term->selection_make ($eventtime[, $rectangular])
		1064
		1065	Tries to make a selection as set by C<selection_beg> and
		1066	C<selection_end>. If C<$rectangular> is true (default: false), a
		1067	rectangular selection will be made. This is the prefered function to make
		1068	a selection.
		1069
761	=item $success = $term->selection_grab ($eventtime)	1070	=item $success = $term->selection_grab ($eventtime)
762		1071
763	Try to request the primary selection from the server (for example, as set	1072	Try to request the primary selection text from the server (for example, as
764	by the next method).	1073	set by the next method). No visual feedback will be given. This function
		1074	is mostly useful from within C<on_sel_grab> hooks.
765		1075
766	=item $oldtext = $term->selection ([$newtext])	1076	=item $oldtext = $term->selection ([$newtext])
767		1077
768	Return the current selection text and optionally replace it by C<$newtext>.	1078	Return the current selection text and optionally replace it by C<$newtext>.
769		1079
770	#=item $term->overlay ($x, $y, $text)	1080	=item $term->overlay_simple ($x, $y, $text)
771	#	1081
772	#Create a simple multi-line overlay box. See the next method for details.	1082	Create a simple multi-line overlay box. See the next method for details.
773	#	1083
774	#=cut	1084	=cut
775	#	1085
776	#sub urxvt::term::scr_overlay {	1086	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	1087	my ($self, $x, $y, $text) = @_;
778	#	1088
779	# my @lines = split /\n/, $text;	1089	my @lines = split /\n/, $text;
780	#	1090
781	# my $w = 0;	1091	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	1092
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1093	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1094	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	1095
		1096	$overlay
		1097	}
789		1098
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1099	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		1100
792	Create a new (empty) overlay at the given position with the given	1101	Create a new (empty) overlay at the given position with the given
793	width/height. C<$rstyle> defines the initial rendition style	1102	width/height. C<$rstyle> defines the initial rendition style
…		…
860		1169
861	=item $string = $term->locale_decode ($octets)	1170	=item $string = $term->locale_decode ($octets)
862		1171
863	Convert the given locale-encoded octets into a perl string.	1172	Convert the given locale-encoded octets into a perl string.
864		1173
		1174	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1175
		1176	XORs the rendition values in the given span with the provided value
		1177	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1178	refresh hooks to provide effects similar to the selection.
		1179
		1180	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1181
		1182	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1183	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1184	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1185	it instead. Both styles I<MUST NOT> contain font styles.
		1186
		1187	=item $term->scr_bell
		1188
		1189	Ring the bell!
		1190
865	=item $term->scr_add_lines ($string)	1191	=item $term->scr_add_lines ($string)
866		1192
867	Write the given text string to the screen, as if output by the application	1193	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	1194	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	1195	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
883		1209
884	Write the octets given in C<$data> to the tty (i.e. as program input). To	1210	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	1211	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	1212	to the locale-specific encoding using C<< $term->locale_encode >>.
887		1213
		1214	=item $old_events = $term->pty_ev_events ([$new_events])
		1215
		1216	Replaces the event mask of the pty watcher by the given event mask. Can
		1217	be used to suppress input and output handling to the pty/tty. See the
		1218	description of C<< urxvt::timer->events >>. Make sure to always restore
		1219	the previous value.
		1220
888	=item $windowid = $term->parent	1221	=item $windowid = $term->parent
889		1222
890	Return the window id of the toplevel window.	1223	Return the window id of the toplevel window.
891		1224
892	=item $windowid = $term->vt	1225	=item $windowid = $term->vt
893		1226
894	Return the window id of the terminal window.	1227	Return the window id of the terminal window.
895		1228
		1229	=item $term->vt_emask_add ($x_event_mask)
		1230
		1231	Adds the specified events to the vt event mask. Useful e.g. when you want
		1232	to receive pointer events all the times:
		1233
		1234	$term->vt_emask_add (urxvt::PointerMotionMask);
		1235
896	=item $window_width = $term->width	1236	=item $window_width = $term->width
897		1237
898	=item $window_height = $term->height	1238	=item $window_height = $term->height
899		1239
900	=item $font_width = $term->fwidth	1240	=item $font_width = $term->fwidth
…		…
913		1253
914	=item $max_scrollback = $term->saveLines	1254	=item $max_scrollback = $term->saveLines
915		1255
916	=item $nrow_plus_saveLines = $term->total_rows	1256	=item $nrow_plus_saveLines = $term->total_rows
917		1257
918	=item $lines_in_scrollback = $term->nsaved	1258	=item $topmost_scrollback_row = $term->top_row
919		1259
920	Return various integers describing terminal characteristics.	1260	Return various integers describing terminal characteristics.
		1261
		1262	=item $x_display = $term->display_id
		1263
		1264	Return the DISPLAY used by rxvt-unicode.
		1265
		1266	=item $lc_ctype = $term->locale
		1267
		1268	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1269
		1270	=item $env = $term->env
		1271
		1272	Returns a copy of the environment in effect for the terminal as a hashref
		1273	similar to C<\%ENV>.
		1274
		1275	=cut
		1276
		1277	sub env {
		1278	if (my $env = $_[0]->_env) {
		1279	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1280	} else {
		1281	+{ %ENV }
		1282	}
		1283	}
921		1284
922	=item $modifiermask = $term->ModLevel3Mask	1285	=item $modifiermask = $term->ModLevel3Mask
923		1286
924	=item $modifiermask = $term->ModMetaMask	1287	=item $modifiermask = $term->ModMetaMask
925		1288
…		…
928	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1291	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.	1292	AltGr), the meta key (often Alt) and the num lock key, if applicable.
930		1293
931	=item $view_start = $term->view_start ([$newvalue])	1294	=item $view_start = $term->view_start ([$newvalue])
932		1295
933	Returns the negative row number of the topmost line. Minimum value is	1296	Returns the row number of the topmost displayed line. Maximum value is
934	C<0>, which displays the normal terminal contents. Larger values scroll	1297	C<0>, which displays the normal terminal contents. Lower values scroll
935	this many lines into the scrollback buffer.	1298	this many lines into the scrollback buffer.
936		1299
937	=item $term->want_refresh	1300	=item $term->want_refresh
938		1301
939	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1302	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.	1381	Return the row number of the first/last row of the line, respectively.
1019		1382
1020	=item $offset = $line->offset_of ($row, $col)	1383	=item $offset = $line->offset_of ($row, $col)
1021		1384
1022	Returns the character offset of the given row\|col pair within the logical	1385	Returns the character offset of the given row\|col pair within the logical
1023	line.	1386	line. Works for rows outside the line, too, and returns corresponding
		1387	offsets outside the string.
1024		1388
1025	=item ($row, $col) = $line->coord_of ($offset)	1389	=item ($row, $col) = $line->coord_of ($offset)
1026		1390
1027	Translates a string offset into terminal coordinates again.	1391	Translates a string offset into terminal coordinates again.
1028		1392
…		…
1165	$item->{render} \|\|= sub { $_[0]{text} };	1529	$item->{render} \|\|= sub { $_[0]{text} };
1166		1530
1167	push @{ $self->{item} }, $item;	1531	push @{ $self->{item} }, $item;
1168	}	1532	}
1169		1533
		1534	=item $popup->add_title ($title)
		1535
		1536	Adds a non-clickable title to the popup.
		1537
		1538	=cut
		1539
		1540	sub add_title {
		1541	my ($self, $title) = @_;
		1542
		1543	$self->add_item ({
		1544	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1545	text => $title,
		1546	activate => sub { },
		1547	});
		1548	}
		1549
		1550	=item $popup->add_separator ([$sepchr])
		1551
		1552	Creates a separator, optionally using the character given as C<$sepchr>.
		1553
		1554	=cut
		1555
1170	sub add_separator {	1556	sub add_separator {
1171	my ($self, $sep) = @_;	1557	my ($self, $sep) = @_;
1172		1558
1173	$sep \|\|= "═";	1559	$sep \|\|= "=";
1174		1560
1175	$self->add_item ({	1561	$self->add_item ({
1176	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },	1562	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1177	text => "",	1563	text => "",
1178	render => sub { $sep x $self->{term}->ncol },	1564	render => sub { $sep x $self->{term}->ncol },
1179	activate => sub { },	1565	activate => sub { },
1180	});	1566	});
1181	}	1567	}
1182		1568
1183	sub add_title {	1569	=item $popup->add_button ($text, $cb)
1184	my ($self, $title) = @_;
1185		1570
1186	$self->add_item ({	1571	Adds a clickable button to the popup. C<$cb> is called whenever it is
1187	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1572	selected.
1188	text => $title,	1573
1189	activate => sub { },	1574	=cut
1190	});
1191	}
1192		1575
1193	sub add_button {	1576	sub add_button {
1194	my ($self, $text, $cb) = @_;	1577	my ($self, $text, $cb) = @_;
1195		1578
1196	$self->add_item ({ type => "button", text => $text, activate => $cb});	1579	$self->add_item ({ type => "button", text => $text, activate => $cb});
1197	}	1580	}
		1581
		1582	=item $popup->add_toggle ($text, $cb, $initial_value)
		1583
		1584	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1585	whenever it gets toggled, with a boolean indicating its value as its first
		1586	argument.
		1587
		1588	=cut
1198		1589
1199	sub add_toggle {	1590	sub add_toggle {
1200	my ($self, $text, $cb, $value) = @_;	1591	my ($self, $text, $cb, $value) = @_;
1201		1592
1202	my $item; $item = {	1593	my $item; $item = {
1203	type => "button",	1594	type => "button",
1204	text => " $text",	1595	text => " $text",
1205	value => $value,	1596	value => $value,
1206	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1597	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1207	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1598	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1208	};	1599	};
1209		1600
1210	$self->add_item ($item);	1601	$self->add_item ($item);
1211	}	1602	}
		1603
		1604	=item $popup->show
		1605
		1606	Displays the popup (which is initially hidden).
		1607
		1608	=cut
1212		1609
1213	sub show {	1610	sub show {
1214	my ($self) = @_;	1611	my ($self) = @_;
1215		1612
1216	local $urxvt::popup::self = $self;	1613	local $urxvt::popup::self = $self;
1217		1614
		1615	my $env = $self->{term}->env;
		1616	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1617	delete $env->{LC_ALL};
1218	local $ENV{LC_ALL} = $self->{term}->locale;	1618	$env->{LC_CTYPE} = $self->{term}->locale;
1219		1619
1220	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1620	urxvt::term->new ($env, "popup",
		1621	"--perl-lib" => "", "--perl-ext-common" => "",
		1622	"-pty-fd" => -1, "-sl" => 0,
		1623	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1221	"--transient-for" => $self->{term}->parent,	1624	"--transient-for" => $self->{term}->parent,
1222	"-display" => $self->{term}->display_id,	1625	"-display" => $self->{term}->display_id,
1223	"-pe" => "urxvt-popup")	1626	"-pe" => "urxvt-popup")
1224	or die "unable to create popup window\n";	1627	or die "unable to create popup window\n";
1225	}	1628	}
1226		1629
1227	sub DESTROY {	1630	sub DESTROY {
1228	my ($self) = @_;	1631	my ($self) = @_;
1229		1632
1230	delete $self->{term}{_destroy}{$self};	1633	delete $self->{term}{_destroy}{$self};
1231	$self->{term}->ungrab;	1634	$self->{term}->ungrab;
1232	}	1635	}
		1636
		1637	=back
1233		1638
1234	=head2 The C<urxvt::timer> Class	1639	=head2 The C<urxvt::timer> Class
1235		1640
1236	This class implements timer watchers/events. Time is represented as a	1641	This class implements timer watchers/events. Time is represented as a
1237	fractional number of seconds since the epoch. Example:	1642	fractional number of seconds since the epoch. Example:
…		…
1276		1681
1277	=item $timer = $timer->start ($tstamp)	1682	=item $timer = $timer->start ($tstamp)
1278		1683
1279	Set the event trigger time to C<$tstamp> and start the timer.	1684	Set the event trigger time to C<$tstamp> and start the timer.
1280		1685
		1686	=item $timer = $timer->after ($delay)
		1687
		1688	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1689
1281	=item $timer = $timer->stop	1690	=item $timer = $timer->stop
1282		1691
1283	Stop the timer.	1692	Stop the timer.
1284		1693
1285	=back	1694	=back
…		…
1290		1699
1291	$term->{socket} = ...	1700	$term->{socket} = ...
1292	$term->{iow} = urxvt::iow	1701	$term->{iow} = urxvt::iow
1293	->new	1702	->new
1294	->fd (fileno $term->{socket})	1703	->fd (fileno $term->{socket})
1295	->events (1) # wait for read data	1704	->events (urxvt::EVENT_READ)
1296	->start	1705	->start
1297	->cb (sub {	1706	->cb (sub {
1298	my ($iow, $revents) = @_;	1707	my ($iow, $revents) = @_;
1299	# $revents must be 1 here, no need to check	1708	# $revents must be 1 here, no need to check
1300	sysread $term->{socket}, my $buf, 8192	1709	sysread $term->{socket}, my $buf, 8192
…		…
1317		1726
1318	Set the filedescriptor (not handle) to watch.	1727	Set the filedescriptor (not handle) to watch.
1319		1728
1320	=item $iow = $iow->events ($eventmask)	1729	=item $iow = $iow->events ($eventmask)
1321		1730
1322	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1731	Set the event mask to watch. The only allowed values are
1323	data, Bit #1 (value C<2>) enables watching for write data.	1732	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1733	together, or C<urxvt::EVENT_NONE>.
1324		1734
1325	=item $iow = $iow->start	1735	=item $iow = $iow->start
1326		1736
1327	Start watching for requested events on the given handle.	1737	Start watching for requested events on the given handle.
1328		1738
…		…
1343		1753
1344	=item == 0 - fatal messages	1754	=item == 0 - fatal messages
1345		1755
1346	=item >= 3 - script loading and management	1756	=item >= 3 - script loading and management
1347		1757
1348	=item >=10 - all events received	1758	=item >=10 - all called hooks
		1759
		1760	=item >=11 - hook reutrn values
1349		1761
1350	=back	1762	=back
1351		1763
1352	=head1 AUTHOR	1764	=head1 AUTHOR
1353		1765

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.65 by root, Mon Jan 9 19:25:57 2006 UTC vs. Revision 1.108 by root, Thu Jan 19 09:47:15 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.65 by root, Mon Jan 9 19:25:57 2006 UTC vs.
Revision 1.108 by root, Thu Jan 19 09:47:15 2006 UTC