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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.117 by ayin, Fri Jan 20 18:02:43 2006 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	Intelligent selection. This extension tries to be more intelligent when	48	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	49	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	50	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
49	It also offers the following bindable event:	54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the followign adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		71
		72	You can look at the source of the selection extension to see more
		73	interesting uses, such as parsing a line from beginning to end.
		74
		75	This extension also offers following bindable keyboard commands:
50		76
51	=over 4	77	=over 4
52		78
53	=item rot13	79	=item rot13
54		80
…		…
64	runtime.	90	runtime.
65		91
66	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
67		93
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	95	text into various other formats/action (such as uri unescaping, perl
		96	evaluation, web-browser starting etc.), depending on content.
70		97
71	=item digital-clock	98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
72		101
73	Displays a digital clock using the built-in overlay.	102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
		116
		117	=item searchable-scrollback<hotkey> (enabled by default)
		118
		119	Adds regex search functionality to the scrollback buffer, triggered
		120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		121	input/output is suspended and a regex is displayed at the bottom of the
		122	screen.
		123
		124	Inputting characters appends them to the regex and continues incremental
		125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		127	bottom. C<Escape> leaves search mode and returns to the point where search
		128	was started, while C<Enter> or C<Return> stay at the current position and
		129	additionally stores the first match in the current line into the primary
		130	selection.
		131
		132	=item selection-autotransform
		133
		134	This selection allows you to do automatic transforms on a selection
		135	whenever a selection is made.
		136
		137	It works by specifying perl snippets (most useful is a single C<s///>
		138	operator) that modify C<$_> as resources:
		139
		140	URxvt.selection-autotransform.0: transform
		141	URxvt.selection-autotransform.1: transform
		142	...
		143
		144	For example, the following will transform selections of the form
		145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		149
		150	And this example matches the same,but replaces it with vi-commands you can
		151	paste directly into your (vi :) editor:
		152
		153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
		166
		167	=item tabbed
		168
		169	This transforms the terminal into a tabbar with additional terminals, that
		170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		172	button per tab.
		173
		174	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		175	B<Shift-Right> will switch to the tab left or right of the current one,
		176	while B<Shift-Down> creates a new tab.
74		177
75	=item mark-urls	178	=item mark-urls
76		179
77	Uses per-line display filtering (C<on_line_update>) to underline urls.	180	Uses per-line display filtering (C<on_line_update>) to underline urls and
		181	make them clickable. When middle-clicked, the program specified in the
		182	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		183	the URL as first argument.
		184
		185	=item automove-background
		186
		187	This is basically a one-line extension that dynamically changes the background pixmap offset
		188	to the window position, in effect creating the same effect as pseudo transparency with
		189	a custom pixmap. No scaling is supported in this mode. Exmaple:
		190
		191	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
78		192
79	=item block-graphics-to-ascii	193	=item block-graphics-to-ascii
80		194
81	A not very useful example of filtering all text output to the terminal,	195	A not very useful example of filtering all text output to the terminal,
82	by replacing all line-drawing characters (U+2500 .. U+259F) by a	196	by replacing all line-drawing characters (U+2500 .. U+259F) by a
83	similar-looking ascii character.	197	similar-looking ascii character.
84		198
		199	=item digital-clock
		200
		201	Displays a digital clock using the built-in overlay.
		202
85	=item example-refresh-hooks	203	=item example-refresh-hooks
86		204
87	Displays a very simple digital clock in the upper right corner of the	205	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	206	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	207	overlays or changes.
90		208
		209	=item selection-pastebin
		210
		211	This is a little rarely useful extension that Uploads the selection as
		212	textfile to a remote site (or does other things). (The implementation is
		213	not currently secure for use in a multiuser environment as it writes to
		214	F</tmp> directly.).
		215
		216	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		217	i.e.
		218
		219	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		220
		221	Pressing this combination runs a command with C<%> replaced by the name of
		222	the textfile. This command can be set via a resource:
		223
		224	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		225
		226	And the default is likely not useful to anybody but the few people around
		227	here :)
		228
		229	The name of the textfile is the hex encoded md5 sum of the selection, so
		230	the same content should lead to the same filename.
		231
		232	After a successful upload the selection will be replaced by the text given
		233	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		234	for the filename):
		235
		236	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		237
91	=back	238	=back
		239
		240	=head1 API DOCUMENTATION
92		241
93	=head2 General API Considerations	242	=head2 General API Considerations
94		243
95	All objects (such as terminals, time watchers etc.) are typical	244	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	245	reference-to-hash objects. The hash can be used to store anything you
…		…
109	=over 4	258	=over 4
110		259
111	=item $text	260	=item $text
112		261
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	262	Rxvt-unicodes special way of encoding text, where one "unicode" character
114	always represents one screen cell. See L<row_t> for a discussion of this format.	263	always represents one screen cell. See L<ROW_t> for a discussion of this format.
115		264
116	=item $string	265	=item $string
117		266
118	A perl text string, with an emphasis on I<text>. It can store all unicode	267	A perl text string, with an emphasis on I<text>. It can store all unicode
119	characters and is to be distinguished with text encoded in a specific	268	characters and is to be distinguished with text encoded in a specific
…		…
124	Either binary data or - more common - a text string encoded in a	273	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	274	locale-specific way.
126		275
127	=back	276	=back
128		277
		278	=head2 Extension Objects
		279
		280	Very perl extension is a perl class. A separate perl object is created
		281	for each terminal and each extension and passed as the first parameter to
		282	hooks. So extensions can use their C<$self> object without having to think
		283	about other extensions, with the exception of methods and members that
		284	begin with an underscore character C<_>: these are reserved for internal
		285	use.
		286
		287	Although it isn't a C<urxvt::term> object, you can call all methods of the
		288	C<urxvt::term> class on this object.
		289
		290	It has the following methods and data members:
		291
		292	=over 4
		293
		294	=item $urxvt_term = $self->{term}
		295
		296	Returns the C<urxvt::term> object associated with this instance of the
		297	extension. This member I<must not> be changed in any way.
		298
		299	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		300
		301	Dynamically enable the given hooks (named without the C<on_> prefix) for
		302	this extension, replacing any previous hook. This is useful when you want
		303	to overwrite time-critical hooks only temporarily.
		304
		305	=item $self->disable ($hook_name[, $hook_name..])
		306
		307	Dynamically disable the given hooks.
		308
		309	=back
		310
129	=head2 Hooks	311	=head2 Hooks
130		312
131	The following subroutines can be declared in extension files, and will be	313	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	314	called whenever the relevant event happens.
133		315
134	The first argument passed to them is an object private to each terminal	316	The first argument passed to them is an extension oject as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	317	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		318
141	All of them must return a boolean value. If it is true, then the event	319	B<All> of these hooks must return a boolean value. If any of the called
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	320	hooks returns true, then the event counts as being I<consumed>, and the
143	and the relevant action might not be carried out by the C++ code.	321	relevant action might not be carried out by the C++ code.
144		322
145	When in doubt, return a false value (preferably C<()>).	323	I<< When in doubt, return a false value (preferably C<()>). >>
146		324
147	=over 4	325	=over 4
148		326
149	=item on_init $term	327	=item on_init $term
150		328
151	Called after a new terminal object has been initialized, but before	329	Called after a new terminal object has been initialized, but before
152	windows are created or the command gets run. Most methods are unsafe to	330	windows are created or the command gets run. Most methods are unsafe to
153	call or deliver senseless data, as terminal size and other characteristics	331	call or deliver senseless data, as terminal size and other characteristics
154	have not yet been determined. You can safely query and change resources,	332	have not yet been determined. You can safely query and change resources
155	though.	333	and options, though. For many purposes the C<on_start> hook is a better
		334	place.
		335
		336	=item on_start $term
		337
		338	Called at the very end of initialisation of a new terminal, just before
		339	trying to map (display) the toplevel and returning to the mainloop.
		340
		341	=item on_destroy $term
		342
		343	Called whenever something tries to destroy terminal, before doing anything
		344	yet. If this hook returns true, then destruction is skipped, but this is
		345	rarely a good idea.
156		346
157	=item on_reset $term	347	=item on_reset $term
158		348
159	Called after the screen is "reset" for any reason, such as resizing or	349	Called after the screen is "reset" for any reason, such as resizing or
160	control sequences. Here is where you can react on changes to size-related	350	control sequences. Here is where you can react on changes to size-related
161	variables.	351	variables.
162		352
163	=item on_start $term	353	=item on_child_start $term, $pid
164		354
165	Called at the very end of initialisation of a new terminal, just before	355	Called just after the child process has been C<fork>ed.
166	returning to the mainloop.	356
		357	=item on_child_exit $term, $status
		358
		359	Called just after the child process has exited. C<$status> is the status
		360	from C<waitpid>.
167		361
168	=item on_sel_make $term, $eventtime	362	=item on_sel_make $term, $eventtime
169		363
170	Called whenever a selection has been made by the user, but before the	364	Called whenever a selection has been made by the user, but before the
171	selection text is copied, so changes to the beginning, end or type of the	365	selection text is copied, so changes to the beginning, end or type of the
…		…
185	=item on_sel_extend $term	379	=item on_sel_extend $term
186		380
187	Called whenever the user tries to extend the selection (e.g. with a double	381	Called whenever the user tries to extend the selection (e.g. with a double
188	click) and is either supposed to return false (normal operation), or	382	click) and is either supposed to return false (normal operation), or
189	should extend the selection itelf and return true to suppress the built-in	383	should extend the selection itelf and return true to suppress the built-in
190	processing.	384	processing. This can happen multiple times, as long as the callback
		385	returns true, it will be called on every further click by the user and is
		386	supposed to enlarge the selection more and more, if possible.
191		387
192	See the F<selection> example extension.	388	See the F<selection> example extension.
193		389
194	=item on_view_change $term, $offset	390	=item on_view_change $term, $offset
195		391
…		…
226	can filter/change and output the text yourself by returning a true value	422	can filter/change and output the text yourself by returning a true value
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	423	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	424	might be very slow, however, as your hook is called for B<all> text being
229	output.	425	output.
230		426
		427	=item on_tt_write $term, $octets
		428
		429	Called whenever some data is written to the tty/pty and can be used to
		430	suppress or filter tty input.
		431
231	=item on_line_update $term, $row	432	=item on_line_update $term, $row
232		433
233	Called whenever a line was updated or changed. Can be used to filter	434	Called whenever a line was updated or changed. Can be used to filter
234	screen output (e.g. underline urls or other useless stuff). Only lines	435	screen output (e.g. underline urls or other useless stuff). Only lines
235	that are being shown will be filtered, and, due to performance reasons,	436	that are being shown will be filtered, and, due to performance reasons,
…		…
257		458
258	Called whenever the user presses a key combination that has a	459	Called whenever the user presses a key combination that has a
259	C<perl:string> action bound to it (see description of the B<keysym>	460	C<perl:string> action bound to it (see description of the B<keysym>
260	resource in the @@RXVT_NAME@@(1) manpage).	461	resource in the @@RXVT_NAME@@(1) manpage).
261		462
		463	=item on_x_event $term, $event
		464
		465	Called on every X event received on the vt window (and possibly other
		466	windows). Should only be used as a last resort. Most event structure
		467	members are not passed.
		468
262	=item on_focus_in $term	469	=item on_focus_in $term
263		470
264	Called whenever the window gets the keyboard focus, before rxvt-unicode	471	Called whenever the window gets the keyboard focus, before rxvt-unicode
265	does focus in processing.	472	does focus in processing.
266		473
267	=item on_focus_out $term	474	=item on_focus_out $term
268		475
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	476	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	477	focus out processing.
271		478
		479	=item on_configure_notify $term, $event
		480
272	=item on_key_press $term, $event, $octets	481	=item on_key_press $term, $event, $keysym, $octets
273		482
274	=item on_key_release $term, $event	483	=item on_key_release $term, $event, $keysym
275		484
276	=item on_button_press $term, $event	485	=item on_button_press $term, $event
277		486
278	=item on_button_release $term, $event	487	=item on_button_release $term, $event
279		488
…		…
293	C<on_key_press> additionally receives the string rxvt-unicode would	502	C<on_key_press> additionally receives the string rxvt-unicode would
294	output, if any, in locale-specific encoding.	503	output, if any, in locale-specific encoding.
295		504
296	subwindow.	505	subwindow.
297		506
		507	=item on_client_message $term, $event
		508
		509	=item on_wm_protocols $term, $event
		510
		511	=item on_wm_delete_window $term, $event
		512
		513	Called when various types of ClientMessage events are received (all with
		514	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		515
298	=back	516	=back
299		517
		518	=cut
		519
		520	package urxvt;
		521
		522	use utf8;
		523	use strict;
		524	use Carp ();
		525	use Scalar::Util ();
		526	use List::Util ();
		527
		528	our $VERSION = 1;
		529	our $TERM;
		530	our @TERM_INIT;
		531	our @TERM_EXT;
		532	our @HOOKNAME;
		533	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		534	our %OPTION;
		535
		536	our $LIBDIR;
		537	our $RESNAME;
		538	our $RESCLASS;
		539	our $RXVTNAME;
		540
300	=head2 Variables in the C<urxvt> Package	541	=head2 Variables in the C<urxvt> Package
301		542
302	=over 4	543	=over 4
		544
		545	=item $urxvt::LIBDIR
		546
		547	The rxvt-unicode library directory, where, among other things, the perl
		548	modules and scripts are stored.
		549
		550	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		551
		552	The resource class and name rxvt-unicode uses to look up X resources.
		553
		554	=item $urxvt::RXVTNAME
		555
		556	The basename of the installed binaries, usually C<urxvt>.
303		557
304	=item $urxvt::TERM	558	=item $urxvt::TERM
305		559
306	The current terminal. This variable stores the current C<urxvt::term>	560	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	561	object, whenever a callback/hook is executing.
308		562
		563	=item @urxvt::TERM_INIT
		564
		565	All coderefs in this array will be called as methods of the next newly
		566	created C<urxvt::term> object (during the C<on_init> phase). The array
		567	gets cleared before the codereferences that were in it are being executed,
		568	so coderefs can push themselves onto it again if they so desire.
		569
		570	This complements to the perl-eval commandline option, but gets executed
		571	first.
		572
		573	=item @urxvt::TERM_EXT
		574
		575	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		576	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		577	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		578
309	=back	579	=back
310		580
311	=head2 Functions in the C<urxvt> Package	581	=head2 Functions in the C<urxvt> Package
312		582
313	=over 4	583	=over 4
314
315	=item $term = new urxvt [arg...]
316
317	Creates a new terminal, very similar as if you had started it with
318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319	if the new instance couldn't be created. Returns C<undef> if the new
320	instance didn't initialise perl, and the terminal object otherwise. The
321	C<init> and C<start> hooks will be called during the call.
322		584
323	=item urxvt::fatal $errormessage	585	=item urxvt::fatal $errormessage
324		586
325	Fatally aborts execution with the given error message. Avoid at all	587	Fatally aborts execution with the given error message. Avoid at all
326	costs! The only time this is acceptable is when the terminal process	588	costs! The only time this is acceptable is when the terminal process
…		…
333	that calls this function.	595	that calls this function.
334		596
335	Using this function has the advantage that its output ends up in the	597	Using this function has the advantage that its output ends up in the
336	correct place, e.g. on stderr of the connecting urxvtc client.	598	correct place, e.g. on stderr of the connecting urxvtc client.
337		599
		600	Messages have a size limit of 1023 bytes currently.
		601
338	=item $time = urxvt::NOW	602	=item $time = urxvt::NOW
339		603
340	Returns the "current time" (as per the event loop).	604	Returns the "current time" (as per the event loop).
341		605
342	=item urxvt::CurrentTime	606	=item urxvt::CurrentTime
343		607
344	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	608	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
345	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	609	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
346	Button4Mask, Button5Mask, AnyModifier	610	Button4Mask, Button5Mask, AnyModifier
		611
		612	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		613	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		614	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		615	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		616	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		617	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		618	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		619
		620	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		621	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		622	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		623	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		624	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		625	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		626	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
347		627
348	Various constants for use in X calls and event processing.	628	Various constants for use in X calls and event processing.
349		629
350	=back	630	=back
351		631
…		…
380		660
381	=item $background = urxvt::GET_BASEBG $rend	661	=item $background = urxvt::GET_BASEBG $rend
382		662
383	Return the foreground/background colour index, respectively.	663	Return the foreground/background colour index, respectively.
384		664
385	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	665	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
386		666
387	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	667	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
388		668
389	Replace the foreground/background colour in the rendition mask with the	669	Replace the foreground/background colour in the rendition mask with the
390	specified one.	670	specified one.
391		671
392	=item $value = urxvt::GET_CUSTOM ($rend)	672	=item $value = urxvt::GET_CUSTOM $rend
393		673
394	Return the "custom" value: Every rendition has 5 bits for use by	674	Return the "custom" value: Every rendition has 5 bits for use by
395	extensions. They can be set and changed as you like and are initially	675	extensions. They can be set and changed as you like and are initially
396	zero.	676	zero.
397		677
398	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	678	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
399		679
400	Change the custom value.	680	Change the custom value.
401		681
402	=back	682	=back
403		683
404	=cut	684	=cut
405		685
406	package urxvt;
407
408	use utf8;
409	use strict;
410	use Scalar::Util ();
411	use List::Util ();
412
413	our $VERSION = 1;
414	our $TERM;
415	our @HOOKNAME;
416	our %OPTION;
417	our $LIBDIR;
418
419	BEGIN {	686	BEGIN {
420	urxvt->bootstrap;
421
422	# overwrite perl's warn	687	# overwrite perl's warn
423	*CORE::GLOBAL::warn = sub {	688	*CORE::GLOBAL::warn = sub {
424	my $msg = join "", @_;	689	my $msg = join "", @_;
425	$msg .= "\n"	690	$msg .= "\n"
426	unless $msg =~ /\n$/;	691	unless $msg =~ /\n$/;
427	urxvt::warn ($msg);	692	urxvt::warn ($msg);
428	};	693	};
429
430	delete $ENV{IFS};
431	delete $ENV{CDPATH};
432	delete $ENV{BASH_ENV};
433	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
434	}	694	}
435		695
436	my @hook_count;
437	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	696	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
438		697
439	sub verbose {	698	sub verbose {
440	my ($level, $msg) = @_;	699	my ($level, $msg) = @_;
441	warn "$msg\n" if $level <= $verbosity;	700	warn "$msg\n" if $level <= $verbosity;
442	}	701	}
443		702
444	# find on_xxx subs in the package and register them
445	# as hooks
446	sub register_package($) {
447	my ($pkg) = @_;
448
449	for my $htype (0.. $#HOOKNAME) {
450	my $name = $HOOKNAME[$htype];
451
452	my $ref = $pkg->can ("on_" . lc $name)
453	or next;
454
455	$TERM->{_hook}[$htype]{$pkg} = $ref;
456	$hook_count[$htype]++
457	or set_should_invoke $htype, 1;
458	}
459	}
460
461	my $extension_pkg = "extension0000";
462	my %extension_pkg;	703	my %extension_pkg;
463		704
464	# load a single script into its own package, once only	705	# load a single script into its own package, once only
465	sub extension_package($) {	706	sub extension_package($) {
466	my ($path) = @_;	707	my ($path) = @_;
467		708
468	$extension_pkg{$path} \|\|= do {	709	$extension_pkg{$path} \|\|= do {
469	my $pkg = "urxvt::" . ($extension_pkg++);	710	$path =~ /([^\/\\]+)$/;
		711	my $pkg = $1;
		712	$pkg =~ s/[^[:word:]]/_/g;
		713	$pkg = "urxvt::ext::$pkg";
470		714
471	verbose 3, "loading extension '$path' into package '$pkg'";	715	verbose 3, "loading extension '$path' into package '$pkg'";
472		716
473	open my $fh, "<:raw", $path	717	open my $fh, "<:raw", $path
474	or die "$path: $!";	718	or die "$path: $!";
475		719
		720	my $source =
476	my $source = untaint "package $pkg; use strict; use utf8;\n"	721	"package $pkg; use strict; use utf8;\n"
477	. "use base urxvt::term::proxy::;\n"
478	. "#line 1 \"$path\"\n{\n"	722	. "#line 1 \"$path\"\n{\n"
479	. (do { local $/; <$fh> })	723	. (do { local $/; <$fh> })
480	. "\n};\n1";	724	. "\n};\n1";
481		725
		726	eval $source
482	eval $source or die "$path: $@";	727	or die "$path: $@";
483		728
484	$pkg	729	$pkg
485	}	730	}
486	}	731	}
487		732
…		…
493	my $htype = shift;	738	my $htype = shift;
494		739
495	if ($htype == 0) { # INIT	740	if ($htype == 0) { # INIT
496	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	741	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
497		742
498	my %want_ext;	743	my %ext_arg;
499		744
		745	{
		746	my @init = @TERM_INIT;
		747	@TERM_INIT = ();
		748	$_->($TERM) for @init;
		749	my @pkg = @TERM_EXT;
		750	@TERM_EXT = ();
		751	$TERM->register_package ($_) for @pkg;
		752	}
		753
500	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	754	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
501	if ($_ eq "default") {	755	if ($_ eq "default") {
502	$want_ext{$_}++ for qw(selection option-popup selection-popup);	756	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
503	} elsif (/^-(.*)$/) {	757	} elsif (/^-(.*)$/) {
504	delete $want_ext{$1};	758	delete $ext_arg{$1};
		759	} elsif (/^([^<]+)<(.*)>$/) {
		760	push @{ $ext_arg{$1} }, $2;
505	} else {	761	} else {
506	$want_ext{$_}++;	762	$ext_arg{$_} \|\|= [];
507	}	763	}
508	}	764	}
509		765
510	for my $ext (keys %want_ext) {	766	while (my ($ext, $argv) = each %ext_arg) {
511	my @files = grep -f $_, map "$_/$ext", @dirs;	767	my @files = grep -f $_, map "$_/$ext", @dirs;
512		768
513	if (@files) {	769	if (@files) {
514	register_package extension_package $files[0];	770	$TERM->register_package (extension_package $files[0], $argv);
515	} else {	771	} else {
516	warn "perl extension '$ext' not found in perl library search path\n";	772	warn "perl extension '$ext' not found in perl library search path\n";
517	}	773	}
518	}	774	}
519		775
…		…
528	if $verbosity >= 10;	784	if $verbosity >= 10;
529		785
530	keys %$cb;	786	keys %$cb;
531		787
532	while (my ($pkg, $cb) = each %$cb) {	788	while (my ($pkg, $cb) = each %$cb) {
533	eval {	789	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
534	$retval = $cb->(	790	$retval \|\|= $retval_;
535	$TERM->{_pkg}{$pkg} \|\|= do {	791
536	my $proxy = bless { }, $pkg;
537	Scalar::Util::weaken ($proxy->{term} = $TERM);
538	$proxy
539	},
540	@_,
541	) and last;
542	};
543	if ($@) {	792	if ($@) {
544	$TERM->ungrab; # better to lose the grab than the session	793	$TERM->ungrab; # better to lose the grab than the session
545	warn $@;	794	warn $@;
546	}	795	}
547	}	796	}
		797
		798	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		799	if $verbosity >= 11;
548	}	800	}
549		801
550	if ($htype == 1) { # DESTROY	802	if ($htype == 1) { # DESTROY
551	# remove hooks if unused
552	if (my $hook = $TERM->{_hook}) {
553	for my $htype (0..$#$hook) {
554	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
555	or set_should_invoke $htype, 0;
556	}
557	}
558
559	# clear package objects	803	# clear package objects
560	%$_ = () for values %{ $TERM->{_pkg} };	804	%$_ = () for values %{ $TERM->{_pkg} };
561		805
562	# clear package	806	# clear package
563	%$TERM = ();	807	%$TERM = ();
564	}	808	}
565		809
566	$retval	810	$retval
567	}	811	}
568		812
569	# urxvt::term::proxy	813	# urxvt::term::extension
570		814
571	sub urxvt::term::proxy::AUTOLOAD {	815	package urxvt::term::extension;
572	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	816
		817	sub enable {
		818	my ($self, %hook) = @_;
		819	my $pkg = $self->{_pkg};
		820
		821	while (my ($name, $cb) = each %hook) {
		822	my $htype = $HOOKTYPE{uc $name};
		823	defined $htype
		824	or Carp::croak "unsupported hook type '$name'";
		825
		826	$self->set_should_invoke ($htype, +1)
		827	unless exists $self->{term}{_hook}[$htype]{$pkg};
		828
		829	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		830	}
		831	}
		832
		833	sub disable {
		834	my ($self, @hook) = @_;
		835	my $pkg = $self->{_pkg};
		836
		837	for my $name (@hook) {
		838	my $htype = $HOOKTYPE{uc $name};
		839	defined $htype
		840	or Carp::croak "unsupported hook type '$name'";
		841
		842	$self->set_should_invoke ($htype, -1)
		843	if delete $self->{term}{_hook}[$htype]{$pkg};
		844	}
		845	}
		846
		847	our $AUTOLOAD;
		848
		849	sub AUTOLOAD {
		850	$AUTOLOAD =~ /:([^:]+)$/
573	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	851	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
574		852
575	eval qq{	853	eval qq{
576	sub $urxvt::term::proxy::AUTOLOAD {	854	sub $AUTOLOAD {
577	my \$proxy = shift;	855	my \$proxy = shift;
578	\$proxy->{term}->$1 (\@_)	856	\$proxy->{term}->$1 (\@_)
579	}	857	}
580	1	858	1
581	} or die "FATAL: unable to compile method forwarder: $@";	859	} or die "FATAL: unable to compile method forwarder: $@";
582		860
583	goto &$urxvt::term::proxy::AUTOLOAD;	861	goto &$AUTOLOAD;
584	}	862	}
585		863
586	sub urxvt::term::proxy::DESTROY {	864	sub DESTROY {
587	# nop	865	# nop
588	}	866	}
589		867
590	# urxvt::destroy_hook	868	# urxvt::destroy_hook
591		869
…		…
601		879
602	=head2 The C<urxvt::anyevent> Class	880	=head2 The C<urxvt::anyevent> Class
603		881
604	The sole purpose of this class is to deliver an interface to the	882	The sole purpose of this class is to deliver an interface to the
605	C<AnyEvent> module - any module using it will work inside urxvt without	883	C<AnyEvent> module - any module using it will work inside urxvt without
606	further work. The only exception is that you cannot wait on condition	884	further programming. The only exception is that you cannot wait on
607	variables, but non-blocking condvar use is ok. What this means is that you	885	condition variables, but non-blocking condvar use is ok. What this means
608	cannot use blocking APIs, but the non-blocking variant should work.	886	is that you cannot use blocking APIs, but the non-blocking variant should
		887	work.
609		888
610	=cut	889	=cut
611		890
612	our $VERSION = 1;	891	our $VERSION = 1;
613		892
…		…
658	${$_[0]}++;	937	${$_[0]}++;
659	}	938	}
660		939
661	sub urxvt::anyevent::condvar::wait {	940	sub urxvt::anyevent::condvar::wait {
662	unless (${$_[0]}) {	941	unless (${$_[0]}) {
663	require Carp;
664	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	942	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
665	}	943	}
666	}	944	}
667		945
668	package urxvt::term;	946	package urxvt::term;
669		947
670	=head2 The C<urxvt::term> Class	948	=head2 The C<urxvt::term> Class
671		949
672	=over 4	950	=over 4
673		951
		952	=cut
		953
		954	# find on_xxx subs in the package and register them
		955	# as hooks
		956	sub register_package {
		957	my ($self, $pkg, $argv) = @_;
		958
		959	no strict 'refs';
		960
		961	urxvt::verbose 6, "register package $pkg to $self";
		962
		963	@{"$pkg\::ISA"} = urxvt::term::extension::;
		964
		965	my $proxy = bless {
		966	_pkg => $pkg,
		967	argv => $argv,
		968	}, $pkg;
		969	Scalar::Util::weaken ($proxy->{term} = $self);
		970
		971	$self->{_pkg}{$pkg} = $proxy;
		972
		973	for my $name (@HOOKNAME) {
		974	if (my $ref = $pkg->can ("on_" . lc $name)) {
		975	$proxy->enable ($name => $ref);
		976	}
		977	}
		978	}
		979
		980	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		981
		982	Creates a new terminal, very similar as if you had started it with system
		983	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		984	hash which defines the environment of the new terminal.
		985
		986	Croaks (and probably outputs an error message) if the new instance
		987	couldn't be created. Returns C<undef> if the new instance didn't
		988	initialise perl, and the terminal object otherwise. The C<init> and
		989	C<start> hooks will be called during this call.
		990
		991	=cut
		992
		993	sub new {
		994	my ($class, $env, @args) = @_;
		995
		996	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		997	}
		998
674	=item $term->destroy	999	=item $term->destroy
675		1000
676	Destroy the terminal object (close the window, free resources etc.).	1001	Destroy the terminal object (close the window, free resources
		1002	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1003	watchers (timers, io watchers) are still active.
		1004
		1005	=item $term->exec_async ($cmd[, @args])
		1006
		1007	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1008	("starts") programs in the background. This function takes care of setting
		1009	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1010	be preferred over explicit calls to C<exec> or C<system>.
		1011
		1012	Returns the pid of the subprocess or C<undef> on error.
		1013
		1014	=cut
		1015
		1016	sub exec_async {
		1017	my $self = shift;
		1018
		1019	my $pid = fork;
		1020
		1021	return $pid
		1022	if !defined $pid or $pid;
		1023
		1024	%ENV = %{ $self->env };
		1025
		1026	exec @_;
		1027	urxvt::_exit 255;
		1028	}
677		1029
678	=item $isset = $term->option ($optval[, $set])	1030	=item $isset = $term->option ($optval[, $set])
679		1031
680	Returns true if the option specified by C<$optval> is enabled, and	1032	Returns true if the option specified by C<$optval> is enabled, and
681	optionally change it. All option values are stored by name in the hash	1033	optionally change it. All option values are stored by name in the hash
…		…
684	Here is a a likely non-exhaustive list of option names, please see the	1036	Here is a a likely non-exhaustive list of option names, please see the
685	source file F</src/optinc.h> to see the actual list:	1037	source file F</src/optinc.h> to see the actual list:
686		1038
687	borderLess console cursorBlink cursorUnderline hold iconic insecure	1039	borderLess console cursorBlink cursorUnderline hold iconic insecure
688	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1040	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
689	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1041	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
690	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1042	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
691	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1043	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
692	tripleclickwords utmpInhibit visualBell	1044	transparent tripleclickwords utmpInhibit visualBell
693		1045
694	=item $value = $term->resource ($name[, $newval])	1046	=item $value = $term->resource ($name[, $newval])
695		1047
696	Returns the current resource value associated with a given name and	1048	Returns the current resource value associated with a given name and
697	optionally sets a new value. Setting values is most useful in the C<init>	1049	optionally sets a new value. Setting values is most useful in the C<init>
…		…
714		1066
715	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1067	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
716	borderLess color cursorBlink cursorUnderline cutchars delete_key	1068	borderLess color cursorBlink cursorUnderline cutchars delete_key
717	display_name embed ext_bwidth fade font geometry hold iconName	1069	display_name embed ext_bwidth fade font geometry hold iconName
718	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1070	imFont imLocale inputMethod insecure int_bwidth intensityStyles
719	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1071	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
720	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1072	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
721	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1073	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
722	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1074	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
723	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1075	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
724	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1076	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
725	shade term_name title transparent transparent_all tripleclickwords	1077	secondaryScreen secondaryScroll selectstyle shade term_name title
726	utmpInhibit visualBell	1078	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1079	visualBell
727		1080
728	=cut	1081	=cut
729		1082
730	sub resource($$;$) {	1083	sub resource($$;$) {
731	my ($self, $name) = (shift, shift);	1084	my ($self, $name) = (shift, shift);
732	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1085	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
733	&urxvt::term::_resource	1086	&urxvt::term::_resource
734	}	1087	}
735		1088
		1089	=item $value = $term->x_resource ($pattern)
		1090
		1091	Returns the X-Resource for the given pattern, excluding the program or
		1092	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1093	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1094	resource with that pattern exists.
		1095
		1096	This method should only be called during the C<on_start> hook, as there is
		1097	only one resource database per display, and later invocations might return
		1098	the wrong resources.
		1099
		1100	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1101
		1102	Adds a keymap translation exactly as specified via a resource. See the
		1103	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1104
736	=item $rend = $term->rstyle ([$new_rstyle])	1105	=item $rend = $term->rstyle ([$new_rstyle])
737		1106
738	Return and optionally change the current rendition. Text that is output by	1107	Return and optionally change the current rendition. Text that is output by
739	the terminal application will use this style.	1108	the terminal application will use this style.
740		1109
…		…
750	=item ($row, $col) = $term->selection_end ([$row, $col])	1119	=item ($row, $col) = $term->selection_end ([$row, $col])
751		1120
752	Return the current values of the selection mark, begin or end positions,	1121	Return the current values of the selection mark, begin or end positions,
753	and optionally set them to new values.	1122	and optionally set them to new values.
754		1123
		1124	=item $term->selection_make ($eventtime[, $rectangular])
		1125
		1126	Tries to make a selection as set by C<selection_beg> and
		1127	C<selection_end>. If C<$rectangular> is true (default: false), a
		1128	rectangular selection will be made. This is the prefered function to make
		1129	a selection.
		1130
755	=item $success = $term->selection_grab ($eventtime)	1131	=item $success = $term->selection_grab ($eventtime)
756		1132
757	Try to request the primary selection from the server (for example, as set	1133	Try to request the primary selection text from the server (for example, as
758	by the next method).	1134	set by the next method). No visual feedback will be given. This function
		1135	is mostly useful from within C<on_sel_grab> hooks.
759		1136
760	=item $oldtext = $term->selection ([$newtext])	1137	=item $oldtext = $term->selection ([$newtext])
761		1138
762	Return the current selection text and optionally replace it by C<$newtext>.	1139	Return the current selection text and optionally replace it by C<$newtext>.
763		1140
764	#=item $term->overlay ($x, $y, $text)	1141	=item $term->overlay_simple ($x, $y, $text)
765	#	1142
766	#Create a simple multi-line overlay box. See the next method for details.	1143	Create a simple multi-line overlay box. See the next method for details.
767	#	1144
768	#=cut	1145	=cut
769	#	1146
770	#sub urxvt::term::scr_overlay {	1147	sub overlay_simple {
771	# my ($self, $x, $y, $text) = @_;	1148	my ($self, $x, $y, $text) = @_;
772	#	1149
773	# my @lines = split /\n/, $text;	1150	my @lines = split /\n/, $text;
774	#	1151
775	# my $w = 0;	1152	my $w = List::Util::max map $self->strwidth ($_), @lines;
776	# for (map $self->strwidth ($_), @lines) {	1153
777	# $w = $_ if $w < $_;
778	# }
779	#
780	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1154	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
781	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1155	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
782	#}	1156
		1157	$overlay
		1158	}
783		1159
784	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1160	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
785		1161
786	Create a new (empty) overlay at the given position with the given	1162	Create a new (empty) overlay at the given position with the given
787	width/height. C<$rstyle> defines the initial rendition style	1163	width/height. C<$rstyle> defines the initial rendition style
…		…
854		1230
855	=item $string = $term->locale_decode ($octets)	1231	=item $string = $term->locale_decode ($octets)
856		1232
857	Convert the given locale-encoded octets into a perl string.	1233	Convert the given locale-encoded octets into a perl string.
858		1234
		1235	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1236
		1237	XORs the rendition values in the given span with the provided value
		1238	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1239	refresh hooks to provide effects similar to the selection.
		1240
		1241	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1242
		1243	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1244	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1245	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1246	it instead. Both styles I<MUST NOT> contain font styles.
		1247
		1248	=item $term->scr_bell
		1249
		1250	Ring the bell!
		1251
859	=item $term->scr_add_lines ($string)	1252	=item $term->scr_add_lines ($string)
860		1253
861	Write the given text string to the screen, as if output by the application	1254	Write the given text string to the screen, as if output by the application
862	running inside the terminal. It may not contain command sequences (escape	1255	running inside the terminal. It may not contain command sequences (escape
863	codes), but is free to use line feeds, carriage returns and tabs. The	1256	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
877		1270
878	Write the octets given in C<$data> to the tty (i.e. as program input). To	1271	Write the octets given in C<$data> to the tty (i.e. as program input). To
879	pass characters instead of octets, you should convert your strings first	1272	pass characters instead of octets, you should convert your strings first
880	to the locale-specific encoding using C<< $term->locale_encode >>.	1273	to the locale-specific encoding using C<< $term->locale_encode >>.
881		1274
		1275	=item $old_events = $term->pty_ev_events ([$new_events])
		1276
		1277	Replaces the event mask of the pty watcher by the given event mask. Can
		1278	be used to suppress input and output handling to the pty/tty. See the
		1279	description of C<< urxvt::timer->events >>. Make sure to always restore
		1280	the previous value.
		1281
882	=item $windowid = $term->parent	1282	=item $windowid = $term->parent
883		1283
884	Return the window id of the toplevel window.	1284	Return the window id of the toplevel window.
885		1285
886	=item $windowid = $term->vt	1286	=item $windowid = $term->vt
887		1287
888	Return the window id of the terminal window.	1288	Return the window id of the terminal window.
889		1289
		1290	=item $term->vt_emask_add ($x_event_mask)
		1291
		1292	Adds the specified events to the vt event mask. Useful e.g. when you want
		1293	to receive pointer events all the times:
		1294
		1295	$term->vt_emask_add (urxvt::PointerMotionMask);
		1296
890	=item $window_width = $term->width	1297	=item $window_width = $term->width
891		1298
892	=item $window_height = $term->height	1299	=item $window_height = $term->height
893		1300
894	=item $font_width = $term->fwidth	1301	=item $font_width = $term->fwidth
…		…
907		1314
908	=item $max_scrollback = $term->saveLines	1315	=item $max_scrollback = $term->saveLines
909		1316
910	=item $nrow_plus_saveLines = $term->total_rows	1317	=item $nrow_plus_saveLines = $term->total_rows
911		1318
912	=item $lines_in_scrollback = $term->nsaved	1319	=item $topmost_scrollback_row = $term->top_row
913		1320
914	Return various integers describing terminal characteristics.	1321	Return various integers describing terminal characteristics.
		1322
		1323	=item $x_display = $term->display_id
		1324
		1325	Return the DISPLAY used by rxvt-unicode.
		1326
		1327	=item $lc_ctype = $term->locale
		1328
		1329	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1330
		1331	=item $env = $term->env
		1332
		1333	Returns a copy of the environment in effect for the terminal as a hashref
		1334	similar to C<\%ENV>.
		1335
		1336	=cut
		1337
		1338	sub env {
		1339	if (my $env = $_[0]->_env) {
		1340	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1341	} else {
		1342	+{ %ENV }
		1343	}
		1344	}
915		1345
916	=item $modifiermask = $term->ModLevel3Mask	1346	=item $modifiermask = $term->ModLevel3Mask
917		1347
918	=item $modifiermask = $term->ModMetaMask	1348	=item $modifiermask = $term->ModMetaMask
919		1349
…		…
922	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1352	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
923	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1353	AltGr), the meta key (often Alt) and the num lock key, if applicable.
924		1354
925	=item $view_start = $term->view_start ([$newvalue])	1355	=item $view_start = $term->view_start ([$newvalue])
926		1356
927	Returns the negative row number of the topmost line. Minimum value is	1357	Returns the row number of the topmost displayed line. Maximum value is
928	C<0>, which displays the normal terminal contents. Larger values scroll	1358	C<0>, which displays the normal terminal contents. Lower values scroll
929	this many lines into the scrollback buffer.	1359	this many lines into the scrollback buffer.
930		1360
931	=item $term->want_refresh	1361	=item $term->want_refresh
932		1362
933	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1363	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1012	Return the row number of the first/last row of the line, respectively.	1442	Return the row number of the first/last row of the line, respectively.
1013		1443
1014	=item $offset = $line->offset_of ($row, $col)	1444	=item $offset = $line->offset_of ($row, $col)
1015		1445
1016	Returns the character offset of the given row\|col pair within the logical	1446	Returns the character offset of the given row\|col pair within the logical
1017	line.	1447	line. Works for rows outside the line, too, and returns corresponding
		1448	offsets outside the string.
1018		1449
1019	=item ($row, $col) = $line->coord_of ($offset)	1450	=item ($row, $col) = $line->coord_of ($offset)
1020		1451
1021	Translates a string offset into terminal coordinates again.	1452	Translates a string offset into terminal coordinates again.
1022		1453
…		…
1109	Converts rxvt-unicodes text reprsentation into a perl string. See	1540	Converts rxvt-unicodes text reprsentation into a perl string. See
1110	C<< $term->ROW_t >> for details.	1541	C<< $term->ROW_t >> for details.
1111		1542
1112	=item $success = $term->grab_button ($button, $modifiermask)	1543	=item $success = $term->grab_button ($button, $modifiermask)
1113		1544
1114	Registers a synchronous button grab. See XGrabButton.	1545	Registers a synchronous button grab. See the XGrabButton manpage.
1115		1546
1116	=item $success = $term->grab ($eventtime[, $sync])	1547	=item $success = $term->grab ($eventtime[, $sync])
1117		1548
1118	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1549	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1119	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1550	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1159	$item->{render} \|\|= sub { $_[0]{text} };	1590	$item->{render} \|\|= sub { $_[0]{text} };
1160		1591
1161	push @{ $self->{item} }, $item;	1592	push @{ $self->{item} }, $item;
1162	}	1593	}
1163		1594
1164	sub add_separator {	1595	=item $popup->add_title ($title)
1165	my ($self, $sep) = @_;
1166		1596
1167	$sep \|\|= "═";	1597	Adds a non-clickable title to the popup.
1168		1598
1169	$self->add_item ({	1599	=cut
1170	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1171	text => "",
1172	render => sub { $sep x $urxvt::TERM->ncol },
1173	activate => sub { },
1174	});
1175	}
1176		1600
1177	sub add_title {	1601	sub add_title {
1178	my ($self, $title) = @_;	1602	my ($self, $title) = @_;
1179		1603
1180	$self->add_item ({	1604	$self->add_item ({
…		…
1182	text => $title,	1606	text => $title,
1183	activate => sub { },	1607	activate => sub { },
1184	});	1608	});
1185	}	1609	}
1186		1610
		1611	=item $popup->add_separator ([$sepchr])
		1612
		1613	Creates a separator, optionally using the character given as C<$sepchr>.
		1614
		1615	=cut
		1616
		1617	sub add_separator {
		1618	my ($self, $sep) = @_;
		1619
		1620	$sep \|\|= "=";
		1621
		1622	$self->add_item ({
		1623	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1624	text => "",
		1625	render => sub { $sep x $self->{term}->ncol },
		1626	activate => sub { },
		1627	});
		1628	}
		1629
		1630	=item $popup->add_button ($text, $cb)
		1631
		1632	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1633	selected.
		1634
		1635	=cut
		1636
1187	sub add_button {	1637	sub add_button {
1188	my ($self, $text, $cb) = @_;	1638	my ($self, $text, $cb) = @_;
1189		1639
1190	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1640	$self->add_item ({ type => "button", text => $text, activate => $cb});
1191	}	1641	}
		1642
		1643	=item $popup->add_toggle ($text, $cb, $initial_value)
		1644
		1645	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1646	whenever it gets toggled, with a boolean indicating its value as its first
		1647	argument.
		1648
		1649	=cut
1192		1650
1193	sub add_toggle {	1651	sub add_toggle {
1194	my ($self, $text, $cb, $value) = @_;	1652	my ($self, $text, $cb, $value) = @_;
1195		1653
1196	my $item; $item = {	1654	my $item; $item = {
1197	type => "button",	1655	type => "button",
1198	text => " $text",	1656	text => " $text",
1199	value => $value,	1657	value => $value,
1200	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1658	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1201	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1659	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1202	};	1660	};
1203		1661
1204	$self->add_item ($item);	1662	$self->add_item ($item);
1205	}	1663	}
		1664
		1665	=item $popup->show
		1666
		1667	Displays the popup (which is initially hidden).
		1668
		1669	=cut
1206		1670
1207	sub show {	1671	sub show {
1208	my ($self) = @_;	1672	my ($self) = @_;
1209		1673
1210	local $urxvt::popup::self = $self;	1674	local $urxvt::popup::self = $self;
1211		1675
1212	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1676	my $env = $self->{term}->env;
		1677	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1678	delete $env->{LC_ALL};
		1679	$env->{LC_CTYPE} = $self->{term}->locale;
		1680
		1681	urxvt::term->new ($env, "popup",
		1682	"--perl-lib" => "", "--perl-ext-common" => "",
		1683	"-pty-fd" => -1, "-sl" => 0,
		1684	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1213	"--transient-for" => $self->{term}->parent,	1685	"--transient-for" => $self->{term}->parent,
		1686	"-display" => $self->{term}->display_id,
1214	"-pe" => "urxvt-popup")	1687	"-pe" => "urxvt-popup")
1215	or die "unable to create popup window\n";	1688	or die "unable to create popup window\n";
1216	}	1689	}
1217		1690
1218	sub DESTROY {	1691	sub DESTROY {
1219	my ($self) = @_;	1692	my ($self) = @_;
1220		1693
1221	delete $self->{term}{_destroy}{$self};	1694	delete $self->{term}{_destroy}{$self};
1222	$self->{term}->ungrab;	1695	$self->{term}->ungrab;
1223	}	1696	}
		1697
		1698	=back
		1699
		1700	=cut
		1701
		1702	package urxvt::watcher;
		1703
		1704	@urxvt::timer::ISA = __PACKAGE__;
		1705	@urxvt::iow::ISA = __PACKAGE__;
		1706	@urxvt::pw::ISA = __PACKAGE__;
		1707	@urxvt::iw::ISA = __PACKAGE__;
1224		1708
1225	=head2 The C<urxvt::timer> Class	1709	=head2 The C<urxvt::timer> Class
1226		1710
1227	This class implements timer watchers/events. Time is represented as a	1711	This class implements timer watchers/events. Time is represented as a
1228	fractional number of seconds since the epoch. Example:	1712	fractional number of seconds since the epoch. Example:
…		…
1267		1751
1268	=item $timer = $timer->start ($tstamp)	1752	=item $timer = $timer->start ($tstamp)
1269		1753
1270	Set the event trigger time to C<$tstamp> and start the timer.	1754	Set the event trigger time to C<$tstamp> and start the timer.
1271		1755
		1756	=item $timer = $timer->after ($delay)
		1757
		1758	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1759
1272	=item $timer = $timer->stop	1760	=item $timer = $timer->stop
1273		1761
1274	Stop the timer.	1762	Stop the timer.
1275		1763
1276	=back	1764	=back
…		…
1281		1769
1282	$term->{socket} = ...	1770	$term->{socket} = ...
1283	$term->{iow} = urxvt::iow	1771	$term->{iow} = urxvt::iow
1284	->new	1772	->new
1285	->fd (fileno $term->{socket})	1773	->fd (fileno $term->{socket})
1286	->events (1) # wait for read data	1774	->events (urxvt::EVENT_READ)
1287	->start	1775	->start
1288	->cb (sub {	1776	->cb (sub {
1289	my ($iow, $revents) = @_;	1777	my ($iow, $revents) = @_;
1290	# $revents must be 1 here, no need to check	1778	# $revents must be 1 here, no need to check
1291	sysread $term->{socket}, my $buf, 8192	1779	sysread $term->{socket}, my $buf, 8192
…		…
1308		1796
1309	Set the filedescriptor (not handle) to watch.	1797	Set the filedescriptor (not handle) to watch.
1310		1798
1311	=item $iow = $iow->events ($eventmask)	1799	=item $iow = $iow->events ($eventmask)
1312		1800
1313	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1801	Set the event mask to watch. The only allowed values are
1314	data, Bit #1 (value C<2>) enables watching for write data.	1802	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1803	together, or C<urxvt::EVENT_NONE>.
1315		1804
1316	=item $iow = $iow->start	1805	=item $iow = $iow->start
1317		1806
1318	Start watching for requested events on the given handle.	1807	Start watching for requested events on the given handle.
1319		1808
1320	=item $iow = $iow->stop	1809	=item $iow = $iow->stop
1321		1810
1322	Stop watching for events on the given filehandle.	1811	Stop watching for events on the given filehandle.
		1812
		1813	=back
		1814
		1815	=head2 The C<urxvt::iw> Class
		1816
		1817	This class implements idle watchers, that get called automatically when
		1818	the process is idle. They should return as fast as possible, after doing
		1819	some useful work.
		1820
		1821	=over 4
		1822
		1823	=item $iw = new urxvt::iw
		1824
		1825	Create a new idle watcher object in stopped state.
		1826
		1827	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1828
		1829	Set the callback to be called when the watcher triggers.
		1830
		1831	=item $timer = $timer->start
		1832
		1833	Start the watcher.
		1834
		1835	=item $timer = $timer->stop
		1836
		1837	Stop the watcher.
		1838
		1839	=back
		1840
		1841	=head2 The C<urxvt::pw> Class
		1842
		1843	This class implements process watchers. They create an event whenever a
		1844	process exits, after which they stop automatically.
		1845
		1846	my $pid = fork;
		1847	...
		1848	$term->{pw} = urxvt::pw
		1849	->new
		1850	->start ($pid)
		1851	->cb (sub {
		1852	my ($pw, $exit_status) = @_;
		1853	...
		1854	});
		1855
		1856	=over 4
		1857
		1858	=item $pw = new urxvt::pw
		1859
		1860	Create a new process watcher in stopped state.
		1861
		1862	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1863
		1864	Set the callback to be called when the timer triggers.
		1865
		1866	=item $pw = $timer->start ($pid)
		1867
		1868	Tells the wqtcher to start watching for process C<$pid>.
		1869
		1870	=item $pw = $pw->stop
		1871
		1872	Stop the watcher.
1323		1873
1324	=back	1874	=back
1325		1875
1326	=head1 ENVIRONMENT	1876	=head1 ENVIRONMENT
1327		1877
…		…
1334		1884
1335	=item == 0 - fatal messages	1885	=item == 0 - fatal messages
1336		1886
1337	=item >= 3 - script loading and management	1887	=item >= 3 - script loading and management
1338		1888
1339	=item >=10 - all events received	1889	=item >=10 - all called hooks
		1890
		1891	=item >=11 - hook reutrn values
1340		1892
1341	=back	1893	=back
1342		1894
1343	=head1 AUTHOR	1895	=head1 AUTHOR
1344		1896

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC vs. Revision 1.117 by ayin, Fri Jan 20 18:02:43 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.117 by ayin, Fri Jan 20 18:02:43 2006 UTC