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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.64 by root, Mon Jan 9 06:29:47 2006 UTC vs. Revision 1.109 by root, Thu Jan 19 16:07:09 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.64 by root, Mon Jan 9 06:29:47 2006 UTC vs.
Revision 1.109 by root, Thu Jan 19 16:07:09 2006 UTC