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.38 by root, Fri Jan 6 03:43:12 2006 UTC vs.
Revision 1.104 by root, Wed Jan 18 17:49:47 2006 UTC

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

Diff Legend

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