ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

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

Diff Legend

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