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.26 by root, Tue Jan 3 21:22:22 2006 UTC vs.
Revision 1.107 by root, Wed Jan 18 21:30:50 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
55	Rot-13 the selection when activated. Used via keyboard trigger:	77	Rot-13 the selection when activated. Used via keyboard trigger:
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
		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.
60		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		186
…		…
66		188
67	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
68	window. Illustrates overwriting the refresh callbacks to create your own	190	window. Illustrates overwriting the refresh callbacks to create your own
69	overlays or changes.	191	overlays or changes.
70		192
		193	=item selection-pastebin
		194
		195	This is a little rarely useful extension that Uploads the selection as
		196	textfile to a remote site (or does other things). (The implementation is
		197	not currently secure for use in a multiuser environment as it writes to
		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/%
		221
71	=back	222	=back
		223
		224	=head1 API DOCUMENTATION
72		225
73	=head2 General API Considerations	226	=head2 General API Considerations
74		227
75	All objects (such as terminals, time watchers etc.) are typical	228	All objects (such as terminals, time watchers etc.) are typical
76	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
…		…
81	When objects are destroyed on the C++ side, the perl object hashes are	234	When objects are destroyed on the C++ side, the perl object hashes are
82	emptied, so its best to store related objects such as time watchers and	235	emptied, so its best to store related objects such as time watchers and
83	the like inside the terminal object so they get destroyed as soon as the	236	the like inside the terminal object so they get destroyed as soon as the
84	terminal is destroyed.	237	terminal is destroyed.
85		238
		239	Argument names also often indicate the type of a parameter. Here are some
		240	hints on what they mean:
		241
		242	=over 4
		243
		244	=item $text
		245
		246	Rxvt-unicodes special way of encoding text, where one "unicode" character
		247	always represents one screen cell. See L<ROW_t> for a discussion of this format.
		248
		249	=item $string
		250
		251	A perl text string, with an emphasis on I<text>. It can store all unicode
		252	characters and is to be distinguished with text encoded in a specific
		253	encoding (often locale-specific) and binary data.
		254
		255	=item $octets
		256
		257	Either binary data or - more common - a text string encoded in a
		258	locale-specific way.
		259
		260	=back
		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
86	=head2 Hooks	295	=head2 Hooks
87		296
88	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
89	called whenever the relevant event happens.	298	called whenever the relevant event happens.
90		299
91	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
92	and extension package. You can call all C<urxvt::term> methods on it, but	301	the in the C<Extension Objects> section.
93	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
94	object that is shared between all packages is stored in the C<term>
95	member.
96		302
97	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
98	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
99	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.
100		306
101	When in doubt, return a false value (preferably C<()>).	307	I<< When in doubt, return a false value (preferably C<()>). >>
102		308
103	=over 4	309	=over 4
104		310
105	=item on_init $term	311	=item on_init $term
106		312
107	Called after a new terminal object has been initialized, but before	313	Called after a new terminal object has been initialized, but before
108	windows are created or the command gets run.	314	windows are created or the command gets run. Most methods are unsafe to
		315	call or deliver senseless data, as terminal size and other characteristics
		316	have not yet been determined. You can safely query and change resources,
		317	though.
109		318
110	=item on_reset $term	319	=item on_reset $term
111		320
112	Called after the screen is "reset" for any reason, such as resizing or	321	Called after the screen is "reset" for any reason, such as resizing or
113	control sequences. Here is where you can react on changes to size-related	322	control sequences. Here is where you can react on changes to size-related
…		…
138	=item on_sel_extend $term	347	=item on_sel_extend $term
139		348
140	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
141	click) and is either supposed to return false (normal operation), or	350	click) and is either supposed to return false (normal operation), or
142	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
143	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.
144		355
145	See the F<selection> example extension.	356	See the F<selection> example extension.
146
147	=item on_focus_in $term
148
149	Called whenever the window gets the keyboard focus, before urxvt does
150	focus in processing.
151
152	=item on_focus_out $term
153
154	Called wheneever the window loses keyboard focus, before urxvt does focus
155	out processing.
156		357
157	=item on_view_change $term, $offset	358	=item on_view_change $term, $offset
158		359
159	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
160	scrolls. Offset C<0> means display the normal terminal, positive values	361	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
168		369
169	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,
170	$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
171	number of lines that will be in the scrollback buffer.	372	number of lines that will be in the scrollback buffer.
172		373
173	=item on_tty_activity $term *NYI*	374	=item on_osc_seq $term, $string
174		375
175	Called whenever the program(s) running in the urxvt window send output.	376	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		377	operating system command) is processed. Cursor position and other state
		378	information is up-to-date when this happens. For interoperability, the
		379	string should start with the extension name and a colon, to distinguish
		380	it from commands for other extensions, and this might be enforced in the
		381	future.
		382
		383	Be careful not ever to trust (in a security sense) the data you receive,
		384	as its source can not easily be controleld (e-mail content, messages from
		385	other users on the same system etc.).
		386
		387	=item on_add_lines $term, $string
		388
		389	Called whenever text is about to be output, with the text as argument. You
		390	can filter/change and output the text yourself by returning a true value
		391	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		392	might be very slow, however, as your hook is called for B<all> text being
		393	output.
		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
		400	=item on_line_update $term, $row
		401
		402	Called whenever a line was updated or changed. Can be used to filter
		403	screen output (e.g. underline urls or other useless stuff). Only lines
		404	that are being shown will be filtered, and, due to performance reasons,
		405	not always immediately.
		406
		407	The row number is always the topmost row of the line if the line spans
		408	multiple rows.
		409
		410	Please note that, if you change the line, then the hook might get called
		411	later with the already-modified line (e.g. if unrelated parts change), so
		412	you cannot just toggle rendition bits, but only set them.
176		413
177	=item on_refresh_begin $term	414	=item on_refresh_begin $term
178		415
179	Called just before the screen gets redrawn. Can be used for overlay	416	Called just before the screen gets redrawn. Can be used for overlay
180	or similar effects by modify terminal contents in refresh_begin, and	417	or similar effects by modify terminal contents in refresh_begin, and
…		…
189		426
190	Called whenever the user presses a key combination that has a	427	Called whenever the user presses a key combination that has a
191	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>
192	resource in the @@RXVT_NAME@@(1) manpage).	429	resource in the @@RXVT_NAME@@(1) manpage).
193		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
		449	=item on_key_press $term, $event, $keysym, $octets
		450
		451	=item on_key_release $term, $event, $keysym
		452
		453	=item on_button_press $term, $event
		454
		455	=item on_button_release $term, $event
		456
		457	=item on_motion_notify $term, $event
		458
		459	=item on_map_notify $term, $event
		460
		461	=item on_unmap_notify $term, $event
		462
		463	Called whenever the corresponding X event is received for the terminal If
		464	the hook returns true, then the even will be 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.
		469
		470	C<on_key_press> additionally receives the string rxvt-unicode would
		471	output, if any, in locale-specific encoding.
		472
		473	subwindow.
		474
194	=back	475	=back
195		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
196	=head2 Variables in the C<urxvt> Package	498	=head2 Variables in the C<urxvt> Package
197		499
198	=over 4	500	=over 4
199		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
200	=item $urxvt::TERM	515	=item $urxvt::TERM
201		516
202	The current terminal. Whenever a callback/Hook is bein executed, this	517	The current terminal. This variable stores the current C<urxvt::term>
203	variable stores the current C<urxvt::term> object.	518	object, whenever a callback/hook is executing.
204		519
205	=back	520	=back
206		521
207	=head2 Functions in the C<urxvt> Package	522	=head2 Functions in the C<urxvt> Package
208		523
…		…
221	that calls this function.	536	that calls this function.
222		537
223	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
224	correct place, e.g. on stderr of the connecting urxvtc client.	539	correct place, e.g. on stderr of the connecting urxvtc client.
225		540
		541	Messages have a size limit of 1023 bytes currently.
		542
226	=item $time = urxvt::NOW	543	=item $time = urxvt::NOW
227		544
228	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.
229		570
230	=back	571	=back
231		572
232	=head2 RENDITION	573	=head2 RENDITION
233		574
…		…
260		601
261	=item $background = urxvt::GET_BASEBG $rend	602	=item $background = urxvt::GET_BASEBG $rend
262		603
263	Return the foreground/background colour index, respectively.	604	Return the foreground/background colour index, respectively.
264		605
265	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	606	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
266		607
267	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	608	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
268		609
269	Replace the foreground/background colour in the rendition mask with the	610	Replace the foreground/background colour in the rendition mask with the
270	specified one.	611	specified one.
271		612
272	=item $value = urxvt::GET_CUSTOM ($rend)	613	=item $value = urxvt::GET_CUSTOM $rend
273		614
274	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
275	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
276	zero.	617	zero.
277		618
278	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	619	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
279		620
280	Change the custom value.	621	Change the custom value.
281		622
282	=back	623	=back
283		624
284	=cut	625	=cut
285		626
286	package urxvt;
287
288	use strict;
289	use Scalar::Util ();
290
291	our $TERM;
292	our @HOOKNAME;
293	our $LIBDIR;
294
295	BEGIN {	627	BEGIN {
296	urxvt->bootstrap;
297
298	# overwrite perl's warn	628	# overwrite perl's warn
299	*CORE::GLOBAL::warn = sub {	629	*CORE::GLOBAL::warn = sub {
300	my $msg = join "", @_;	630	my $msg = join "", @_;
301	$msg .= "\n"	631	$msg .= "\n"
302	unless $msg =~ /\n$/;	632	unless $msg =~ /\n$/;
303	urxvt::warn ($msg);	633	urxvt::warn ($msg);
304	};	634	};
305	}	635	}
306		636
307	my @hook_count;
308	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	637	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
309		638
310	sub verbose {	639	sub verbose {
311	my ($level, $msg) = @_;	640	my ($level, $msg) = @_;
312	warn "$msg\n" if $level <= $verbosity;	641	warn "$msg\n" if $level <= $verbosity;
313	}	642	}
314		643
315	# find on_xxx subs in the package and register them	644	my %extension_pkg;
316	# as hooks
317	sub register_package($) {
318	my ($pkg) = @_;
319
320	for my $htype (0.. $#HOOKNAME) {
321	my $name = $HOOKNAME[$htype];
322
323	my $ref = $pkg->can ("on_" . lc $name)
324	or next;
325
326	$TERM->{_hook}[$htype]{$pkg} = $ref;
327	$hook_count[$htype]++
328	or set_should_invoke $htype, 1;
329	}
330	}
331
332	my $script_pkg = "script0000";
333	my %script_pkg;
334		645
335	# load a single script into its own package, once only	646	# load a single script into its own package, once only
336	sub script_package($) {	647	sub extension_package($) {
337	my ($path) = @_;	648	my ($path) = @_;
338		649
		650	no strict 'refs';
		651
339	$script_pkg{$path} ||= do {	652	$extension_pkg{$path} ||= do {
340	my $pkg = "urxvt::" . ($script_pkg++);	653	$path =~ /([^\/\\]+)$/;
		654	my $pkg = $1;
		655	$pkg =~ s/[^[:word:]]/_/g;
		656	$pkg = "urxvt::ext::$pkg";
341		657
342	verbose 3, "loading script '$path' into package '$pkg'";	658	verbose 3, "loading extension '$path' into package '$pkg'";
343		659
344	open my $fh, "<:raw", $path	660	open my $fh, "<:raw", $path
345	or die "$path: $!";	661	or die "$path: $!";
346		662
		663	@{"$pkg\::ISA"} = urxvt::term::extension::;
		664
		665	my $source =
347	my $source = "package $pkg; use strict; use utf8;\n"	666	"package $pkg; use strict; use utf8;\n"
348	. "#line 1 \"$path\"\n{\n"	667	. "#line 1 \"$path\"\n{\n"
349	. (do { local $/; <$fh> })	668	. (do { local $/; <$fh> })
350	. "\n};\n1";	669	. "\n};\n1";
351		670
		671	eval $source
352	eval $source or die "$path: $@";	672	or die "$path: $@";
353		673
354	$pkg	674	$pkg
355	}	675	}
356	}	676	}
		677
		678	our $retval; # return value for urxvt
357		679
358	# called by the rxvt core	680	# called by the rxvt core
359	sub invoke {	681	sub invoke {
360	local $TERM = shift;	682	local $TERM = shift;
361	my $htype = shift;	683	my $htype = shift;
362		684
363	if ($htype == 0) { # INIT	685	if ($htype == 0) { # INIT
364	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	686	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		687
		688	my %ext_arg;
365		689
366	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	690	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		691	if ($_ eq "default") {
		692	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
		693	} elsif (/^-(.*)$/) {
		694	delete $ext_arg{$1};
		695	} elsif (/^([^<]+)<(.*)>$/) {
		696	push @{ $ext_arg{$1} }, $2;
		697	} else {
		698	$ext_arg{$_} ||= [];
		699	}
		700	}
		701
		702	while (my ($ext, $argv) = each %ext_arg) {
367	my @files = grep -f $_, map "$_/$ext", @dirs;	703	my @files = grep -f $_, map "$_/$ext", @dirs;
368		704
369	if (@files) {	705	if (@files) {
370	register_package script_package $files[0];	706	$TERM->register_package (extension_package $files[0], $argv);
371	} else {	707	} else {
372	warn "perl extension '$ext' not found in perl library search path\n";	708	warn "perl extension '$ext' not found in perl library search path\n";
373	}	709	}
374	}	710	}
375		711
376	} elsif ($htype == 1) { # DESTROY	712	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		713	warn $@ if $@;
		714	}
		715
		716	$retval = undef;
		717
377	if (my $hook = $TERM->{_hook}) {	718	if (my $cb = $TERM->{_hook}[$htype]) {
378	for my $htype (0..$#$hook) {	719	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
379	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }	720	if $verbosity >= 10;
380	or set_should_invoke $htype, 0;	721
		722	keys %$cb;
		723
		724	while (my ($pkg, $cb) = each %$cb) {
		725	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
		726	and last;
		727
		728	if ($@) {
		729	$TERM->ungrab; # better to lose the grab than the session
		730	warn $@;
381	}	731	}
382	}	732	}
		733
		734	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		735	if $verbosity >= 11;
383	}	736	}
384		737
385	my $cb = $TERM->{_hook}[$htype]	738	if ($htype == 1) { # DESTROY
386	or return;	739	# clear package objects
		740	%$_ = () for values %{ $TERM->{_pkg} };
387		741
388	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	742	# clear package
389	if $verbosity >= 10;	743	%$TERM = ();
390
391	keys %$cb;
392
393	while (my ($pkg, $cb) = each %$cb) {
394	return 1
395	if $cb->(
396	$TERM->{$pkg} ||= do {
397	my $proxy = bless { }, urxvt::term::proxy::;
398	Scalar::Util::weaken ($proxy->{term} = $TERM);
399	$proxy
400	},
401	@_,
402	);
403	}	744	}
404		745
		746	$retval
		747	}
		748
		749	sub exec_async(@) {
		750	my $pid = fork;
		751
		752	return
		753	if !defined $pid or $pid;
		754
		755	%ENV = %{ $TERM->env };
		756
		757	exec @_;
		758	_exit 255;
		759	}
		760
		761	# urxvt::term::extension
		762
		763	package urxvt::term::extension;
		764
		765	sub enable {
		766	my ($self, %hook) = @_;
		767	my $pkg = $self->{_pkg};
		768
		769	while (my ($name, $cb) = each %hook) {
		770	my $htype = $HOOKTYPE{uc $name};
		771	defined $htype
		772	or Carp::croak "unsupported hook type '$name'";
		773
		774	$self->set_should_invoke ($htype, +1)
		775	unless exists $self->{term}{_hook}[$htype]{$pkg};
		776
		777	$self->{term}{_hook}[$htype]{$pkg} = $cb;
405	0	778	}
406	}	779	}
407		780
408	sub urxvt::term::proxy::AUTOLOAD {	781	sub disable {
409	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	782	my ($self, @hook) = @_;
		783	my $pkg = $self->{_pkg};
		784
		785	for my $name (@hook) {
		786	my $htype = $HOOKTYPE{uc $name};
		787	defined $htype
		788	or Carp::croak "unsupported hook type '$name'";
		789
		790	$self->set_should_invoke ($htype, -1)
		791	if delete $self->{term}{_hook}[$htype]{$pkg};
		792	}
		793	}
		794
		795	our $AUTOLOAD;
		796
		797	sub AUTOLOAD {
		798	$AUTOLOAD =~ /:([^:]+)$/
410	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	799	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
411		800
412	eval qq{	801	eval qq{
413	sub $urxvt::term::proxy::AUTOLOAD {	802	sub $AUTOLOAD {
414	my \$proxy = shift;	803	my \$proxy = shift;
415	\$proxy->{term}->$1 (\@_)	804	\$proxy->{term}->$1 (\@_)
416	}	805	}
417	1	806	1
418	} or die "FATAL: unable to compile method forwarder: $@";	807	} or die "FATAL: unable to compile method forwarder: $@";
419		808
420	goto &$urxvt::term::proxy::AUTOLOAD;	809	goto &$AUTOLOAD;
421	}	810	}
		811
		812	sub DESTROY {
		813	# nop
		814	}
		815
		816	# urxvt::destroy_hook
		817
		818	sub urxvt::destroy_hook::DESTROY {
		819	${$_[0]}->();
		820	}
		821
		822	sub urxvt::destroy_hook(&) {
		823	bless \shift, urxvt::destroy_hook::
		824	}
		825
		826	package urxvt::anyevent;
		827
		828	=head2 The C<urxvt::anyevent> Class
		829
		830	The sole purpose of this class is to deliver an interface to the
		831	C<AnyEvent> module - any module using it will work inside urxvt without
		832	further programming. The only exception is that you cannot wait on
		833	condition variables, but non-blocking condvar use is ok. What this means
		834	is that you cannot use blocking APIs, but the non-blocking variant should
		835	work.
		836
		837	=cut
		838
		839	our $VERSION = 1;
		840
		841	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		842	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		843
		844	sub timer {
		845	my ($class, %arg) = @_;
		846
		847	my $cb = $arg{cb};
		848
		849	urxvt::timer
		850	->new
		851	->start (urxvt::NOW + $arg{after})
		852	->cb (sub {
		853	$_[0]->stop; # need to cancel manually
		854	$cb->();
		855	})
		856	}
		857
		858	sub io {
		859	my ($class, %arg) = @_;
		860
		861	my $cb = $arg{cb};
		862
		863	bless [$arg{fh}, urxvt::iow
		864	->new
		865	->fd (fileno $arg{fh})
		866	->events (($arg{poll} =~ /r/ ? 1 : 0)
		867	| ($arg{poll} =~ /w/ ? 2 : 0))
		868	->start
		869	->cb (sub {
		870	$cb->(($_[1] & 1 ? 'r' : '')
		871	. ($_[1] & 2 ? 'w' : ''));
		872	})],
		873	urxvt::anyevent::
		874	}
		875
		876	sub DESTROY {
		877	$_[0][1]->stop;
		878	}
		879
		880	sub condvar {
		881	bless \my $flag, urxvt::anyevent::condvar::
		882	}
		883
		884	sub urxvt::anyevent::condvar::broadcast {
		885	${$_[0]}++;
		886	}
		887
		888	sub urxvt::anyevent::condvar::wait {
		889	unless (${$_[0]}) {
		890	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		891	}
		892	}
		893
		894	package urxvt::term;
422		895
423	=head2 The C<urxvt::term> Class	896	=head2 The C<urxvt::term> Class
424		897
425	=over 4	898	=over 4
		899
		900	=cut
		901
		902	# find on_xxx subs in the package and register them
		903	# as hooks
		904	sub register_package {
		905	my ($self, $pkg, $argv) = @_;
		906
		907	my $proxy = bless {
		908	_pkg => $pkg,
		909	argv => $argv,
		910	}, $pkg;
		911	Scalar::Util::weaken ($proxy->{term} = $self);
		912
		913	$self->{_pkg}{$pkg} = $proxy;
		914
		915	for my $name (@HOOKNAME) {
		916	if (my $ref = $pkg->can ("on_" . lc $name)) {
		917	$proxy->enable ($name => $ref);
		918	}
		919	}
		920	}
		921
		922	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		923
		924	Creates a new terminal, very similar as if you had started it with system
		925	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		926	hash which defines the environment of the new terminal.
		927
		928	Croaks (and probably outputs an error message) if the new instance
		929	couldn't be created. Returns C<undef> if the new instance didn't
		930	initialise perl, and the terminal object otherwise. The C<init> and
		931	C<start> hooks will be called during this call.
		932
		933	=cut
		934
		935	sub new {
		936	my ($class, $env, @args) = @_;
		937
		938	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		939	}
		940
		941	=item $term->destroy
		942
		943	Destroy the terminal object (close the window, free resources
		944	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		945	watchers (timers, io watchers) are still active.
		946
		947	=item $isset = $term->option ($optval[, $set])
		948
		949	Returns true if the option specified by C<$optval> is enabled, and
		950	optionally change it. All option values are stored by name in the hash
		951	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		952
		953	Here is a a likely non-exhaustive list of option names, please see the
		954	source file F</src/optinc.h> to see the actual list:
		955
		956	borderLess console cursorBlink cursorUnderline hold iconic insecure
		957	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		958	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
		959	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
		960	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
		961	transparent tripleclickwords utmpInhibit visualBell
426		962
427	=item $value = $term->resource ($name[, $newval])	963	=item $value = $term->resource ($name[, $newval])
428		964
429	Returns the current resource value associated with a given name and	965	Returns the current resource value associated with a given name and
430	optionally sets a new value. Setting values is most useful in the C<init>	966	optionally sets a new value. Setting values is most useful in the C<init>
…		…
440		976
441	Please note that resource strings will currently only be freed when the	977	Please note that resource strings will currently only be freed when the
442	terminal is destroyed, so changing options frequently will eat memory.	978	terminal is destroyed, so changing options frequently will eat memory.
443		979
444	Here is a a likely non-exhaustive list of resource names, not all of which	980	Here is a a likely non-exhaustive list of resource names, not all of which
445	are supported in every build, please see the source to see the actual	981	are supported in every build, please see the source file F</src/rsinc.h>
446	list:	982	to see the actual list:
447		983
448	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	984	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
449	borderLess color cursorBlink cursorUnderline cutchars delete_key	985	borderLess color cursorBlink cursorUnderline cutchars delete_key
450	display_name embed ext_bwidth fade font geometry hold iconName	986	display_name embed ext_bwidth fade font geometry hold iconName
451	imFont imLocale inputMethod insecure int_bwidth intensityStyles	987	imFont imLocale inputMethod insecure int_bwidth intensityStyles
452	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	988	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
453	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	989	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
454	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	990	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
455	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	991	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
456	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	992	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
457	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	993	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
458	shade term_name title transparent transparent_all tripleclickwords	994	secondaryScreen secondaryScroll selectstyle shade term_name title
459	utmpInhibit visualBell	995	transient_for transparent transparent_all tripleclickwords utmpInhibit
		996	visualBell
460		997
461	=cut	998	=cut
462		999
463	sub urxvt::term::resource($$;$) {	1000	sub resource($$;$) {
464	my ($self, $name) = (shift, shift);	1001	my ($self, $name) = (shift, shift);
465	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1002	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
466	goto &urxvt::term::_resource;	1003	&urxvt::term::_resource
467	}	1004	}
		1005
		1006	=item $value = $term->x_resource ($pattern)
		1007
		1008	Returns the X-Resource for the given pattern, excluding the program or
		1009	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1010	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1011	resource with that pattern exists.
		1012
		1013	This method should only be called during the C<on_start> hook, as there is
		1014	only one resource database per display, and later invocations might return
		1015	the wrong resources.
		1016
		1017	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1018
		1019	Adds a keymap translation exactly as specified via a resource. See the
		1020	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1021
		1022	=item $rend = $term->rstyle ([$new_rstyle])
		1023
		1024	Return and optionally change the current rendition. Text that is output by
		1025	the terminal application will use this style.
		1026
		1027	=item ($row, $col) = $term->screen_cur ([$row, $col])
		1028
		1029	Return the current coordinates of the text cursor position and optionally
		1030	set it (which is usually bad as applications don't expect that).
468		1031
469	=item ($row, $col) = $term->selection_mark ([$row, $col])	1032	=item ($row, $col) = $term->selection_mark ([$row, $col])
470		1033
471	=item ($row, $col) = $term->selection_beg ([$row, $col])	1034	=item ($row, $col) = $term->selection_beg ([$row, $col])
472		1035
473	=item ($row, $col) = $term->selection_end ([$row, $col])	1036	=item ($row, $col) = $term->selection_end ([$row, $col])
474		1037
475	Return the current values of the selection mark, begin or end positions,	1038	Return the current values of the selection mark, begin or end positions,
476	and optionally set them to new values.	1039	and optionally set them to new values.
477		1040
		1041	=item $term->selection_make ($eventtime[, $rectangular])
		1042
		1043	Tries to make a selection as set by C<selection_beg> and
		1044	C<selection_end>. If C<$rectangular> is true (default: false), a
		1045	rectangular selection will be made. This is the prefered function to make
		1046	a selection.
		1047
478	=item $success = $term->selection_grab ($eventtime)	1048	=item $success = $term->selection_grab ($eventtime)
479		1049
480	Try to request the primary selection from the server (for example, as set	1050	Try to request the primary selection text from the server (for example, as
481	by the next method).	1051	set by the next method). No visual feedback will be given. This function
		1052	is mostly useful from within C<on_sel_grab> hooks.
482		1053
483	=item $oldtext = $term->selection ([$newtext])	1054	=item $oldtext = $term->selection ([$newtext])
484		1055
485	Return the current selection text and optionally replace it by C<$newtext>.	1056	Return the current selection text and optionally replace it by C<$newtext>.
486		1057
487	#=item $term->overlay ($x, $y, $text)	1058	=item $term->overlay_simple ($x, $y, $text)
488	#	1059
489	#Create a simple multi-line overlay box. See the next method for details.	1060	Create a simple multi-line overlay box. See the next method for details.
490	#	1061
491	#=cut	1062	=cut
492		1063
493	sub urxvt::term::scr_overlay {	1064	sub overlay_simple {
494	die;
495	my ($self, $x, $y, $text) = @_;	1065	my ($self, $x, $y, $text) = @_;
496		1066
497	my @lines = split /\n/, $text;	1067	my @lines = split /\n/, $text;
498		1068
499	my $w = 0;	1069	my $w = List::Util::max map $self->strwidth ($_), @lines;
500	for (map $self->strwidth ($_), @lines) {
501	$w = $_ if $w < $_;
502	}
503		1070
504	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	1071	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
505	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1072	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		1073
		1074	$overlay
506	}	1075	}
507		1076
508	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1077	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
509		1078
510	Create a new (empty) overlay at the given position with the given	1079	Create a new (empty) overlay at the given position with the given
…		…
538		1107
539	If hidden, display the overlay again.	1108	If hidden, display the overlay again.
540		1109
541	=back	1110	=back
542		1111
		1112	=item $popup = $term->popup ($event)
		1113
		1114	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1115	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1116	currently).
		1117
		1118	=cut
		1119
		1120	sub popup {
		1121	my ($self, $event) = @_;
		1122
		1123	$self->grab ($event->{time}, 1)
		1124	or return;
		1125
		1126	my $popup = bless {
		1127	term => $self,
		1128	event => $event,
		1129	}, urxvt::popup::;
		1130
		1131	Scalar::Util::weaken $popup->{term};
		1132
		1133	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1134	Scalar::Util::weaken $self->{_destroy}{$popup};
		1135
		1136	$popup
		1137	}
		1138
543	=item $cellwidth = $term->strwidth $string	1139	=item $cellwidth = $term->strwidth ($string)
544		1140
545	Returns the number of screen-cells this string would need. Correctly	1141	Returns the number of screen-cells this string would need. Correctly
546	accounts for wide and combining characters.	1142	accounts for wide and combining characters.
547		1143
548	=item $octets = $term->locale_encode $string	1144	=item $octets = $term->locale_encode ($string)
549		1145
550	Convert the given text string into the corresponding locale encoding.	1146	Convert the given text string into the corresponding locale encoding.
551		1147
552	=item $string = $term->locale_decode $octets	1148	=item $string = $term->locale_decode ($octets)
553		1149
554	Convert the given locale-encoded octets into a perl string.	1150	Convert the given locale-encoded octets into a perl string.
		1151
		1152	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1153
		1154	XORs the rendition values in the given span with the provided value
		1155	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1156	refresh hooks to provide effects similar to the selection.
		1157
		1158	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1159
		1160	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1161	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1162	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1163	it instead. Both styles I<MUST NOT> contain font styles.
		1164
		1165	=item $term->scr_bell
		1166
		1167	Ring the bell!
		1168
		1169	=item $term->scr_add_lines ($string)
		1170
		1171	Write the given text string to the screen, as if output by the application
		1172	running inside the terminal. It may not contain command sequences (escape
		1173	codes), but is free to use line feeds, carriage returns and tabs. The
		1174	string is a normal text string, not in locale-dependent encoding.
		1175
		1176	Normally its not a good idea to use this function, as programs might be
		1177	confused by changes in cursor position or scrolling. Its useful inside a
		1178	C<on_add_lines> hook, though.
		1179
		1180	=item $term->cmd_parse ($octets)
		1181
		1182	Similar to C<scr_add_lines>, but the argument must be in the
		1183	locale-specific encoding of the terminal and can contain command sequences
		1184	(escape codes) that will be interpreted.
555		1185
556	=item $term->tt_write ($octets)	1186	=item $term->tt_write ($octets)
557		1187
558	Write the octets given in C<$data> to the tty (i.e. as program input). To	1188	Write the octets given in C<$data> to the tty (i.e. as program input). To
559	pass characters instead of octets, you should convert your strings first	1189	pass characters instead of octets, you should convert your strings first
560	to the locale-specific encoding using C<< $term->locale_encode >>.	1190	to the locale-specific encoding using C<< $term->locale_encode >>.
561		1191
		1192	=item $old_events = $term->pty_ev_events ([$new_events])
		1193
		1194	Replaces the event mask of the pty watcher by the given event mask. Can
		1195	be used to suppress input and output handling to the pty/tty. See the
		1196	description of C<< urxvt::timer->events >>. Make sure to always restore
		1197	the previous value.
		1198
		1199	=item $windowid = $term->parent
		1200
		1201	Return the window id of the toplevel window.
		1202
		1203	=item $windowid = $term->vt
		1204
		1205	Return the window id of the terminal window.
		1206
		1207	=item $term->vt_emask_add ($x_event_mask)
		1208
		1209	Adds the specified events to the vt event mask. Useful e.g. when you want
		1210	to receive pointer events all the times:
		1211
		1212	$term->vt_emask_add (urxvt::PointerMotionMask);
		1213
		1214	=item $window_width = $term->width
		1215
		1216	=item $window_height = $term->height
		1217
		1218	=item $font_width = $term->fwidth
		1219
		1220	=item $font_height = $term->fheight
		1221
		1222	=item $font_ascent = $term->fbase
		1223
562	=item $nrow = $term->nrow	1224	=item $terminal_rows = $term->nrow
563		1225
564	=item $ncol = $term->ncol	1226	=item $terminal_columns = $term->ncol
565		1227
566	Return the number of rows/columns of the terminal window (i.e. as	1228	=item $has_focus = $term->focus
567	specified by C<-geometry>, excluding any scrollback).
568		1229
		1230	=item $is_mapped = $term->mapped
		1231
		1232	=item $max_scrollback = $term->saveLines
		1233
		1234	=item $nrow_plus_saveLines = $term->total_rows
		1235
		1236	=item $topmost_scrollback_row = $term->top_row
		1237
		1238	Return various integers describing terminal characteristics.
		1239
		1240	=item $x_display = $term->display_id
		1241
		1242	Return the DISPLAY used by rxvt-unicode.
		1243
		1244	=item $lc_ctype = $term->locale
		1245
		1246	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1247
569	=item $nsaved = $term->nsaved	1248	=item $env = $term->env
570		1249
571	Returns the number of lines in the scrollback buffer.	1250	Returns a copy of the environment in effect for the terminal as a hashref
		1251	similar to C<\%ENV>.
		1252
		1253	=cut
		1254
		1255	sub env {
		1256	if (my $env = $_[0]->_env) {
		1257	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1258	} else {
		1259	+{ %ENV }
		1260	}
		1261	}
		1262
		1263	=item $modifiermask = $term->ModLevel3Mask
		1264
		1265	=item $modifiermask = $term->ModMetaMask
		1266
		1267	=item $modifiermask = $term->ModNumLockMask
		1268
		1269	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1270	AltGr), the meta key (often Alt) and the num lock key, if applicable.
572		1271
573	=item $view_start = $term->view_start ([$newvalue])	1272	=item $view_start = $term->view_start ([$newvalue])
574		1273
575	Returns the negative row number of the topmost line. Minimum value is	1274	Returns the row number of the topmost displayed line. Maximum value is
576	C<0>, which displays the normal terminal contents. Larger values scroll	1275	C<0>, which displays the normal terminal contents. Lower values scroll
577	this many lines into the scrollback buffer.	1276	this many lines into the scrollback buffer.
578		1277
579	=item $term->want_refresh	1278	=item $term->want_refresh
580		1279
581	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1280	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
639	about the logical line that row C<$row_number> is part of. It supports the	1338	about the logical line that row C<$row_number> is part of. It supports the
640	following methods:	1339	following methods:
641		1340
642	=over 4	1341	=over 4
643		1342
644	=item $text = $line->t	1343	=item $text = $line->t ([$new_text])
645		1344
646	Returns the full text of the line, similar to C<ROW_t>	1345	Returns or replaces the full text of the line, similar to C<ROW_t>
647		1346
648	=item $rend = $line->r	1347	=item $rend = $line->r ([$new_rend])
649		1348
650	Returns the full rendition array of the line, similar to C<ROW_r>	1349	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
651		1350
652	=item $length = $line->l	1351	=item $length = $line->l
653		1352
654	Returns the length of the line in cells, similar to C<ROW_l>.	1353	Returns the length of the line in cells, similar to C<ROW_l>.
655		1354
…		…
660	Return the row number of the first/last row of the line, respectively.	1359	Return the row number of the first/last row of the line, respectively.
661		1360
662	=item $offset = $line->offset_of ($row, $col)	1361	=item $offset = $line->offset_of ($row, $col)
663		1362
664	Returns the character offset of the given row|col pair within the logical	1363	Returns the character offset of the given row|col pair within the logical
665	line.	1364	line. Works for rows outside the line, too, and returns corresponding
		1365	offsets outside the string.
666		1366
667	=item ($row, $col) = $line->coord_of ($offset)	1367	=item ($row, $col) = $line->coord_of ($offset)
668		1368
669	Translates a string offset into terminal coordinates again.	1369	Translates a string offset into terminal coordinates again.
670		1370
671	=back	1371	=back
672		1372
673	=cut	1373	=cut
674		1374
675	sub urxvt::term::line {	1375	sub line {
676	my ($self, $row) = @_;	1376	my ($self, $row) = @_;
677		1377
678	my $maxrow = $self->nrow - 1;	1378	my $maxrow = $self->nrow - 1;
679		1379
680	my ($beg, $end) = ($row, $row);	1380	my ($beg, $end) = ($row, $row);
…		…
684		1384
685	bless {	1385	bless {
686	term => $self,	1386	term => $self,
687	beg => $beg,	1387	beg => $beg,
688	end => $end,	1388	end => $end,
		1389	ncol => $self->ncol,
689	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1390	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
690	}, urxvt::line::	1391	}, urxvt::line::
691	}	1392	}
692		1393
693	sub urxvt::line::t {	1394	sub urxvt::line::t {
694	my ($self) = @_;	1395	my ($self) = @_;
695		1396
		1397	if (@_ > 1)
		1398	{
		1399	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1400	for $self->{beg} .. $self->{end};
		1401	}
		1402
		1403	defined wantarray &&
696	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1404	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
697	0, $self->{len}	1405	0, $self->{len}
698	}	1406	}
699		1407
700	sub urxvt::line::r {	1408	sub urxvt::line::r {
701	my ($self) = @_;	1409	my ($self) = @_;
702		1410
		1411	if (@_ > 1)
		1412	{
		1413	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1414	for $self->{beg} .. $self->{end};
		1415	}
		1416
		1417	if (defined wantarray) {
703	my $rend = [	1418	my $rend = [
704	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1419	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
705	];	1420	];
706	$#$rend = $self->{len} - 1;	1421	$#$rend = $self->{len} - 1;
707	$rend	1422	return $rend;
		1423	}
		1424
		1425	()
708	}	1426	}
709		1427
710	sub urxvt::line::beg { $_[0]{beg} }	1428	sub urxvt::line::beg { $_[0]{beg} }
711	sub urxvt::line::end { $_[0]{end} }	1429	sub urxvt::line::end { $_[0]{end} }
712	sub urxvt::line::l { $_[0]{len} }	1430	sub urxvt::line::l { $_[0]{len} }
713		1431
714	sub urxvt::line::offset_of {	1432	sub urxvt::line::offset_of {
715	my ($self, $row, $col) = @_;	1433	my ($self, $row, $col) = @_;
716		1434
717	($row - $self->{beg}) * $self->{term}->ncol + $col	1435	($row - $self->{beg}) * $self->{ncol} + $col
718	}	1436	}
719		1437
720	sub urxvt::line::coord_of {	1438	sub urxvt::line::coord_of {
721	my ($self, $offset) = @_;	1439	my ($self, $offset) = @_;
722		1440
723	use integer;	1441	use integer;
724		1442
725	(	1443	(
726	$offset / $self->{term}->ncol + $self->{beg},	1444	$offset / $self->{ncol} + $self->{beg},
727	$offset % $self->{term}->ncol	1445	$offset % $self->{ncol}
728	)	1446	)
729	}	1447	}
730		1448
731	=item ($row, $col) = $line->coord_of ($offset)
732	=item $text = $term->special_encode $string	1449	=item $text = $term->special_encode $string
733		1450
734	Converts a perl string into the special encoding used by rxvt-unicode,	1451	Converts a perl string into the special encoding used by rxvt-unicode,
735	where one character corresponds to one screen cell. See	1452	where one character corresponds to one screen cell. See
736	C<< $term->ROW_t >> for details.	1453	C<< $term->ROW_t >> for details.
737		1454
738	=item $string = $term->special_decode $text	1455	=item $string = $term->special_decode $text
739		1456
740	Converts rxvt-unicodes text reprsentation into a perl string. See	1457	Converts rxvt-unicodes text reprsentation into a perl string. See
741	C<< $term->ROW_t >> for details.	1458	C<< $term->ROW_t >> for details.
		1459
		1460	=item $success = $term->grab_button ($button, $modifiermask)
		1461
		1462	Registers a synchronous button grab. See the XGrabButton manpage.
		1463
		1464	=item $success = $term->grab ($eventtime[, $sync])
		1465
		1466	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1467	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1468
		1469	=item $term->allow_events_async
		1470
		1471	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1472
		1473	=item $term->allow_events_sync
		1474
		1475	Calls XAllowEvents with SyncBoth for the most recent grab.
		1476
		1477	=item $term->allow_events_replay
		1478
		1479	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1480	recent grab.
		1481
		1482	=item $term->ungrab
		1483
		1484	Calls XUngrab for the most recent grab. Is called automatically on
		1485	evaluation errors, as it is better to lose the grab in the error case as
		1486	the session.
		1487
		1488	=back
		1489
		1490	=cut
		1491
		1492	package urxvt::popup;
		1493
		1494	=head2 The C<urxvt::popup> Class
		1495
		1496	=over 4
		1497
		1498	=cut
		1499
		1500	sub add_item {
		1501	my ($self, $item) = @_;
		1502
		1503	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1504	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1505	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1506
		1507	$item->{render} ||= sub { $_[0]{text} };
		1508
		1509	push @{ $self->{item} }, $item;
		1510	}
		1511
		1512	=item $popup->add_title ($title)
		1513
		1514	Adds a non-clickable title to the popup.
		1515
		1516	=cut
		1517
		1518	sub add_title {
		1519	my ($self, $title) = @_;
		1520
		1521	$self->add_item ({
		1522	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1523	text => $title,
		1524	activate => sub { },
		1525	});
		1526	}
		1527
		1528	=item $popup->add_separator ([$sepchr])
		1529
		1530	Creates a separator, optionally using the character given as C<$sepchr>.
		1531
		1532	=cut
		1533
		1534	sub add_separator {
		1535	my ($self, $sep) = @_;
		1536
		1537	$sep ||= "=";
		1538
		1539	$self->add_item ({
		1540	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1541	text => "",
		1542	render => sub { $sep x $self->{term}->ncol },
		1543	activate => sub { },
		1544	});
		1545	}
		1546
		1547	=item $popup->add_button ($text, $cb)
		1548
		1549	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1550	selected.
		1551
		1552	=cut
		1553
		1554	sub add_button {
		1555	my ($self, $text, $cb) = @_;
		1556
		1557	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1558	}
		1559
		1560	=item $popup->add_toggle ($text, $cb, $initial_value)
		1561
		1562	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1563	whenever it gets toggled, with a boolean indicating its value as its first
		1564	argument.
		1565
		1566	=cut
		1567
		1568	sub add_toggle {
		1569	my ($self, $text, $cb, $value) = @_;
		1570
		1571	my $item; $item = {
		1572	type => "button",
		1573	text => " $text",
		1574	value => $value,
		1575	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1576	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1577	};
		1578
		1579	$self->add_item ($item);
		1580	}
		1581
		1582	=item $popup->show
		1583
		1584	Displays the popup (which is initially hidden).
		1585
		1586	=cut
		1587
		1588	sub show {
		1589	my ($self) = @_;
		1590
		1591	local $urxvt::popup::self = $self;
		1592
		1593	my $env = $self->{term}->env;
		1594	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1595	delete $env->{LC_ALL};
		1596	$env->{LC_CTYPE} = $self->{term}->locale;
		1597
		1598	urxvt::term->new ($env, "popup",
		1599	"--perl-lib" => "", "--perl-ext-common" => "",
		1600	"-pty-fd" => -1, "-sl" => 0,
		1601	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		1602	"--transient-for" => $self->{term}->parent,
		1603	"-display" => $self->{term}->display_id,
		1604	"-pe" => "urxvt-popup")
		1605	or die "unable to create popup window\n";
		1606	}
		1607
		1608	sub DESTROY {
		1609	my ($self) = @_;
		1610
		1611	delete $self->{term}{_destroy}{$self};
		1612	$self->{term}->ungrab;
		1613	}
742		1614
743	=back	1615	=back
744		1616
745	=head2 The C<urxvt::timer> Class	1617	=head2 The C<urxvt::timer> Class
746		1618
…		…
787		1659
788	=item $timer = $timer->start ($tstamp)	1660	=item $timer = $timer->start ($tstamp)
789		1661
790	Set the event trigger time to C<$tstamp> and start the timer.	1662	Set the event trigger time to C<$tstamp> and start the timer.
791		1663
		1664	=item $timer = $timer->after ($delay)
		1665
		1666	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1667
792	=item $timer = $timer->stop	1668	=item $timer = $timer->stop
793		1669
794	Stop the timer.	1670	Stop the timer.
795		1671
796	=back	1672	=back
…		…
801		1677
802	$term->{socket} = ...	1678	$term->{socket} = ...
803	$term->{iow} = urxvt::iow	1679	$term->{iow} = urxvt::iow
804	->new	1680	->new
805	->fd (fileno $term->{socket})	1681	->fd (fileno $term->{socket})
806	->events (1) # wait for read data	1682	->events (urxvt::EVENT_READ)
807	->start	1683	->start
808	->cb (sub {	1684	->cb (sub {
809	my ($iow, $revents) = @_;	1685	my ($iow, $revents) = @_;
810	# $revents must be 1 here, no need to check	1686	# $revents must be 1 here, no need to check
811	sysread $term->{socket}, my $buf, 8192	1687	sysread $term->{socket}, my $buf, 8192
…		…
828		1704
829	Set the filedescriptor (not handle) to watch.	1705	Set the filedescriptor (not handle) to watch.
830		1706
831	=item $iow = $iow->events ($eventmask)	1707	=item $iow = $iow->events ($eventmask)
832		1708
833	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1709	Set the event mask to watch. The only allowed values are
834	data, Bit #1 (value C<2>) enables watching for write data.	1710	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1711	together, or C<urxvt::EVENT_NONE>.
835		1712
836	=item $iow = $iow->start	1713	=item $iow = $iow->start
837		1714
838	Start watching for requested events on the given handle.	1715	Start watching for requested events on the given handle.
839		1716
…		…
850	This variable controls the verbosity level of the perl extension. Higher	1727	This variable controls the verbosity level of the perl extension. Higher
851	numbers indicate more verbose output.	1728	numbers indicate more verbose output.
852		1729
853	=over 4	1730	=over 4
854		1731
855	=item 0 - only fatal messages	1732	=item == 0 - fatal messages
856		1733
857	=item 3 - script loading and management	1734	=item >= 3 - script loading and management
858		1735
859	=item 10 - all events received	1736	=item >=10 - all called hooks
		1737
		1738	=item >=11 - hook reutrn values
860		1739
861	=back	1740	=back
862		1741
863	=head1 AUTHOR	1742	=head1 AUTHOR
864		1743

Diff Legend

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