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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.48 by root, Sat Jan 7 21:43:17 2006 UTC vs.
Revision 1.99 by root, Tue Jan 17 17:09:26 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	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
…		…
56		78
57	URxvt.keysym.C-M-r: perl:selection:rot13	79	URxvt.keysym.C-M-r: perl:selection:rot13
58		80
59	=back	81	=back
60		82
61	=item digital-clock	83	=item option-popup (enabled by default)
62		84
63	Displays a digital clock using the built-in overlay.	85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		86	runtime.
		87
		88	=item selection-popup (enabled by default)
		89
		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	=item searchable-scrollback<hotkey> (enabled by default)
		95
		96	Adds regex search functionality to the scrollback buffer, triggered
		97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		98	input/output is suspended and a regex is displayed at the bottom of the
		99	screen.
		100
		101	Inputting characters appends them to the regex and continues incremental
		102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		104	bottom. C<Escape> leaves search mode and returns to the point where search
		105	was started, while C<Enter> or C<Return> stay at the current position and
		106	additionally stores the first match in the current line into the primary
		107	selection.
		108
		109	=item selection-autotransform
		110
		111	This selection allows you to do automatic transforms on a selection
		112	whenever a selection is made.
		113
		114	It works by specifying perl snippets (most useful is a single C<s///>
		115	operator) that modify C<$_> as resources:
		116
		117	URxvt.selection-autotransform.0: transform
		118	URxvt.selection-autotransform.1: transform
		119	...
		120
		121	For example, the following will transform selections of the form
		122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		123	$word>:
		124
		125	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		126
		127	And this example matches the same,but replaces it with vi-commands you can
		128	paste directly into your (vi :) editor:
		129
		130	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		131
		132	Of course, this can be modified to suit your needs and your editor :)
		133
		134	To expand the example above to typical perl error messages ("XXX at
		135	FILENAME line YYY."), you need a slightly more elaborate solution:
		136
		137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		139
		140	The first line tells the selection code to treat the unchanging part of
		141	every error message as a selection pattern, and the second line transforms
		142	the message into vi commands to load the file.
64		143
65	=item mark-urls	144	=item mark-urls
66		145
67	Uses per-line display filtering (C<on_line_update>) to underline urls.	146	Uses per-line display filtering (C<on_line_update>) to underline urls and
		147	make them clickable. When middle-clicked, the program specified in the
		148	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		149	the URL as first argument.
68		150
69	=item block-graphics-to-ascii	151	=item block-graphics-to-ascii
70		152
71	A not very useful example of filtering all text output to the terminal,	153	A not very useful example of filtering all text output to the terminal,
72	by replacing all line-drawing characters (U+2500 .. U+259F) by a	154	by replacing all line-drawing characters (U+2500 .. U+259F) by a
73	similar-looking ascii character.	155	similar-looking ascii character.
74		156
		157	=item digital-clock
		158
		159	Displays a digital clock using the built-in overlay.
		160
75	=item example-refresh-hooks	161	=item example-refresh-hooks
76		162
77	Displays a very simple digital clock in the upper right corner of the	163	Displays a very simple digital clock in the upper right corner of the
78	window. Illustrates overwriting the refresh callbacks to create your own	164	window. Illustrates overwriting the refresh callbacks to create your own
79	overlays or changes.	165	overlays or changes.
80		166
		167	=item selection-pastebin
		168
		169	This is a little rarely useful extension that Uploads the selection as
		170	textfile to a remote site (or does other things). (The implementation is
		171	not currently secure for use in a multiuser environment as it writes to
		172	F</tmp> directly.).
		173
		174	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		175	i.e.
		176
		177	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		178
		179	Pressing this combination runs a command with C<%> replaced by the name of
		180	the textfile. This command can be set via a resource:
		181
		182	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		183
		184	And the default is likely not useful to anybody but the few people around
		185	here :)
		186
		187	The name of the textfile is the hex encoded md5 sum of the selection, so
		188	the same content should lead to the same filename.
		189
		190	After a successful upload the selection will be replaced by the text given
		191	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		192	for the filename):
		193
		194	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		195
81	=back	196	=back
		197
		198	=head1 API DOCUMENTATION
82		199
83	=head2 General API Considerations	200	=head2 General API Considerations
84		201
85	All objects (such as terminals, time watchers etc.) are typical	202	All objects (such as terminals, time watchers etc.) are typical
86	reference-to-hash objects. The hash can be used to store anything you	203	reference-to-hash objects. The hash can be used to store anything you
…		…
99	=over 4	216	=over 4
100		217
101	=item $text	218	=item $text
102		219
103	Rxvt-unicodes special way of encoding text, where one "unicode" character	220	Rxvt-unicodes special way of encoding text, where one "unicode" character
104	always represents one screen cell. See L<row_t> for a discussion of this format.	221	always represents one screen cell. See L<ROW_t> for a discussion of this format.
105		222
106	=item $string	223	=item $string
107		224
108	A perl text string, with an emphasis on I<text>. It can store all unicode	225	A perl text string, with an emphasis on I<text>. It can store all unicode
109	characters and is to be distinguished with text encoded in a specific	226	characters and is to be distinguished with text encoded in a specific
…		…
114	Either binary data or - more common - a text string encoded in a	231	Either binary data or - more common - a text string encoded in a
115	locale-specific way.	232	locale-specific way.
116		233
117	=back	234	=back
118		235
		236	=head2 Extension Objects
		237
		238	Very perl extension is a perl class. A separate perl object is created
		239	for each terminal and each extension and passed as the first parameter to
		240	hooks. So extensions can use their C<$self> object without having to think
		241	about other extensions, with the exception of methods and members that
		242	begin with an underscore character C<_>: these are reserved for internal
		243	use.
		244
		245	Although it isn't a C<urxvt::term> object, you can call all methods of the
		246	C<urxvt::term> class on this object.
		247
		248	It has the following methods and data members:
		249
		250	=over 4
		251
		252	=item $urxvt_term = $self->{term}
		253
		254	Returns the C<urxvt::term> object associated with this instance of the
		255	extension. This member I<must not> be changed in any way.
		256
		257	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		258
		259	Dynamically enable the given hooks (named without the C<on_> prefix) for
		260	this extension, replacing any previous hook. This is useful when you want
		261	to overwrite time-critical hooks only temporarily.
		262
		263	=item $self->disable ($hook_name[, $hook_name..])
		264
		265	Dynamically disable the given hooks.
		266
		267	=back
		268
119	=head2 Hooks	269	=head2 Hooks
120		270
121	The following subroutines can be declared in extension files, and will be	271	The following subroutines can be declared in extension files, and will be
122	called whenever the relevant event happens.	272	called whenever the relevant event happens.
123		273
124	The first argument passed to them is an object private to each terminal	274	The first argument passed to them is an extension oject as described in
125	and extension package. You can call all C<urxvt::term> methods on it, but	275	the in the C<Extension Objects> section.
126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127	object that is shared between all packages is stored in the C<term>
128	member. It is, however, blessed intot he package of the extension script,
129	so for all practical purposes you can treat an extension script as a class.
130		276
131	All of them must return a boolean value. If it is true, then the event	277	B<All> of these hooks must return a boolean value. If it is true, then the
132	counts as being I<consumed>, and the invocation of other hooks is skipped,	278	event counts as being I<consumed>, and the invocation of other hooks is
133	and the relevant action might not be carried out by the C++ code.	279	skipped, and the relevant action might not be carried out by the C++ code.
134		280
135	When in doubt, return a false value (preferably C<()>).	281	I<< When in doubt, return a false value (preferably C<()>). >>
136		282
137	=over 4	283	=over 4
138		284
139	=item on_init $term	285	=item on_init $term
140		286
…		…
175	=item on_sel_extend $term	321	=item on_sel_extend $term
176		322
177	Called whenever the user tries to extend the selection (e.g. with a double	323	Called whenever the user tries to extend the selection (e.g. with a double
178	click) and is either supposed to return false (normal operation), or	324	click) and is either supposed to return false (normal operation), or
179	should extend the selection itelf and return true to suppress the built-in	325	should extend the selection itelf and return true to suppress the built-in
180	processing.	326	processing. This can happen multiple times, as long as the callback
		327	returns true, it will be called on every further click by the user and is
		328	supposed to enlarge the selection more and more, if possible.
181		329
182	See the F<selection> example extension.	330	See the F<selection> example extension.
183		331
184	=item on_view_change $term, $offset	332	=item on_view_change $term, $offset
185		333
…		…
194	than the scroll back buffer or the terminal.	342	than the scroll back buffer or the terminal.
195		343
196	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	344	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
197	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	345	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
198	number of lines that will be in the scrollback buffer.	346	number of lines that will be in the scrollback buffer.
199
200	=item on_tty_activity $term NYI
201
202	Called whenever the program(s) running in the urxvt window send output.
203		347
204	=item on_osc_seq $term, $string	348	=item on_osc_seq $term, $string
205		349
206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	350	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207	operating system command) is processed. Cursor position and other state	351	operating system command) is processed. Cursor position and other state
…		…
220	can filter/change and output the text yourself by returning a true value	364	can filter/change and output the text yourself by returning a true value
221	and calling C<< $term->scr_add_lines >> yourself. Please note that this	365	and calling C<< $term->scr_add_lines >> yourself. Please note that this
222	might be very slow, however, as your hook is called for B<all> text being	366	might be very slow, however, as your hook is called for B<all> text being
223	output.	367	output.
224		368
		369	=item on_tt_write $term, $octets
		370
		371	Called whenever some data is written to the tty/pty and can be used to
		372	suppress or filter tty input.
		373
225	=item on_line_update $term, $row	374	=item on_line_update $term, $row
226		375
227	Called whenever a line was updated or changed. Can be used to filter	376	Called whenever a line was updated or changed. Can be used to filter
228	screen output (e.g. underline urls or other useless stuff). Only lines	377	screen output (e.g. underline urls or other useless stuff). Only lines
229	that are being shown will be filtered, and, due to performance reasons,	378	that are being shown will be filtered, and, due to performance reasons,
…		…
251		400
252	Called whenever the user presses a key combination that has a	401	Called whenever the user presses a key combination that has a
253	C<perl:string> action bound to it (see description of the B<keysym>	402	C<perl:string> action bound to it (see description of the B<keysym>
254	resource in the @@RXVT_NAME@@(1) manpage).	403	resource in the @@RXVT_NAME@@(1) manpage).
255		404
		405	=item on_x_event $term, $event
		406
		407	Called on every X event received on the vt window (and possibly other
		408	windows). Should only be used as a last resort. Most event structure
		409	members are not passed.
		410
256	=item on_focus_in $term	411	=item on_focus_in $term
257		412
258	Called whenever the window gets the keyboard focus, before rxvt-unicode	413	Called whenever the window gets the keyboard focus, before rxvt-unicode
259	does focus in processing.	414	does focus in processing.
260		415
261	=item on_focus_out $term	416	=item on_focus_out $term
262		417
263	Called wheneever the window loses keyboard focus, before rxvt-unicode does	418	Called wheneever the window loses keyboard focus, before rxvt-unicode does
264	focus out processing.	419	focus out processing.
265		420
266	=item on_key_press $term, $event, $octets	421	=item on_key_press $term, $event, $keysym, $octets
267		422
268	=item on_key_release $term, $event	423	=item on_key_release $term, $event, $keysym
269		424
270	=item on_button_press $term, $event	425	=item on_button_press $term, $event
271		426
272	=item on_button_release $term, $event	427	=item on_button_release $term, $event
273		428
…		…
289		444
290	subwindow.	445	subwindow.
291		446
292	=back	447	=back
293		448
		449	=cut
		450
		451	package urxvt;
		452
		453	use utf8;
		454	use strict;
		455	use Carp ();
		456	use Scalar::Util ();
		457	use List::Util ();
		458
		459	our $VERSION = 1;
		460	our $TERM;
		461	our @HOOKNAME;
		462	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		463	our %OPTION;
		464
		465	our $LIBDIR;
		466	our $RESNAME;
		467	our $RESCLASS;
		468	our $RXVTNAME;
		469
294	=head2 Variables in the C<urxvt> Package	470	=head2 Variables in the C<urxvt> Package
295		471
296	=over 4	472	=over 4
		473
		474	=item $urxvt::LIBDIR
		475
		476	The rxvt-unicode library directory, where, among other things, the perl
		477	modules and scripts are stored.
		478
		479	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		480
		481	The resource class and name rxvt-unicode uses to look up X resources.
		482
		483	=item $urxvt::RXVTNAME
		484
		485	The basename of the installed binaries, usually C<urxvt>.
297		486
298	=item $urxvt::TERM	487	=item $urxvt::TERM
299		488
300	The current terminal. This variable stores the current C<urxvt::term>	489	The current terminal. This variable stores the current C<urxvt::term>
301	object, whenever a callback/hook is executing.	490	object, whenever a callback/hook is executing.
…		…
303	=back	492	=back
304		493
305	=head2 Functions in the C<urxvt> Package	494	=head2 Functions in the C<urxvt> Package
306		495
307	=over 4	496	=over 4
308
309	=item $term = new urxvt [arg...]
310
311	Creates a new terminal, very similar as if you had started it with
312	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
313	if the new instance couldn't be created. Returns C<undef> if the new
314	instance didn't initialise perl, and the terminal object otherwise. The
315	C<init> and C<start> hooks will be called during the call.
316		497
317	=item urxvt::fatal $errormessage	498	=item urxvt::fatal $errormessage
318		499
319	Fatally aborts execution with the given error message. Avoid at all	500	Fatally aborts execution with the given error message. Avoid at all
320	costs! The only time this is acceptable is when the terminal process	501	costs! The only time this is acceptable is when the terminal process
…		…
327	that calls this function.	508	that calls this function.
328		509
329	Using this function has the advantage that its output ends up in the	510	Using this function has the advantage that its output ends up in the
330	correct place, e.g. on stderr of the connecting urxvtc client.	511	correct place, e.g. on stderr of the connecting urxvtc client.
331		512
		513	Messages have a size limit of 1023 bytes currently.
		514
332	=item $time = urxvt::NOW	515	=item $time = urxvt::NOW
333		516
334	Returns the "current time" (as per the event loop).	517	Returns the "current time" (as per the event loop).
335		518
336	=item urxvt::CurrentTime	519	=item urxvt::CurrentTime
337		520
338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	521	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	522	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340	Button4Mask, Button5Mask, AnyModifier	523	Button4Mask, Button5Mask, AnyModifier
341		524
		525	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		526	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		527	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		528	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		529	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		530	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		531	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		532
		533	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		534	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		535	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		536	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		537	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		538	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		539	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		540
342	Various constants for use in X events.	541	Various constants for use in X calls and event processing.
343		542
344	=back	543	=back
345		544
346	=head2 RENDITION	545	=head2 RENDITION
347		546
…		…
374		573
375	=item $background = urxvt::GET_BASEBG $rend	574	=item $background = urxvt::GET_BASEBG $rend
376		575
377	Return the foreground/background colour index, respectively.	576	Return the foreground/background colour index, respectively.
378		577
379	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	578	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
380		579
381	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	580	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
382		581
383	Replace the foreground/background colour in the rendition mask with the	582	Replace the foreground/background colour in the rendition mask with the
384	specified one.	583	specified one.
385		584
386	=item $value = urxvt::GET_CUSTOM ($rend)	585	=item $value = urxvt::GET_CUSTOM $rend
387		586
388	Return the "custom" value: Every rendition has 5 bits for use by	587	Return the "custom" value: Every rendition has 5 bits for use by
389	extensions. They can be set and changed as you like and are initially	588	extensions. They can be set and changed as you like and are initially
390	zero.	589	zero.
391		590
392	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	591	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
393		592
394	Change the custom value.	593	Change the custom value.
395		594
396	=back	595	=back
397		596
398	=cut	597	=cut
399
400	package urxvt;
401
402	use utf8;
403	use strict;
404	use Scalar::Util ();
405	use List::Util ();
406
407	our $TERM;
408	our @HOOKNAME;
409	our $LIBDIR;
410		598
411	BEGIN {	599	BEGIN {
412	urxvt->bootstrap;	600	urxvt->bootstrap;
413		601
414	# overwrite perl's warn	602	# overwrite perl's warn
…		…
416	my $msg = join "", @_;	604	my $msg = join "", @_;
417	$msg .= "\n"	605	$msg .= "\n"
418	unless $msg =~ /\n$/;	606	unless $msg =~ /\n$/;
419	urxvt::warn ($msg);	607	urxvt::warn ($msg);
420	};	608	};
421	}
422		609
423	my @hook_count;	610	# %ENV is the original startup environment
		611	delete $ENV{IFS};
		612	delete $ENV{CDPATH};
		613	delete $ENV{BASH_ENV};
		614	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
		615	}
		616
424	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
425		618
426	sub verbose {	619	sub verbose {
427	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
428	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
429	}	622	}
430		623
431	# find on_xxx subs in the package and register them
432	# as hooks
433	sub register_package($) {
434	my ($pkg) = @_;
435
436	for my $htype (0.. $#HOOKNAME) {
437	my $name = $HOOKNAME[$htype];
438
439	my $ref = $pkg->can ("on_" . lc $name)
440	or next;
441
442	$TERM->{_hook}[$htype]{$pkg} = $ref;
443	$hook_count[$htype]++
444	or set_should_invoke $htype, 1;
445	}
446	}
447
448	my $extension_pkg = "extension0000";	624	my $extension_pkg = "extension0000";
449	my %extension_pkg;	625	my %extension_pkg;
450		626
451	# load a single script into its own package, once only	627	# load a single script into its own package, once only
452	sub extension_package($) {	628	sub extension_package($) {
…		…
458	verbose 3, "loading extension '$path' into package '$pkg'";	634	verbose 3, "loading extension '$path' into package '$pkg'";
459		635
460	open my $fh, "<:raw", $path	636	open my $fh, "<:raw", $path
461	or die "$path: $!";	637	or die "$path: $!";
462		638
		639	my $source =
463	my $source = "package $pkg; use strict; use utf8;\n"	640	"package $pkg; use strict; use utf8;\n"
464	. "use base urxvt::term::proxy::;\n"	641	. "use base urxvt::term::extension::;\n"
465	. "#line 1 \"$path\"\n{\n"	642	. "#line 1 \"$path\"\n{\n"
466	. (do { local $/; <$fh> })	643	. (do { local $/; <$fh> })
467	. "\n};\n1";	644	. "\n};\n1";
468		645
		646	eval $source
469	eval $source or die "$path: $@";	647	or die "$path: $@";
470		648
471	$pkg	649	$pkg
472	}	650	}
473	}	651	}
474		652
…		…
479	local $TERM = shift;	657	local $TERM = shift;
480	my $htype = shift;	658	my $htype = shift;
481		659
482	if ($htype == 0) { # INIT	660	if ($htype == 0) { # INIT
483	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	661	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		662
		663	my %ext_arg;
484		664
485	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	665	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		666	if ($_ eq "default") {
		667	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		668	} elsif (/^-(.*)$/) {
		669	delete $ext_arg{$1};
		670	} elsif (/^([^<]+)<(.*)>$/) {
		671	push @{ $ext_arg{$1} }, $2;
		672	} else {
		673	$ext_arg{$_} \|\|= [];
		674	}
		675	}
		676
		677	while (my ($ext, $argv) = each %ext_arg) {
486	my @files = grep -f $_, map "$_/$ext", @dirs;	678	my @files = grep -f $_, map "$_/$ext", @dirs;
487		679
488	if (@files) {	680	if (@files) {
489	register_package extension_package $files[0];	681	$TERM->register_package (extension_package $files[0], $argv);
490	} else {	682	} else {
491	warn "perl extension '$ext' not found in perl library search path\n";	683	warn "perl extension '$ext' not found in perl library search path\n";
492	}	684	}
493	}	685	}
		686
		687	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		688	warn $@ if $@;
494	}	689	}
495		690
496	$retval = undef;	691	$retval = undef;
497		692
498	if (my $cb = $TERM->{_hook}[$htype]) {	693	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
500	if $verbosity >= 10;	695	if $verbosity >= 10;
501		696
502	keys %$cb;	697	keys %$cb;
503		698
504	while (my ($pkg, $cb) = each %$cb) {	699	while (my ($pkg, $cb) = each %$cb) {
505	eval {	700	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
506	$retval = $cb->(
507	$TERM->{_pkg}{$pkg} \|\|= do {
508	my $proxy = bless { }, $pkg;
509	Scalar::Util::weaken ($proxy->{term} = $TERM);
510	$proxy
511	},
512	@_,
513	) and last;	701	and last;
514	};
515	warn $@ if $@;#d#
516	}
517	}
518		702
519	if ($htype == 1) { # DESTROY	703	if ($@) {
520	# remove hooks if unused	704	$TERM->ungrab; # better to lose the grab than the session
521	if (my $hook = $TERM->{_hook}) {	705	warn $@;
522	for my $htype (0..$#$hook) {
523	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
524	or set_should_invoke $htype, 0;
525	}	706	}
526	}	707	}
527		708
		709	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		710	if $verbosity >= 11;
		711	}
		712
		713	if ($htype == 1) { # DESTROY
528	# clear package objects	714	# clear package objects
529	%$_ = () for values %{ $TERM->{_pkg} };	715	%$_ = () for values %{ $TERM->{_pkg} };
530		716
531	# clear package	717	# clear package
532	%$TERM = ();	718	%$TERM = ();
533	}	719	}
534		720
535	$retval	721	$retval
536	}	722	}
537		723
538	sub urxvt::term::proxy::AUTOLOAD {	724	sub exec_async(@) {
539	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	725	my $pid = fork;
		726
		727	return
		728	if !defined $pid or $pid;
		729
		730	%ENV = %{ $TERM->env };
		731
		732	exec @_;
		733	_exit 255;
		734	}
		735
		736	# urxvt::term::extension
		737
		738	package urxvt::term::extension;
		739
		740	sub enable {
		741	my ($self, %hook) = @_;
		742	my $pkg = $self->{_pkg};
		743
		744	while (my ($name, $cb) = each %hook) {
		745	my $htype = $HOOKTYPE{uc $name};
		746	defined $htype
		747	or Carp::croak "unsupported hook type '$name'";
		748
		749	$self->set_should_invoke ($htype, +1)
		750	unless exists $self->{term}{_hook}[$htype]{$pkg};
		751
		752	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		753	}
		754	}
		755
		756	sub disable {
		757	my ($self, @hook) = @_;
		758	my $pkg = $self->{_pkg};
		759
		760	for my $name (@hook) {
		761	my $htype = $HOOKTYPE{uc $name};
		762	defined $htype
		763	or Carp::croak "unsupported hook type '$name'";
		764
		765	$self->set_should_invoke ($htype, -1)
		766	if delete $self->{term}{_hook}[$htype]{$pkg};
		767	}
		768	}
		769
		770	our $AUTOLOAD;
		771
		772	sub AUTOLOAD {
		773	$AUTOLOAD =~ /:([^:]+)$/
540	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	774	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
541		775
542	eval qq{	776	eval qq{
543	sub $urxvt::term::proxy::AUTOLOAD {	777	sub $AUTOLOAD {
544	my \$proxy = shift;	778	my \$proxy = shift;
545	\$proxy->{term}->$1 (\@_)	779	\$proxy->{term}->$1 (\@_)
546	}	780	}
547	1	781	1
548	} or die "FATAL: unable to compile method forwarder: $@";	782	} or die "FATAL: unable to compile method forwarder: $@";
549		783
550	goto &$urxvt::term::proxy::AUTOLOAD;	784	goto &$AUTOLOAD;
551	}	785	}
		786
		787	sub DESTROY {
		788	# nop
		789	}
		790
		791	# urxvt::destroy_hook
552		792
553	sub urxvt::destroy_hook::DESTROY {	793	sub urxvt::destroy_hook::DESTROY {
554	${$_[0]}->();	794	${$_[0]}->();
555	}	795	}
556		796
557	sub urxvt::destroy_hook(&) {	797	sub urxvt::destroy_hook(&) {
558	bless \shift, urxvt::destroy_hook::	798	bless \shift, urxvt::destroy_hook::
559	}	799	}
560		800
		801	package urxvt::anyevent;
		802
		803	=head2 The C<urxvt::anyevent> Class
		804
		805	The sole purpose of this class is to deliver an interface to the
		806	C<AnyEvent> module - any module using it will work inside urxvt without
		807	further programming. The only exception is that you cannot wait on
		808	condition variables, but non-blocking condvar use is ok. What this means
		809	is that you cannot use blocking APIs, but the non-blocking variant should
		810	work.
		811
		812	=cut
		813
		814	our $VERSION = 1;
		815
		816	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		817	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		818
		819	sub timer {
		820	my ($class, %arg) = @_;
		821
		822	my $cb = $arg{cb};
		823
		824	urxvt::timer
		825	->new
		826	->start (urxvt::NOW + $arg{after})
		827	->cb (sub {
		828	$_[0]->stop; # need to cancel manually
		829	$cb->();
		830	})
		831	}
		832
		833	sub io {
		834	my ($class, %arg) = @_;
		835
		836	my $cb = $arg{cb};
		837
		838	bless [$arg{fh}, urxvt::iow
		839	->new
		840	->fd (fileno $arg{fh})
		841	->events (($arg{poll} =~ /r/ ? 1 : 0)
		842	\| ($arg{poll} =~ /w/ ? 2 : 0))
		843	->start
		844	->cb (sub {
		845	$cb->(($_[1] & 1 ? 'r' : '')
		846	. ($_[1] & 2 ? 'w' : ''));
		847	})],
		848	urxvt::anyevent::
		849	}
		850
		851	sub DESTROY {
		852	$_[0][1]->stop;
		853	}
		854
		855	sub condvar {
		856	bless \my $flag, urxvt::anyevent::condvar::
		857	}
		858
		859	sub urxvt::anyevent::condvar::broadcast {
		860	${$_[0]}++;
		861	}
		862
		863	sub urxvt::anyevent::condvar::wait {
		864	unless (${$_[0]}) {
		865	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		866	}
		867	}
		868
		869	package urxvt::term;
		870
561	=head2 The C<urxvt::term> Class	871	=head2 The C<urxvt::term> Class
562		872
563	=over 4	873	=over 4
564		874
		875	=cut
		876
		877	# find on_xxx subs in the package and register them
		878	# as hooks
		879	sub register_package {
		880	my ($self, $pkg, $argv) = @_;
		881
		882	my $proxy = bless {
		883	_pkg => $pkg,
		884	argv => $argv,
		885	}, $pkg;
		886	Scalar::Util::weaken ($proxy->{term} = $self);
		887
		888	$self->{_pkg}{$pkg} = $proxy;
		889
		890	for my $name (@HOOKNAME) {
		891	if (my $ref = $pkg->can ("on_" . lc $name)) {
		892	$proxy->enable ($name => $ref);
		893	}
		894	}
		895	}
		896
		897	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		898
		899	Creates a new terminal, very similar as if you had started it with system
		900	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		901	hash which defines the environment of the new terminal.
		902
		903	Croaks (and probably outputs an error message) if the new instance
		904	couldn't be created. Returns C<undef> if the new instance didn't
		905	initialise perl, and the terminal object otherwise. The C<init> and
		906	C<start> hooks will be called during this call.
		907
		908	=cut
		909
		910	sub new {
		911	my ($class, $env, @args) = @_;
		912
		913	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		914	}
		915
565	=item $term->destroy	916	=item $term->destroy
566		917
567	Destroy the terminal object (close the window, free resources etc.).	918	Destroy the terminal object (close the window, free resources
		919	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		920	watchers (timers, io watchers) are still active.
		921
		922	=item $isset = $term->option ($optval[, $set])
		923
		924	Returns true if the option specified by C<$optval> is enabled, and
		925	optionally change it. All option values are stored by name in the hash
		926	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		927
		928	Here is a a likely non-exhaustive list of option names, please see the
		929	source file F</src/optinc.h> to see the actual list:
		930
		931	borderLess console cursorBlink cursorUnderline hold iconic insecure
		932	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		933	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		934	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		935	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		936	tripleclickwords utmpInhibit visualBell
568		937
569	=item $value = $term->resource ($name[, $newval])	938	=item $value = $term->resource ($name[, $newval])
570		939
571	Returns the current resource value associated with a given name and	940	Returns the current resource value associated with a given name and
572	optionally sets a new value. Setting values is most useful in the C<init>	941	optionally sets a new value. Setting values is most useful in the C<init>
…		…
582		951
583	Please note that resource strings will currently only be freed when the	952	Please note that resource strings will currently only be freed when the
584	terminal is destroyed, so changing options frequently will eat memory.	953	terminal is destroyed, so changing options frequently will eat memory.
585		954
586	Here is a a likely non-exhaustive list of resource names, not all of which	955	Here is a a likely non-exhaustive list of resource names, not all of which
587	are supported in every build, please see the source to see the actual	956	are supported in every build, please see the source file F</src/rsinc.h>
588	list:	957	to see the actual list:
589		958
590	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	959	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
591	borderLess color cursorBlink cursorUnderline cutchars delete_key	960	borderLess color cursorBlink cursorUnderline cutchars delete_key
592	display_name embed ext_bwidth fade font geometry hold iconName	961	display_name embed ext_bwidth fade font geometry hold iconName
593	imFont imLocale inputMethod insecure int_bwidth intensityStyles	962	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
600	shade term_name title transparent transparent_all tripleclickwords	969	shade term_name title transparent transparent_all tripleclickwords
601	utmpInhibit visualBell	970	utmpInhibit visualBell
602		971
603	=cut	972	=cut
604		973
605	sub urxvt::term::resource($$;$) {	974	sub resource($$;$) {
606	my ($self, $name) = (shift, shift);	975	my ($self, $name) = (shift, shift);
607	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	976	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
608	&urxvt::term::_resource	977	&urxvt::term::_resource
609	}	978	}
610		979
		980	=item $value = $term->x_resource ($pattern)
		981
		982	Returns the X-Resource for the given pattern, excluding the program or
		983	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		984	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		985	resource with that pattern exists.
		986
		987	This method should only be called during the C<on_start> hook, as there is
		988	only one resource database per display, and later invocations might return
		989	the wrong resources.
		990
		991	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		992
		993	Adds a keymap translation exactly as specified via a resource. See the
		994	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		995
611	=item $rend = $term->rstyle ([$new_rstyle])	996	=item $rend = $term->rstyle ([$new_rstyle])
612		997
613	Return and optionally change the current rendition. Text that is output by	998	Return and optionally change the current rendition. Text that is output by
614	the terminal application will use this style.	999	the terminal application will use this style.
615		1000
…		…
625	=item ($row, $col) = $term->selection_end ([$row, $col])	1010	=item ($row, $col) = $term->selection_end ([$row, $col])
626		1011
627	Return the current values of the selection mark, begin or end positions,	1012	Return the current values of the selection mark, begin or end positions,
628	and optionally set them to new values.	1013	and optionally set them to new values.
629		1014
		1015	=item $term->selection_make ($eventtime[, $rectangular])
		1016
		1017	Tries to make a selection as set by C<selection_beg> and
		1018	C<selection_end>. If C<$rectangular> is true (default: false), a
		1019	rectangular selection will be made. This is the prefered function to make
		1020	a selection.
		1021
630	=item $success = $term->selection_grab ($eventtime)	1022	=item $success = $term->selection_grab ($eventtime)
631		1023
632	Try to request the primary selection from the server (for example, as set	1024	Try to request the primary selection text from the server (for example, as
633	by the next method).	1025	set by the next method). No visual feedback will be given. This function
		1026	is mostly useful from within C<on_sel_grab> hooks.
634		1027
635	=item $oldtext = $term->selection ([$newtext])	1028	=item $oldtext = $term->selection ([$newtext])
636		1029
637	Return the current selection text and optionally replace it by C<$newtext>.	1030	Return the current selection text and optionally replace it by C<$newtext>.
638		1031
639	#=item $term->overlay ($x, $y, $text)	1032	=item $term->overlay_simple ($x, $y, $text)
640	#	1033
641	#Create a simple multi-line overlay box. See the next method for details.	1034	Create a simple multi-line overlay box. See the next method for details.
642	#	1035
643	#=cut	1036	=cut
644	#	1037
645	#sub urxvt::term::scr_overlay {	1038	sub overlay_simple {
646	# my ($self, $x, $y, $text) = @_;	1039	my ($self, $x, $y, $text) = @_;
647	#	1040
648	# my @lines = split /\n/, $text;	1041	my @lines = split /\n/, $text;
649	#	1042
650	# my $w = 0;	1043	my $w = List::Util::max map $self->strwidth ($_), @lines;
651	# for (map $self->strwidth ($_), @lines) {	1044
652	# $w = $_ if $w < $_;
653	# }
654	#
655	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1045	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
656	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1046	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
657	#}	1047
		1048	$overlay
		1049	}
658		1050
659	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1051	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
660		1052
661	Create a new (empty) overlay at the given position with the given	1053	Create a new (empty) overlay at the given position with the given
662	width/height. C<$rstyle> defines the initial rendition style	1054	width/height. C<$rstyle> defines the initial rendition style
…		…
697	C<$event> I<must> be the event causing the menu to pop up (a button event,	1089	C<$event> I<must> be the event causing the menu to pop up (a button event,
698	currently).	1090	currently).
699		1091
700	=cut	1092	=cut
701		1093
702	sub urxvt::term::popup {	1094	sub popup {
703	my ($self, $event) = @_;	1095	my ($self, $event) = @_;
704		1096
705	$self->grab ($event->{time}, 1)	1097	$self->grab ($event->{time}, 1)
706	or return;	1098	or return;
707		1099
…		…
729		1121
730	=item $string = $term->locale_decode ($octets)	1122	=item $string = $term->locale_decode ($octets)
731		1123
732	Convert the given locale-encoded octets into a perl string.	1124	Convert the given locale-encoded octets into a perl string.
733		1125
		1126	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1127
		1128	XORs the rendition values in the given span with the provided value
		1129	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1130	refresh hooks to provide effects similar to the selection.
		1131
		1132	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1133
		1134	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1135	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1136	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1137	it instead. Both styles I<MUST NOT> contain font styles.
		1138
		1139	=item $term->scr_bell
		1140
		1141	Ring the bell!
		1142
734	=item $term->scr_add_lines ($string)	1143	=item $term->scr_add_lines ($string)
735		1144
736	Write the given text string to the screen, as if output by the application	1145	Write the given text string to the screen, as if output by the application
737	running inside the terminal. It may not contain command sequences (escape	1146	running inside the terminal. It may not contain command sequences (escape
738	codes), but is free to use line feeds, carriage returns and tabs. The	1147	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
752		1161
753	Write the octets given in C<$data> to the tty (i.e. as program input). To	1162	Write the octets given in C<$data> to the tty (i.e. as program input). To
754	pass characters instead of octets, you should convert your strings first	1163	pass characters instead of octets, you should convert your strings first
755	to the locale-specific encoding using C<< $term->locale_encode >>.	1164	to the locale-specific encoding using C<< $term->locale_encode >>.
756		1165
		1166	=item $old_events = $term->pty_ev_events ([$new_events])
		1167
		1168	Replaces the event mask of the pty watcher by the given event mask. Can
		1169	be used to suppress input and output handling to the pty/tty. See the
		1170	description of C<< urxvt::timer->events >>. Make sure to always restore
		1171	the previous value.
		1172
757	=item $windowid = $term->parent	1173	=item $windowid = $term->parent
758		1174
759	Return the window id of the toplevel window.	1175	Return the window id of the toplevel window.
760		1176
761	=item $windowid = $term->vt	1177	=item $windowid = $term->vt
762		1178
763	Return the window id of the terminal window.	1179	Return the window id of the terminal window.
764		1180
		1181	=item $term->vt_emask_add ($x_event_mask)
		1182
		1183	Adds the specified events to the vt event mask. Useful e.g. when you want
		1184	to receive pointer events all the times:
		1185
		1186	$term->vt_emask_add (urxvt::PointerMotionMask);
		1187
765	=item $window_width = $term->width	1188	=item $window_width = $term->width
766		1189
767	=item $window_height = $term->height	1190	=item $window_height = $term->height
768		1191
769	=item $font_width = $term->fwidth	1192	=item $font_width = $term->fwidth
…		…
782		1205
783	=item $max_scrollback = $term->saveLines	1206	=item $max_scrollback = $term->saveLines
784		1207
785	=item $nrow_plus_saveLines = $term->total_rows	1208	=item $nrow_plus_saveLines = $term->total_rows
786		1209
787	=item $lines_in_scrollback = $term->nsaved	1210	=item $topmost_scrollback_row = $term->top_row
788		1211
789	Return various integers describing terminal characteristics.	1212	Return various integers describing terminal characteristics.
		1213
		1214	=item $x_display = $term->display_id
		1215
		1216	Return the DISPLAY used by rxvt-unicode.
		1217
		1218	=item $lc_ctype = $term->locale
		1219
		1220	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1221
		1222	=item $env = $term->env
		1223
		1224	Returns a copy of the environment in effect for the terminal as a hashref
		1225	similar to C<\%ENV>.
		1226
		1227	=cut
		1228
		1229	sub env {
		1230	if (my $env = $_[0]->_env) {
		1231	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1232	} else {
		1233	+{ %ENV }
		1234	}
		1235	}
790		1236
791	=item $modifiermask = $term->ModLevel3Mask	1237	=item $modifiermask = $term->ModLevel3Mask
792		1238
793	=item $modifiermask = $term->ModMetaMask	1239	=item $modifiermask = $term->ModMetaMask
794		1240
…		…
797	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1243	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
798	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1244	AltGr), the meta key (often Alt) and the num lock key, if applicable.
799		1245
800	=item $view_start = $term->view_start ([$newvalue])	1246	=item $view_start = $term->view_start ([$newvalue])
801		1247
802	Returns the negative row number of the topmost line. Minimum value is	1248	Returns the row number of the topmost displayed line. Maximum value is
803	C<0>, which displays the normal terminal contents. Larger values scroll	1249	C<0>, which displays the normal terminal contents. Lower values scroll
804	this many lines into the scrollback buffer.	1250	this many lines into the scrollback buffer.
805		1251
806	=item $term->want_refresh	1252	=item $term->want_refresh
807		1253
808	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1254	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
887	Return the row number of the first/last row of the line, respectively.	1333	Return the row number of the first/last row of the line, respectively.
888		1334
889	=item $offset = $line->offset_of ($row, $col)	1335	=item $offset = $line->offset_of ($row, $col)
890		1336
891	Returns the character offset of the given row\|col pair within the logical	1337	Returns the character offset of the given row\|col pair within the logical
892	line.	1338	line. Works for rows outside the line, too, and returns corresponding
		1339	offsets outside the string.
893		1340
894	=item ($row, $col) = $line->coord_of ($offset)	1341	=item ($row, $col) = $line->coord_of ($offset)
895		1342
896	Translates a string offset into terminal coordinates again.	1343	Translates a string offset into terminal coordinates again.
897		1344
898	=back	1345	=back
899		1346
900	=cut	1347	=cut
901		1348
902	sub urxvt::term::line {	1349	sub line {
903	my ($self, $row) = @_;	1350	my ($self, $row) = @_;
904		1351
905	my $maxrow = $self->nrow - 1;	1352	my $maxrow = $self->nrow - 1;
906		1353
907	my ($beg, $end) = ($row, $row);	1354	my ($beg, $end) = ($row, $row);
…		…
971	$offset / $self->{ncol} + $self->{beg},	1418	$offset / $self->{ncol} + $self->{beg},
972	$offset % $self->{ncol}	1419	$offset % $self->{ncol}
973	)	1420	)
974	}	1421	}
975		1422
976	=item ($row, $col) = $line->coord_of ($offset)
977	=item $text = $term->special_encode $string	1423	=item $text = $term->special_encode $string
978		1424
979	Converts a perl string into the special encoding used by rxvt-unicode,	1425	Converts a perl string into the special encoding used by rxvt-unicode,
980	where one character corresponds to one screen cell. See	1426	where one character corresponds to one screen cell. See
981	C<< $term->ROW_t >> for details.	1427	C<< $term->ROW_t >> for details.
…		…
983	=item $string = $term->special_decode $text	1429	=item $string = $term->special_decode $text
984		1430
985	Converts rxvt-unicodes text reprsentation into a perl string. See	1431	Converts rxvt-unicodes text reprsentation into a perl string. See
986	C<< $term->ROW_t >> for details.	1432	C<< $term->ROW_t >> for details.
987		1433
		1434	=item $success = $term->grab_button ($button, $modifiermask)
		1435
		1436	Registers a synchronous button grab. See the XGrabButton manpage.
		1437
		1438	=item $success = $term->grab ($eventtime[, $sync])
		1439
		1440	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1441	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1442
		1443	=item $term->allow_events_async
		1444
		1445	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1446
		1447	=item $term->allow_events_sync
		1448
		1449	Calls XAllowEvents with SyncBoth for the most recent grab.
		1450
		1451	=item $term->allow_events_replay
		1452
		1453	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1454	recent grab.
		1455
		1456	=item $term->ungrab
		1457
		1458	Calls XUngrab for the most recent grab. Is called automatically on
		1459	evaluation errors, as it is better to lose the grab in the error case as
		1460	the session.
		1461
988	=back	1462	=back
989		1463
		1464	=cut
		1465
		1466	package urxvt::popup;
		1467
990	=head2 The C<urxvt::popup> Class	1468	=head2 The C<urxvt::popup> Class
991		1469
992	=over 4	1470	=over 4
993		1471
994	=cut	1472	=cut
995
996	package urxvt::popup;
997		1473
998	sub add_item {	1474	sub add_item {
999	my ($self, $item) = @_;	1475	my ($self, $item) = @_;
1000		1476
		1477	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1478	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1479	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1480
		1481	$item->{render} \|\|= sub { $_[0]{text} };
		1482
1001	push @{ $self->{item} }, $item;	1483	push @{ $self->{item} }, $item;
1002	}	1484	}
		1485
		1486	=item $popup->add_title ($title)
		1487
		1488	Adds a non-clickable title to the popup.
		1489
		1490	=cut
		1491
		1492	sub add_title {
		1493	my ($self, $title) = @_;
		1494
		1495	$self->add_item ({
		1496	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1497	text => $title,
		1498	activate => sub { },
		1499	});
		1500	}
		1501
		1502	=item $popup->add_separator ([$sepchr])
		1503
		1504	Creates a separator, optionally using the character given as C<$sepchr>.
		1505
		1506	=cut
		1507
		1508	sub add_separator {
		1509	my ($self, $sep) = @_;
		1510
		1511	$sep \|\|= "=";
		1512
		1513	$self->add_item ({
		1514	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1515	text => "",
		1516	render => sub { $sep x $self->{term}->ncol },
		1517	activate => sub { },
		1518	});
		1519	}
		1520
		1521	=item $popup->add_button ($text, $cb)
		1522
		1523	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1524	selected.
		1525
		1526	=cut
1003		1527
1004	sub add_button {	1528	sub add_button {
1005	my ($self, $text, $cb) = @_;	1529	my ($self, $text, $cb) = @_;
1006		1530
1007	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,	1531	$self->add_item ({ type => "button", text => $text, activate => $cb});
1008	render => sub { $_[0]{text} },
1009	});
1010	}	1532	}
		1533
		1534	=item $popup->add_toggle ($text, $cb, $initial_value)
		1535
		1536	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1537	whenever it gets toggled, with a boolean indicating its value as its first
		1538	argument.
		1539
		1540	=cut
1011		1541
1012	sub add_toggle {	1542	sub add_toggle {
1013	my ($self, $text, $cb, $value) = @_;	1543	my ($self, $text, $cb, $value) = @_;
1014		1544
1015	$self->add_item ({ type => "button", text => " $text", value => $value,	1545	my $item; $item = {
		1546	type => "button",
		1547	text => " $text",
		1548	value => $value,
1016	render => sub { ($_[0]{value} ? "✔" : " ") . substr $_[0]{text}, 1 },	1549	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1017	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1550	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1018	});	1551	};
		1552
		1553	$self->add_item ($item);
1019	}	1554	}
		1555
		1556	=item $popup->show
		1557
		1558	Displays the popup (which is initially hidden).
		1559
		1560	=cut
1020		1561
1021	sub show {	1562	sub show {
1022	my ($self) = @_;	1563	my ($self) = @_;
1023		1564
1024	local $urxvt::popup::self = $self;	1565	local $urxvt::popup::self = $self;
1025		1566
		1567	my $env = $self->{term}->env;
		1568	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1569	delete $env->{LC_ALL};
		1570	$env->{LC_CTYPE} = $self->{term}->locale;
		1571
		1572	urxvt::term->new ($env, $self->{term}->resource ("name"),
1026	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1573	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1027	"--transient-for" => $self->{term}->parent,	1574	"--transient-for" => $self->{term}->parent,
		1575	"-display" => $self->{term}->display_id,
1028	"-pe" => "urxvt-popup")	1576	"-pe" => "urxvt-popup")
1029	or die "unable to create popup window\n";	1577	or die "unable to create popup window\n";
1030	}	1578	}
1031		1579
1032	sub DESTROY {	1580	sub DESTROY {
1033	my ($self) = @_;	1581	my ($self) = @_;
1034		1582
		1583	delete $self->{term}{_destroy}{$self};
1035	$self->{term}->ungrab;	1584	$self->{term}->ungrab;
1036	}	1585	}
		1586
		1587	=back
1037		1588
1038	=head2 The C<urxvt::timer> Class	1589	=head2 The C<urxvt::timer> Class
1039		1590
1040	This class implements timer watchers/events. Time is represented as a	1591	This class implements timer watchers/events. Time is represented as a
1041	fractional number of seconds since the epoch. Example:	1592	fractional number of seconds since the epoch. Example:
…		…
1094		1645
1095	$term->{socket} = ...	1646	$term->{socket} = ...
1096	$term->{iow} = urxvt::iow	1647	$term->{iow} = urxvt::iow
1097	->new	1648	->new
1098	->fd (fileno $term->{socket})	1649	->fd (fileno $term->{socket})
1099	->events (1) # wait for read data	1650	->events (urxvt::EVENT_READ)
1100	->start	1651	->start
1101	->cb (sub {	1652	->cb (sub {
1102	my ($iow, $revents) = @_;	1653	my ($iow, $revents) = @_;
1103	# $revents must be 1 here, no need to check	1654	# $revents must be 1 here, no need to check
1104	sysread $term->{socket}, my $buf, 8192	1655	sysread $term->{socket}, my $buf, 8192
…		…
1121		1672
1122	Set the filedescriptor (not handle) to watch.	1673	Set the filedescriptor (not handle) to watch.
1123		1674
1124	=item $iow = $iow->events ($eventmask)	1675	=item $iow = $iow->events ($eventmask)
1125		1676
1126	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1677	Set the event mask to watch. The only allowed values are
1127	data, Bit #1 (value C<2>) enables watching for write data.	1678	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1679	together, or C<urxvt::EVENT_NONE>.
1128		1680
1129	=item $iow = $iow->start	1681	=item $iow = $iow->start
1130		1682
1131	Start watching for requested events on the given handle.	1683	Start watching for requested events on the given handle.
1132		1684
…		…
1143	This variable controls the verbosity level of the perl extension. Higher	1695	This variable controls the verbosity level of the perl extension. Higher
1144	numbers indicate more verbose output.	1696	numbers indicate more verbose output.
1145		1697
1146	=over 4	1698	=over 4
1147		1699
1148	=item =0 - only fatal messages	1700	=item == 0 - fatal messages
1149		1701
1150	=item =3 - script loading and management	1702	=item >= 3 - script loading and management
1151		1703
1152	=item =10 - all events received	1704	=item >=10 - all called hooks
		1705
		1706	=item >=11 - hook reutrn values
1153		1707
1154	=back	1708	=back
1155		1709
1156	=head1 AUTHOR	1710	=head1 AUTHOR
1157		1711

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.48 by root, Sat Jan 7 21:43:17 2006 UTC vs. Revision 1.99 by root, Tue Jan 17 17:09:26 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.48 by root, Sat Jan 7 21:43:17 2006 UTC vs.
Revision 1.99 by root, Tue Jan 17 17:09:26 2006 UTC