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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC vs. Revision 1.111 by root, Thu Jan 19 19:52:54 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC vs.
Revision 1.111 by root, Thu Jan 19 19:52:54 2006 UTC