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.44 by root, Sat Jan 7 19:29:17 2006 UTC vs.
Revision 1.110 by root, Thu Jan 19 16:22:13 2006 UTC

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

Diff Legend

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