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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.58 by root, Sun Jan 8 22:58:13 2006 UTC vs.
Revision 1.108 by root, Thu Jan 19 09:47:15 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.58 by root, Sun Jan 8 22:58:13 2006 UTC vs. Revision 1.108 by root, Thu Jan 19 09:47:15 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.58 by root, Sun Jan 8 22:58:13 2006 UTC vs.
Revision 1.108 by root, Thu Jan 19 09:47:15 2006 UTC