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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC vs. Revision 1.110 by root, Thu Jan 19 16:22:13 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.110 by root, Thu Jan 19 16:22:13 2006 UTC