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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.58 by root, Sun Jan 8 22:58:13 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.58 by root, Sun Jan 8 22:58:13 2006 UTC vs. Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.58 by root, Sun Jan 8 22:58:13 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC