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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.47 by root, Sat Jan 7 21:22:02 2006 UTC vs.
Revision 1.100 by root, Wed Jan 18 08:33:34 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		598
400	package urxvt;
401
402	use strict;
403	use Scalar::Util ();
404
405	our $TERM;
406	our @HOOKNAME;
407	our $LIBDIR;
408
409	BEGIN {	599	BEGIN {
410	urxvt->bootstrap;
411
412	# overwrite perl's warn	600	# overwrite perl's warn
413	*CORE::GLOBAL::warn = sub {	601	*CORE::GLOBAL::warn = sub {
414	my $msg = join "", @_;	602	my $msg = join "", @_;
415	$msg .= "\n"	603	$msg .= "\n"
416	unless $msg =~ /\n$/;	604	unless $msg =~ /\n$/;
417	urxvt::warn ($msg);	605	urxvt::warn ($msg);
418	};	606	};
419	}
420		607
421	my @hook_count;	608	# %ENV is the original startup environment
		609	delete $ENV{IFS};
		610	delete $ENV{CDPATH};
		611	delete $ENV{BASH_ENV};
		612	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
		613	}
		614
422	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	615	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
423		616
424	sub verbose {	617	sub verbose {
425	my ($level, $msg) = @_;	618	my ($level, $msg) = @_;
426	warn "$msg\n" if $level <= $verbosity;	619	warn "$msg\n" if $level <= $verbosity;
427	}	620	}
428		621
429	# find on_xxx subs in the package and register them
430	# as hooks
431	sub register_package($) {
432	my ($pkg) = @_;
433
434	for my $htype (0.. $#HOOKNAME) {
435	my $name = $HOOKNAME[$htype];
436
437	my $ref = $pkg->can ("on_" . lc $name)
438	or next;
439
440	$TERM->{_hook}[$htype]{$pkg} = $ref;
441	$hook_count[$htype]++
442	or set_should_invoke $htype, 1;
443	}
444	}
445
446	my $extension_pkg = "extension0000";
447	my %extension_pkg;	622	my %extension_pkg;
448		623
449	# load a single script into its own package, once only	624	# load a single script into its own package, once only
450	sub extension_package($) {	625	sub extension_package($) {
451	my ($path) = @_;	626	my ($path) = @_;
452		627
		628	no strict 'refs';
		629
453	$extension_pkg{$path} \|\|= do {	630	$extension_pkg{$path} \|\|= do {
454	my $pkg = "urxvt::" . ($extension_pkg++);	631	$path =~ /([^\/\\]+)$/;
		632	my $pkg = $1;
		633	$pkg =~ s/[^[:word:]]/_/g;
		634	$pkg = "urxvt::ext::$pkg";
455		635
456	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
457		637
458	open my $fh, "<:raw", $path	638	open my $fh, "<:raw", $path
459	or die "$path: $!";	639	or die "$path: $!";
460		640
		641	@{"$pkg\::ISA"} = urxvt::term::extension::;
		642
		643	my $source =
461	my $source = "package $pkg; use strict; use utf8;\n"	644	"package $pkg; use strict; use utf8;\n"
462	. "use base urxvt::term::proxy::;\n"
463	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
464	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
465	. "\n};\n1";	647	. "\n};\n1";
466		648
		649	eval $source
467	eval $source or die "$path: $@";	650	or die "$path: $@";
468		651
469	$pkg	652	$pkg
470	}	653	}
471	}	654	}
472		655
…		…
477	local $TERM = shift;	660	local $TERM = shift;
478	my $htype = shift;	661	my $htype = shift;
479		662
480	if ($htype == 0) { # INIT	663	if ($htype == 0) { # INIT
481	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		665
		666	my %ext_arg;
482		667
483	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	668	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		669	if ($_ eq "default") {
		670	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		671	} elsif (/^-(.*)$/) {
		672	delete $ext_arg{$1};
		673	} elsif (/^([^<]+)<(.*)>$/) {
		674	push @{ $ext_arg{$1} }, $2;
		675	} else {
		676	$ext_arg{$_} \|\|= [];
		677	}
		678	}
		679
		680	while (my ($ext, $argv) = each %ext_arg) {
484	my @files = grep -f $_, map "$_/$ext", @dirs;	681	my @files = grep -f $_, map "$_/$ext", @dirs;
485		682
486	if (@files) {	683	if (@files) {
487	register_package extension_package $files[0];	684	$TERM->register_package (extension_package $files[0], $argv);
488	} else {	685	} else {
489	warn "perl extension '$ext' not found in perl library search path\n";	686	warn "perl extension '$ext' not found in perl library search path\n";
490	}	687	}
491	}	688	}
		689
		690	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		691	warn $@ if $@;
492	}	692	}
493		693
494	$retval = undef;	694	$retval = undef;
495		695
496	if (my $cb = $TERM->{_hook}[$htype]) {	696	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
498	if $verbosity >= 10;	698	if $verbosity >= 10;
499		699
500	keys %$cb;	700	keys %$cb;
501		701
502	while (my ($pkg, $cb) = each %$cb) {	702	while (my ($pkg, $cb) = each %$cb) {
503	eval {	703	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
504	$retval = $cb->(
505	$TERM->{_pkg}{$pkg} \|\|= do {
506	my $proxy = bless { }, $pkg;
507	Scalar::Util::weaken ($proxy->{term} = $TERM);
508	$proxy
509	},
510	@_,
511	) and last;	704	and last;
512	};
513	warn $@ if $@;#d#
514	}
515	}
516		705
517	if ($htype == 1) { # DESTROY	706	if ($@) {
518	# remove hooks if unused	707	$TERM->ungrab; # better to lose the grab than the session
519	if (my $hook = $TERM->{_hook}) {	708	warn $@;
520	for my $htype (0..$#$hook) {
521	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
522	or set_should_invoke $htype, 0;
523	}	709	}
524	}	710	}
525		711
		712	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		713	if $verbosity >= 11;
		714	}
		715
		716	if ($htype == 1) { # DESTROY
526	# clear package objects	717	# clear package objects
527	%$_ = () for values %{ $TERM->{_pkg} };	718	%$_ = () for values %{ $TERM->{_pkg} };
528		719
529	# clear package	720	# clear package
530	%$TERM = ();	721	%$TERM = ();
531	}	722	}
532		723
533	$retval	724	$retval
534	}	725	}
535		726
536	sub urxvt::term::proxy::AUTOLOAD {	727	sub exec_async(@) {
537	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	728	my $pid = fork;
		729
		730	return
		731	if !defined $pid or $pid;
		732
		733	%ENV = %{ $TERM->env };
		734
		735	exec @_;
		736	_exit 255;
		737	}
		738
		739	# urxvt::term::extension
		740
		741	package urxvt::term::extension;
		742
		743	sub enable {
		744	my ($self, %hook) = @_;
		745	my $pkg = $self->{_pkg};
		746
		747	while (my ($name, $cb) = each %hook) {
		748	my $htype = $HOOKTYPE{uc $name};
		749	defined $htype
		750	or Carp::croak "unsupported hook type '$name'";
		751
		752	$self->set_should_invoke ($htype, +1)
		753	unless exists $self->{term}{_hook}[$htype]{$pkg};
		754
		755	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		756	}
		757	}
		758
		759	sub disable {
		760	my ($self, @hook) = @_;
		761	my $pkg = $self->{_pkg};
		762
		763	for my $name (@hook) {
		764	my $htype = $HOOKTYPE{uc $name};
		765	defined $htype
		766	or Carp::croak "unsupported hook type '$name'";
		767
		768	$self->set_should_invoke ($htype, -1)
		769	if delete $self->{term}{_hook}[$htype]{$pkg};
		770	}
		771	}
		772
		773	our $AUTOLOAD;
		774
		775	sub AUTOLOAD {
		776	$AUTOLOAD =~ /:([^:]+)$/
538	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	777	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
539		778
540	eval qq{	779	eval qq{
541	sub $urxvt::term::proxy::AUTOLOAD {	780	sub $AUTOLOAD {
542	my \$proxy = shift;	781	my \$proxy = shift;
543	\$proxy->{term}->$1 (\@_)	782	\$proxy->{term}->$1 (\@_)
544	}	783	}
545	1	784	1
546	} or die "FATAL: unable to compile method forwarder: $@";	785	} or die "FATAL: unable to compile method forwarder: $@";
547		786
548	goto &$urxvt::term::proxy::AUTOLOAD;	787	goto &$AUTOLOAD;
549	}	788	}
		789
		790	sub DESTROY {
		791	# nop
		792	}
		793
		794	# urxvt::destroy_hook
550		795
551	sub urxvt::destroy_hook::DESTROY {	796	sub urxvt::destroy_hook::DESTROY {
552	${$_[0]}->();	797	${$_[0]}->();
553	}	798	}
554		799
555	sub urxvt::destroy_hook(&) {	800	sub urxvt::destroy_hook(&) {
556	bless \shift, urxvt::destroy_hook::	801	bless \shift, urxvt::destroy_hook::
557	}	802	}
558		803
		804	package urxvt::anyevent;
		805
		806	=head2 The C<urxvt::anyevent> Class
		807
		808	The sole purpose of this class is to deliver an interface to the
		809	C<AnyEvent> module - any module using it will work inside urxvt without
		810	further programming. The only exception is that you cannot wait on
		811	condition variables, but non-blocking condvar use is ok. What this means
		812	is that you cannot use blocking APIs, but the non-blocking variant should
		813	work.
		814
		815	=cut
		816
		817	our $VERSION = 1;
		818
		819	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		820	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		821
		822	sub timer {
		823	my ($class, %arg) = @_;
		824
		825	my $cb = $arg{cb};
		826
		827	urxvt::timer
		828	->new
		829	->start (urxvt::NOW + $arg{after})
		830	->cb (sub {
		831	$_[0]->stop; # need to cancel manually
		832	$cb->();
		833	})
		834	}
		835
		836	sub io {
		837	my ($class, %arg) = @_;
		838
		839	my $cb = $arg{cb};
		840
		841	bless [$arg{fh}, urxvt::iow
		842	->new
		843	->fd (fileno $arg{fh})
		844	->events (($arg{poll} =~ /r/ ? 1 : 0)
		845	\| ($arg{poll} =~ /w/ ? 2 : 0))
		846	->start
		847	->cb (sub {
		848	$cb->(($_[1] & 1 ? 'r' : '')
		849	. ($_[1] & 2 ? 'w' : ''));
		850	})],
		851	urxvt::anyevent::
		852	}
		853
		854	sub DESTROY {
		855	$_[0][1]->stop;
		856	}
		857
		858	sub condvar {
		859	bless \my $flag, urxvt::anyevent::condvar::
		860	}
		861
		862	sub urxvt::anyevent::condvar::broadcast {
		863	${$_[0]}++;
		864	}
		865
		866	sub urxvt::anyevent::condvar::wait {
		867	unless (${$_[0]}) {
		868	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		869	}
		870	}
		871
		872	package urxvt::term;
		873
559	=head2 The C<urxvt::term> Class	874	=head2 The C<urxvt::term> Class
560		875
561	=over 4	876	=over 4
562		877
		878	=cut
		879
		880	# find on_xxx subs in the package and register them
		881	# as hooks
		882	sub register_package {
		883	my ($self, $pkg, $argv) = @_;
		884
		885	my $proxy = bless {
		886	_pkg => $pkg,
		887	argv => $argv,
		888	}, $pkg;
		889	Scalar::Util::weaken ($proxy->{term} = $self);
		890
		891	$self->{_pkg}{$pkg} = $proxy;
		892
		893	for my $name (@HOOKNAME) {
		894	if (my $ref = $pkg->can ("on_" . lc $name)) {
		895	$proxy->enable ($name => $ref);
		896	}
		897	}
		898	}
		899
		900	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		901
		902	Creates a new terminal, very similar as if you had started it with system
		903	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		904	hash which defines the environment of the new terminal.
		905
		906	Croaks (and probably outputs an error message) if the new instance
		907	couldn't be created. Returns C<undef> if the new instance didn't
		908	initialise perl, and the terminal object otherwise. The C<init> and
		909	C<start> hooks will be called during this call.
		910
		911	=cut
		912
		913	sub new {
		914	my ($class, $env, @args) = @_;
		915
		916	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		917	}
		918
563	=item $term->destroy	919	=item $term->destroy
564		920
565	Destroy the terminal object (close the window, free resources etc.).	921	Destroy the terminal object (close the window, free resources
		922	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		923	watchers (timers, io watchers) are still active.
		924
		925	=item $isset = $term->option ($optval[, $set])
		926
		927	Returns true if the option specified by C<$optval> is enabled, and
		928	optionally change it. All option values are stored by name in the hash
		929	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		930
		931	Here is a a likely non-exhaustive list of option names, please see the
		932	source file F</src/optinc.h> to see the actual list:
		933
		934	borderLess console cursorBlink cursorUnderline hold iconic insecure
		935	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		936	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		937	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		938	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		939	tripleclickwords utmpInhibit visualBell
566		940
567	=item $value = $term->resource ($name[, $newval])	941	=item $value = $term->resource ($name[, $newval])
568		942
569	Returns the current resource value associated with a given name and	943	Returns the current resource value associated with a given name and
570	optionally sets a new value. Setting values is most useful in the C<init>	944	optionally sets a new value. Setting values is most useful in the C<init>
…		…
580		954
581	Please note that resource strings will currently only be freed when the	955	Please note that resource strings will currently only be freed when the
582	terminal is destroyed, so changing options frequently will eat memory.	956	terminal is destroyed, so changing options frequently will eat memory.
583		957
584	Here is a a likely non-exhaustive list of resource names, not all of which	958	Here is a a likely non-exhaustive list of resource names, not all of which
585	are supported in every build, please see the source to see the actual	959	are supported in every build, please see the source file F</src/rsinc.h>
586	list:	960	to see the actual list:
587		961
588	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	962	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
589	borderLess color cursorBlink cursorUnderline cutchars delete_key	963	borderLess color cursorBlink cursorUnderline cutchars delete_key
590	display_name embed ext_bwidth fade font geometry hold iconName	964	display_name embed ext_bwidth fade font geometry hold iconName
591	imFont imLocale inputMethod insecure int_bwidth intensityStyles	965	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
598	shade term_name title transparent transparent_all tripleclickwords	972	shade term_name title transparent transparent_all tripleclickwords
599	utmpInhibit visualBell	973	utmpInhibit visualBell
600		974
601	=cut	975	=cut
602		976
603	sub urxvt::term::resource($$;$) {	977	sub resource($$;$) {
604	my ($self, $name) = (shift, shift);	978	my ($self, $name) = (shift, shift);
605	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	979	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
606	&urxvt::term::_resource	980	&urxvt::term::_resource
607	}	981	}
608		982
		983	=item $value = $term->x_resource ($pattern)
		984
		985	Returns the X-Resource for the given pattern, excluding the program or
		986	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		987	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		988	resource with that pattern exists.
		989
		990	This method should only be called during the C<on_start> hook, as there is
		991	only one resource database per display, and later invocations might return
		992	the wrong resources.
		993
		994	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		995
		996	Adds a keymap translation exactly as specified via a resource. See the
		997	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		998
609	=item $rend = $term->rstyle ([$new_rstyle])	999	=item $rend = $term->rstyle ([$new_rstyle])
610		1000
611	Return and optionally change the current rendition. Text that is output by	1001	Return and optionally change the current rendition. Text that is output by
612	the terminal application will use this style.	1002	the terminal application will use this style.
613		1003
…		…
623	=item ($row, $col) = $term->selection_end ([$row, $col])	1013	=item ($row, $col) = $term->selection_end ([$row, $col])
624		1014
625	Return the current values of the selection mark, begin or end positions,	1015	Return the current values of the selection mark, begin or end positions,
626	and optionally set them to new values.	1016	and optionally set them to new values.
627		1017
		1018	=item $term->selection_make ($eventtime[, $rectangular])
		1019
		1020	Tries to make a selection as set by C<selection_beg> and
		1021	C<selection_end>. If C<$rectangular> is true (default: false), a
		1022	rectangular selection will be made. This is the prefered function to make
		1023	a selection.
		1024
628	=item $success = $term->selection_grab ($eventtime)	1025	=item $success = $term->selection_grab ($eventtime)
629		1026
630	Try to request the primary selection from the server (for example, as set	1027	Try to request the primary selection text from the server (for example, as
631	by the next method).	1028	set by the next method). No visual feedback will be given. This function
		1029	is mostly useful from within C<on_sel_grab> hooks.
632		1030
633	=item $oldtext = $term->selection ([$newtext])	1031	=item $oldtext = $term->selection ([$newtext])
634		1032
635	Return the current selection text and optionally replace it by C<$newtext>.	1033	Return the current selection text and optionally replace it by C<$newtext>.
636		1034
637	#=item $term->overlay ($x, $y, $text)	1035	=item $term->overlay_simple ($x, $y, $text)
638	#	1036
639	#Create a simple multi-line overlay box. See the next method for details.	1037	Create a simple multi-line overlay box. See the next method for details.
640	#	1038
641	#=cut	1039	=cut
642	#	1040
643	#sub urxvt::term::scr_overlay {	1041	sub overlay_simple {
644	# my ($self, $x, $y, $text) = @_;	1042	my ($self, $x, $y, $text) = @_;
645	#	1043
646	# my @lines = split /\n/, $text;	1044	my @lines = split /\n/, $text;
647	#	1045
648	# my $w = 0;	1046	my $w = List::Util::max map $self->strwidth ($_), @lines;
649	# for (map $self->strwidth ($_), @lines) {	1047
650	# $w = $_ if $w < $_;
651	# }
652	#
653	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1048	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
654	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1049	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
655	#}	1050
		1051	$overlay
		1052	}
656		1053
657	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1054	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
658		1055
659	Create a new (empty) overlay at the given position with the given	1056	Create a new (empty) overlay at the given position with the given
660	width/height. C<$rstyle> defines the initial rendition style	1057	width/height. C<$rstyle> defines the initial rendition style
…		…
695	C<$event> I<must> be the event causing the menu to pop up (a button event,	1092	C<$event> I<must> be the event causing the menu to pop up (a button event,
696	currently).	1093	currently).
697		1094
698	=cut	1095	=cut
699		1096
700	sub urxvt::term::popup {	1097	sub popup {
701	my ($self, $event) = @_;	1098	my ($self, $event) = @_;
702		1099
703	$self->grab ($event->{time}, 1)	1100	$self->grab ($event->{time}, 1)
704	or return;	1101	or return;
705		1102
…		…
727		1124
728	=item $string = $term->locale_decode ($octets)	1125	=item $string = $term->locale_decode ($octets)
729		1126
730	Convert the given locale-encoded octets into a perl string.	1127	Convert the given locale-encoded octets into a perl string.
731		1128
		1129	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1130
		1131	XORs the rendition values in the given span with the provided value
		1132	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1133	refresh hooks to provide effects similar to the selection.
		1134
		1135	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1136
		1137	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1138	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1139	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1140	it instead. Both styles I<MUST NOT> contain font styles.
		1141
		1142	=item $term->scr_bell
		1143
		1144	Ring the bell!
		1145
732	=item $term->scr_add_lines ($string)	1146	=item $term->scr_add_lines ($string)
733		1147
734	Write the given text string to the screen, as if output by the application	1148	Write the given text string to the screen, as if output by the application
735	running inside the terminal. It may not contain command sequences (escape	1149	running inside the terminal. It may not contain command sequences (escape
736	codes), but is free to use line feeds, carriage returns and tabs. The	1150	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
750		1164
751	Write the octets given in C<$data> to the tty (i.e. as program input). To	1165	Write the octets given in C<$data> to the tty (i.e. as program input). To
752	pass characters instead of octets, you should convert your strings first	1166	pass characters instead of octets, you should convert your strings first
753	to the locale-specific encoding using C<< $term->locale_encode >>.	1167	to the locale-specific encoding using C<< $term->locale_encode >>.
754		1168
		1169	=item $old_events = $term->pty_ev_events ([$new_events])
		1170
		1171	Replaces the event mask of the pty watcher by the given event mask. Can
		1172	be used to suppress input and output handling to the pty/tty. See the
		1173	description of C<< urxvt::timer->events >>. Make sure to always restore
		1174	the previous value.
		1175
755	=item $windowid = $term->parent	1176	=item $windowid = $term->parent
756		1177
757	Return the window id of the toplevel window.	1178	Return the window id of the toplevel window.
758		1179
759	=item $windowid = $term->vt	1180	=item $windowid = $term->vt
760		1181
761	Return the window id of the terminal window.	1182	Return the window id of the terminal window.
762		1183
		1184	=item $term->vt_emask_add ($x_event_mask)
		1185
		1186	Adds the specified events to the vt event mask. Useful e.g. when you want
		1187	to receive pointer events all the times:
		1188
		1189	$term->vt_emask_add (urxvt::PointerMotionMask);
		1190
763	=item $window_width = $term->width	1191	=item $window_width = $term->width
764		1192
765	=item $window_height = $term->height	1193	=item $window_height = $term->height
766		1194
767	=item $font_width = $term->fwidth	1195	=item $font_width = $term->fwidth
…		…
780		1208
781	=item $max_scrollback = $term->saveLines	1209	=item $max_scrollback = $term->saveLines
782		1210
783	=item $nrow_plus_saveLines = $term->total_rows	1211	=item $nrow_plus_saveLines = $term->total_rows
784		1212
785	=item $lines_in_scrollback = $term->nsaved	1213	=item $topmost_scrollback_row = $term->top_row
786		1214
787	Return various integers describing terminal characteristics.	1215	Return various integers describing terminal characteristics.
		1216
		1217	=item $x_display = $term->display_id
		1218
		1219	Return the DISPLAY used by rxvt-unicode.
		1220
		1221	=item $lc_ctype = $term->locale
		1222
		1223	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1224
		1225	=item $env = $term->env
		1226
		1227	Returns a copy of the environment in effect for the terminal as a hashref
		1228	similar to C<\%ENV>.
		1229
		1230	=cut
		1231
		1232	sub env {
		1233	if (my $env = $_[0]->_env) {
		1234	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1235	} else {
		1236	+{ %ENV }
		1237	}
		1238	}
788		1239
789	=item $modifiermask = $term->ModLevel3Mask	1240	=item $modifiermask = $term->ModLevel3Mask
790		1241
791	=item $modifiermask = $term->ModMetaMask	1242	=item $modifiermask = $term->ModMetaMask
792		1243
…		…
795	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1246	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
796	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1247	AltGr), the meta key (often Alt) and the num lock key, if applicable.
797		1248
798	=item $view_start = $term->view_start ([$newvalue])	1249	=item $view_start = $term->view_start ([$newvalue])
799		1250
800	Returns the negative row number of the topmost line. Minimum value is	1251	Returns the row number of the topmost displayed line. Maximum value is
801	C<0>, which displays the normal terminal contents. Larger values scroll	1252	C<0>, which displays the normal terminal contents. Lower values scroll
802	this many lines into the scrollback buffer.	1253	this many lines into the scrollback buffer.
803		1254
804	=item $term->want_refresh	1255	=item $term->want_refresh
805		1256
806	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1257	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
885	Return the row number of the first/last row of the line, respectively.	1336	Return the row number of the first/last row of the line, respectively.
886		1337
887	=item $offset = $line->offset_of ($row, $col)	1338	=item $offset = $line->offset_of ($row, $col)
888		1339
889	Returns the character offset of the given row\|col pair within the logical	1340	Returns the character offset of the given row\|col pair within the logical
890	line.	1341	line. Works for rows outside the line, too, and returns corresponding
		1342	offsets outside the string.
891		1343
892	=item ($row, $col) = $line->coord_of ($offset)	1344	=item ($row, $col) = $line->coord_of ($offset)
893		1345
894	Translates a string offset into terminal coordinates again.	1346	Translates a string offset into terminal coordinates again.
895		1347
896	=back	1348	=back
897		1349
898	=cut	1350	=cut
899		1351
900	sub urxvt::term::line {	1352	sub line {
901	my ($self, $row) = @_;	1353	my ($self, $row) = @_;
902		1354
903	my $maxrow = $self->nrow - 1;	1355	my $maxrow = $self->nrow - 1;
904		1356
905	my ($beg, $end) = ($row, $row);	1357	my ($beg, $end) = ($row, $row);
…		…
969	$offset / $self->{ncol} + $self->{beg},	1421	$offset / $self->{ncol} + $self->{beg},
970	$offset % $self->{ncol}	1422	$offset % $self->{ncol}
971	)	1423	)
972	}	1424	}
973		1425
974	=item ($row, $col) = $line->coord_of ($offset)
975	=item $text = $term->special_encode $string	1426	=item $text = $term->special_encode $string
976		1427
977	Converts a perl string into the special encoding used by rxvt-unicode,	1428	Converts a perl string into the special encoding used by rxvt-unicode,
978	where one character corresponds to one screen cell. See	1429	where one character corresponds to one screen cell. See
979	C<< $term->ROW_t >> for details.	1430	C<< $term->ROW_t >> for details.
…		…
981	=item $string = $term->special_decode $text	1432	=item $string = $term->special_decode $text
982		1433
983	Converts rxvt-unicodes text reprsentation into a perl string. See	1434	Converts rxvt-unicodes text reprsentation into a perl string. See
984	C<< $term->ROW_t >> for details.	1435	C<< $term->ROW_t >> for details.
985		1436
		1437	=item $success = $term->grab_button ($button, $modifiermask)
		1438
		1439	Registers a synchronous button grab. See the XGrabButton manpage.
		1440
		1441	=item $success = $term->grab ($eventtime[, $sync])
		1442
		1443	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1444	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1445
		1446	=item $term->allow_events_async
		1447
		1448	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1449
		1450	=item $term->allow_events_sync
		1451
		1452	Calls XAllowEvents with SyncBoth for the most recent grab.
		1453
		1454	=item $term->allow_events_replay
		1455
		1456	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1457	recent grab.
		1458
		1459	=item $term->ungrab
		1460
		1461	Calls XUngrab for the most recent grab. Is called automatically on
		1462	evaluation errors, as it is better to lose the grab in the error case as
		1463	the session.
		1464
986	=back	1465	=back
987		1466
		1467	=cut
		1468
		1469	package urxvt::popup;
		1470
988	=head2 The C<urxvt::popup> Class	1471	=head2 The C<urxvt::popup> Class
989		1472
990	=over 4	1473	=over 4
991		1474
992	=cut	1475	=cut
993
994	package urxvt::popup;
995		1476
996	sub add_item {	1477	sub add_item {
997	my ($self, $item) = @_;	1478	my ($self, $item) = @_;
998		1479
		1480	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1481	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1482	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1483
		1484	$item->{render} \|\|= sub { $_[0]{text} };
		1485
999	push @{ $self->{item} }, $item;	1486	push @{ $self->{item} }, $item;
1000	}	1487	}
		1488
		1489	=item $popup->add_title ($title)
		1490
		1491	Adds a non-clickable title to the popup.
		1492
		1493	=cut
		1494
		1495	sub add_title {
		1496	my ($self, $title) = @_;
		1497
		1498	$self->add_item ({
		1499	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1500	text => $title,
		1501	activate => sub { },
		1502	});
		1503	}
		1504
		1505	=item $popup->add_separator ([$sepchr])
		1506
		1507	Creates a separator, optionally using the character given as C<$sepchr>.
		1508
		1509	=cut
		1510
		1511	sub add_separator {
		1512	my ($self, $sep) = @_;
		1513
		1514	$sep \|\|= "=";
		1515
		1516	$self->add_item ({
		1517	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1518	text => "",
		1519	render => sub { $sep x $self->{term}->ncol },
		1520	activate => sub { },
		1521	});
		1522	}
		1523
		1524	=item $popup->add_button ($text, $cb)
		1525
		1526	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1527	selected.
		1528
		1529	=cut
1001		1530
1002	sub add_button {	1531	sub add_button {
1003	my ($self, $text, $cb) = @_;	1532	my ($self, $text, $cb) = @_;
1004		1533
1005	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb });	1534	$self->add_item ({ type => "button", text => $text, activate => $cb});
1006	}	1535	}
		1536
		1537	=item $popup->add_toggle ($text, $cb, $initial_value)
		1538
		1539	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1540	whenever it gets toggled, with a boolean indicating its value as its first
		1541	argument.
		1542
		1543	=cut
		1544
		1545	sub add_toggle {
		1546	my ($self, $text, $cb, $value) = @_;
		1547
		1548	my $item; $item = {
		1549	type => "button",
		1550	text => " $text",
		1551	value => $value,
		1552	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1553	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1554	};
		1555
		1556	$self->add_item ($item);
		1557	}
		1558
		1559	=item $popup->show
		1560
		1561	Displays the popup (which is initially hidden).
		1562
		1563	=cut
1007		1564
1008	sub show {	1565	sub show {
1009	my ($self) = @_;	1566	my ($self) = @_;
1010		1567
1011	local $urxvt::popup::self = $self;	1568	local $urxvt::popup::self = $self;
1012		1569
		1570	my $env = $self->{term}->env;
		1571	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1572	delete $env->{LC_ALL};
		1573	$env->{LC_CTYPE} = $self->{term}->locale;
		1574
		1575	urxvt::term->new ($env, $self->{term}->resource ("name"),
1013	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1576	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1014	"--transient-for" => $self->{term}->parent,	1577	"--transient-for" => $self->{term}->parent,
		1578	"-display" => $self->{term}->display_id,
1015	"-pe" => "urxvt-popup")	1579	"-pe" => "urxvt-popup")
1016	or die "unable to create popup window\n";	1580	or die "unable to create popup window\n";
1017	}	1581	}
1018		1582
1019	sub DESTROY {	1583	sub DESTROY {
1020	my ($self) = @_;	1584	my ($self) = @_;
1021		1585
		1586	delete $self->{term}{_destroy}{$self};
1022	$self->{term}->ungrab;	1587	$self->{term}->ungrab;
1023	}	1588	}
		1589
		1590	=back
1024		1591
1025	=head2 The C<urxvt::timer> Class	1592	=head2 The C<urxvt::timer> Class
1026		1593
1027	This class implements timer watchers/events. Time is represented as a	1594	This class implements timer watchers/events. Time is represented as a
1028	fractional number of seconds since the epoch. Example:	1595	fractional number of seconds since the epoch. Example:
…		…
1081		1648
1082	$term->{socket} = ...	1649	$term->{socket} = ...
1083	$term->{iow} = urxvt::iow	1650	$term->{iow} = urxvt::iow
1084	->new	1651	->new
1085	->fd (fileno $term->{socket})	1652	->fd (fileno $term->{socket})
1086	->events (1) # wait for read data	1653	->events (urxvt::EVENT_READ)
1087	->start	1654	->start
1088	->cb (sub {	1655	->cb (sub {
1089	my ($iow, $revents) = @_;	1656	my ($iow, $revents) = @_;
1090	# $revents must be 1 here, no need to check	1657	# $revents must be 1 here, no need to check
1091	sysread $term->{socket}, my $buf, 8192	1658	sysread $term->{socket}, my $buf, 8192
…		…
1108		1675
1109	Set the filedescriptor (not handle) to watch.	1676	Set the filedescriptor (not handle) to watch.
1110		1677
1111	=item $iow = $iow->events ($eventmask)	1678	=item $iow = $iow->events ($eventmask)
1112		1679
1113	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1680	Set the event mask to watch. The only allowed values are
1114	data, Bit #1 (value C<2>) enables watching for write data.	1681	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1682	together, or C<urxvt::EVENT_NONE>.
1115		1683
1116	=item $iow = $iow->start	1684	=item $iow = $iow->start
1117		1685
1118	Start watching for requested events on the given handle.	1686	Start watching for requested events on the given handle.
1119		1687
…		…
1130	This variable controls the verbosity level of the perl extension. Higher	1698	This variable controls the verbosity level of the perl extension. Higher
1131	numbers indicate more verbose output.	1699	numbers indicate more verbose output.
1132		1700
1133	=over 4	1701	=over 4
1134		1702
1135	=item =0 - only fatal messages	1703	=item == 0 - fatal messages
1136		1704
1137	=item =3 - script loading and management	1705	=item >= 3 - script loading and management
1138		1706
1139	=item =10 - all events received	1707	=item >=10 - all called hooks
		1708
		1709	=item >=11 - hook reutrn values
1140		1710
1141	=back	1711	=back
1142		1712
1143	=head1 AUTHOR	1713	=head1 AUTHOR
1144		1714

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.47 by root, Sat Jan 7 21:22:02 2006 UTC vs. Revision 1.100 by root, Wed Jan 18 08:33:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.47 by root, Sat Jan 7 21:22:02 2006 UTC vs.
Revision 1.100 by root, Wed Jan 18 08:33:34 2006 UTC