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.24 by root, Tue Jan 3 20:47:36 2006 UTC vs.
Revision 1.223 by root, Sat Jul 14 08:00:18 2012 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	Every time 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 "vars"' 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	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
32		33
33	This section describes the extensiosn delivered with this version. You can	34	=head1 PREPACKAGED EXTENSIONS
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	35
		36	A number of extensions are delivered with this release. You can find them
		37	in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed
		38	using F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	@@RXVT_NAME@@ -pe <extensionname>
39		43
40	=over 4	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	=item selection	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	Intelligent selection. This etxension tries to be more intelligent when the user	48	Extensions that add command line parameters or resources on their own are
45	extends selections (double-click).	49	loaded automatically when used.
46		50
47	It also offers the following bindable event:	51	=head1 API DOCUMENTATION
48
49	=over 4
50
51	=item rot13
52
53	Rot-13 the selection when activated. Used via keyboard trigger:
54
55	URxvt.keysym.C-M-r: perl:selection:rot13
56
57	=back
58
59	=item digital-clock
60
61	Displays a digital clock using the built-in overlay.
62
63	=item example-refresh-hooks
64
65	Displays a very simple digital clock in the upper right corner of the
66	window. Illustrates overwriting the refresh callbacks to create your own
67	overlays or changes.
68
69	=back
70		52
71	=head2 General API Considerations	53	=head2 General API Considerations
72		54
73	All objects (such as terminals, time watchers etc.) are typical	55	All objects (such as terminals, time watchers etc.) are typical
74	reference-to-hash objects. The hash can be used to store anything you	56	reference-to-hash objects. The hash can be used to store anything you
…		…
79	When objects are destroyed on the C++ side, the perl object hashes are	61	When objects are destroyed on the C++ side, the perl object hashes are
80	emptied, so its best to store related objects such as time watchers and	62	emptied, so its best to store related objects such as time watchers and
81	the like inside the terminal object so they get destroyed as soon as the	63	the like inside the terminal object so they get destroyed as soon as the
82	terminal is destroyed.	64	terminal is destroyed.
83		65
		66	Argument names also often indicate the type of a parameter. Here are some
		67	hints on what they mean:
		68
		69	=over 4
		70
		71	=item $text
		72
		73	Rxvt-unicode's special way of encoding text, where one "unicode" character
		74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
		75
		76	=item $string
		77
		78	A perl text string, with an emphasis on I<text>. It can store all unicode
		79	characters and is to be distinguished with text encoded in a specific
		80	encoding (often locale-specific) and binary data.
		81
		82	=item $octets
		83
		84	Either binary data or - more common - a text string encoded in a
		85	locale-specific way.
		86
		87	=item $keysym
		88
		89	an integer that is a valid X11 keysym code. You can convert a string
		90	into a keysym and viceversa by using C<XStringToKeysym> and
		91	C<XKeysymToString>.
		92
		93	=back
		94
		95	=head2 Extension Objects
		96
		97	Every perl extension is a perl class. A separate perl object is created
		98	for each terminal, and each terminal has its own set of extension objects,
		99	which are passed as the first parameter to hooks. So extensions can use
		100	their C<$self> object without having to think about clashes with other
		101	extensions or other terminals, with the exception of methods and members
		102	that begin with an underscore character C<_>: these are reserved for
		103	internal use.
		104
		105	Although it isn't a C<urxvt::term> object, you can call all methods of the
		106	C<urxvt::term> class on this object.
		107
		108	Additional methods only supported for extension objects are described in
		109	the C<urxvt::extension> section below.
		110
84	=head2 Hooks	111	=head2 Hooks
85		112
86	The following subroutines can be declared in loaded scripts, and will be	113	The following subroutines can be declared in extension files, and will be
87	called whenever the relevant event happens.	114	called whenever the relevant event happens.
88		115
89	The first argument passed to them is an object private to each terminal	116	The first argument passed to them is an extension object as described in
90	and extension package. You can call all C<urxvt::term> methods on it, but	117	the in the C<Extension Objects> section.
91	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
92	object that is shared between all packages is stored in the C<term>
93	member.
94		118
95	All of them must return a boolean value. If it is true, then the event	119	B<All> of these hooks must return a boolean value. If any of the called
96	counts as being I<consumed>, and the invocation of other hooks is skipped,	120	hooks returns true, then the event counts as being I<consumed>, and the
97	and the relevant action might not be carried out by the C++ code.	121	relevant action might not be carried out by the C++ code.
98		122
99	When in doubt, return a false value (preferably C<()>).	123	I<< When in doubt, return a false value (preferably C<()>). >>
100		124
101	=over 4	125	=over 4
102		126
103	=item on_init $term	127	=item on_init $term
104		128
105	Called after a new terminal object has been initialized, but before	129	Called after a new terminal object has been initialized, but before
106	windows are created or the command gets run.	130	windows are created or the command gets run. Most methods are unsafe to
		131	call or deliver senseless data, as terminal size and other characteristics
		132	have not yet been determined. You can safely query and change resources
		133	and options, though. For many purposes the C<on_start> hook is a better
		134	place.
		135
		136	=item on_start $term
		137
		138	Called at the very end of initialisation of a new terminal, just before
		139	trying to map (display) the toplevel and returning to the main loop.
		140
		141	=item on_destroy $term
		142
		143	Called whenever something tries to destroy terminal, when the terminal is
		144	still fully functional (not for long, though).
107		145
108	=item on_reset $term	146	=item on_reset $term
109		147
110	Called after the screen is "reset" for any reason, such as resizing or	148	Called after the screen is "reset" for any reason, such as resizing or
111	control sequences. Here is where you can react on changes to size-related	149	control sequences. Here is where you can react on changes to size-related
112	variables.	150	variables.
113		151
114	=item on_start $term	152	=item on_child_start $term, $pid
115		153
116	Called at the very end of initialisation of a new terminal, just before	154	Called just after the child process has been C<fork>ed.
117	returning to the mainloop.	155
		156	=item on_child_exit $term, $status
		157
		158	Called just after the child process has exited. C<$status> is the status
		159	from C<waitpid>.
118		160
119	=item on_sel_make $term, $eventtime	161	=item on_sel_make $term, $eventtime
120		162
121	Called whenever a selection has been made by the user, but before the	163	Called whenever a selection has been made by the user, but before the
122	selection text is copied, so changes to the beginning, end or type of the	164	selection text is copied, so changes to the beginning, end or type of the
…		…
129		171
130	Called whenever a selection has been copied, but before the selection is	172	Called whenever a selection has been copied, but before the selection is
131	requested from the server. The selection text can be queried and changed	173	requested from the server. The selection text can be queried and changed
132	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
133		175
134	Returning a true value aborts selection grabbing. It will still be hilighted.	176	Returning a true value aborts selection grabbing. It will still be highlighted.
135		177
136	=item on_sel_extend $term	178	=item on_sel_extend $term
137		179
138	Called whenever the user tries to extend the selection (e.g. with a double	180	Called whenever the user tries to extend the selection (e.g. with a double
139	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
140	should extend the selection itelf and return true to suppress the built-in	182	should extend the selection itself and return true to suppress the built-in
141	processing.	183	processing. This can happen multiple times, as long as the callback
		184	returns true, it will be called on every further click by the user and is
		185	supposed to enlarge the selection more and more, if possible.
142		186
143	See the F<selection> example extension.	187	See the F<selection> example extension.
144		188
145	=item on_focus_in $term
146
147	Called whenever the window gets the keyboard focus, before urxvt does
148	focus in processing.
149
150	=item on_focus_out $term
151
152	Called wheneever the window loses keyboard focus, before urxvt does focus
153	out processing.
154
155	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
156		190
157	Called whenever the view offset changes, i..e the user or program	191	Called whenever the view offset changes, i.e. the user or program
158	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
159	show this many lines of scrollback.	193	show this many lines of scrollback.
160		194
161	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
162		196
…		…
166		200
167	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
168	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
169	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
170		204
171	=item on_tty_activity $term *NYI*	205	=item on_osc_seq $term, $op, $args, $resp
172		206
173	Called whenever the program(s) running in the urxvt window send output.	207	Called on every OSC sequence and can be used to suppress it or modify its
		208	behaviour. The default should be to return an empty list. A true value
		209	suppresses execution of the request completely. Make sure you don't get
		210	confused by recursive invocations when you output an OSC sequence within
		211	this callback.
		212
		213	C<on_osc_seq_perl> should be used for new behaviour.
		214
		215	=item on_osc_seq_perl $term, $args, $resp
		216
		217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		218	operating system command) is processed. Cursor position and other state
		219	information is up-to-date when this happens. For interoperability, the
		220	string should start with the extension name (sans -osc) and a semicolon,
		221	to distinguish it from commands for other extensions, and this might be
		222	enforced in the future.
		223
		224	For example, C<overlay-osc> uses this:
		225
		226	sub on_osc_seq_perl {
		227	my ($self, $osc, $resp) = @_;
		228
		229	return unless $osc =~ s/^overlay;//;
		230
		231	... process remaining $osc string
		232	}
		233
		234	Be careful not ever to trust (in a security sense) the data you receive,
		235	as its source can not easily be controlled (e-mail content, messages from
		236	other users on the same system etc.).
		237
		238	For responses, C<$resp> contains the end-of-args separator used by the
		239	sender.
		240
		241	=item on_add_lines $term, $string
		242
		243	Called whenever text is about to be output, with the text as argument. You
		244	can filter/change and output the text yourself by returning a true value
		245	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		246	might be very slow, however, as your hook is called for B<all> text being
		247	output.
		248
		249	=item on_tt_write $term, $octets
		250
		251	Called whenever some data is written to the tty/pty and can be used to
		252	suppress or filter tty input.
		253
		254	=item on_tt_paste $term, $octets
		255
		256	Called whenever text is about to be pasted, with the text as argument. You
		257	can filter/change and paste the text yourself by returning a true value
		258	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		259	locale-encoded.
		260
		261	=item on_line_update $term, $row
		262
		263	Called whenever a line was updated or changed. Can be used to filter
		264	screen output (e.g. underline urls or other useless stuff). Only lines
		265	that are being shown will be filtered, and, due to performance reasons,
		266	not always immediately.
		267
		268	The row number is always the topmost row of the line if the line spans
		269	multiple rows.
		270
		271	Please note that, if you change the line, then the hook might get called
		272	later with the already-modified line (e.g. if unrelated parts change), so
		273	you cannot just toggle rendition bits, but only set them.
174		274
175	=item on_refresh_begin $term	275	=item on_refresh_begin $term
176		276
177	Called just before the screen gets redrawn. Can be used for overlay	277	Called just before the screen gets redrawn. Can be used for overlay or
178	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
179	restoring them in refresh_end. The built-in overlay and selection display	279	restoring them in refresh_end. The built-in overlay and selection display
180	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
181		281
182	=item on_refresh_end $term	282	=item on_refresh_end $term
183		283
184	Called just after the screen gets redrawn. See C<on_refresh_begin>.	284	Called just after the screen gets redrawn. See C<on_refresh_begin>.
185		285
186	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string
187		287
188	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
189	C<perl:string> action bound to it (see description of the B<keysym>	289	a C<perl:string> action bound to a key, see description of the B<keysym>
190	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the @@RXVT_NAME@@(1) manpage).
191		291
		292	The event is simply the action string. This interface is assumed to change
		293	slightly in the future.
		294
		295	=item on_register_command $term, $keysym, $modifiermask, $string
		296
		297	Called after parsing a keysym resource but before registering the
		298	associated binding. If this hook returns TRUE the binding is not
		299	registered. It can be used to modify a binding by calling
		300	C<register_command>.
		301
		302	=item on_resize_all_windows $term, $new_width, $new_height
		303
		304	Called just after the new window size has been calculated, but before
		305	windows are actually being resized or hints are being set. If this hook
		306	returns TRUE, setting of the window hints is being skipped.
		307
		308	=item on_x_event $term, $event
		309
		310	Called on every X event received on the vt window (and possibly other
		311	windows). Should only be used as a last resort. Most event structure
		312	members are not passed.
		313
		314	=item on_root_event $term, $event
		315
		316	Like C<on_x_event>, but is called for events on the root window.
		317
		318	=item on_focus_in $term
		319
		320	Called whenever the window gets the keyboard focus, before rxvt-unicode
		321	does focus in processing.
		322
		323	=item on_focus_out $term
		324
		325	Called whenever the window loses keyboard focus, before rxvt-unicode does
		326	focus out processing.
		327
		328	=item on_configure_notify $term, $event
		329
		330	=item on_property_notify $term, $event
		331
		332	=item on_key_press $term, $event, $keysym, $octets
		333
		334	=item on_key_release $term, $event, $keysym
		335
		336	=item on_button_press $term, $event
		337
		338	=item on_button_release $term, $event
		339
		340	=item on_motion_notify $term, $event
		341
		342	=item on_map_notify $term, $event
		343
		344	=item on_unmap_notify $term, $event
		345
		346	Called whenever the corresponding X event is received for the terminal. If
		347	the hook returns true, then the event will be ignored by rxvt-unicode.
		348
		349	The event is a hash with most values as named by Xlib (see the XEvent
		350	manpage), with the additional members C<row> and C<col>, which are the
		351	(real, not screen-based) row and column under the mouse cursor.
		352
		353	C<on_key_press> additionally receives the string rxvt-unicode would
		354	output, if any, in locale-specific encoding.
		355
		356	subwindow.
		357
		358	=item on_client_message $term, $event
		359
		360	=item on_wm_protocols $term, $event
		361
		362	=item on_wm_delete_window $term, $event
		363
		364	Called when various types of ClientMessage events are received (all with
		365	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		366
		367	=item on_bell $term
		368
		369	Called on receipt of a bell character.
		370
192	=back	371	=back
193		372
		373	=cut
		374
		375	package urxvt;
		376
		377	use utf8;
		378	use strict 'vars';
		379	use Carp ();
		380	use Scalar::Util ();
		381	use List::Util ();
		382
		383	our $VERSION = 1;
		384	our $TERM;
		385	our @TERM_INIT; # should go, prevents async I/O etc.
		386	our @TERM_EXT; # should go, prevents async I/O etc.
		387	our @HOOKNAME;
		388	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		389	our %OPTION;
		390
		391	our $LIBDIR;
		392	our $RESNAME;
		393	our $RESCLASS;
		394	our $RXVTNAME;
		395
		396	our $NOCHAR = chr 0xffff;
		397
194	=head2 Variables in the C<urxvt> Package	398	=head2 Variables in the C<urxvt> Package
195		399
196	=over 4	400	=over 4
197		401
		402	=item $urxvt::LIBDIR
		403
		404	The rxvt-unicode library directory, where, among other things, the perl
		405	modules and scripts are stored.
		406
		407	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		408
		409	The resource class and name rxvt-unicode uses to look up X resources.
		410
		411	=item $urxvt::RXVTNAME
		412
		413	The basename of the installed binaries, usually C<urxvt>.
		414
198	=item $urxvt::TERM	415	=item $urxvt::TERM
199		416
200	The current terminal. Whenever a callback/Hook is bein executed, this	417	The current terminal. This variable stores the current C<urxvt::term>
201	variable stores the current C<urxvt::term> object.	418	object, whenever a callback/hook is executing.
		419
		420	=item @urxvt::TERM_INIT
		421
		422	All code references in this array will be called as methods of the next newly
		423	created C<urxvt::term> object (during the C<on_init> phase). The array
		424	gets cleared before the code references that were in it are being executed,
		425	so references can push themselves onto it again if they so desire.
		426
		427	This complements to the perl-eval command line option, but gets executed
		428	first.
		429
		430	=item @urxvt::TERM_EXT
		431
		432	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		433	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		434	but before other extensions. Gets cleared just like C<@TERM_INIT>.
202		435
203	=back	436	=back
204		437
205	=head2 Functions in the C<urxvt> Package	438	=head2 Functions in the C<urxvt> Package
206		439
207	=over 4	440	=over 4
208		441
209	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
210		443
211	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
212	costs! The only time this is acceptable is when the terminal process	445	include a trailing newline). Avoid at all costs! The only time this
213	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
214		448
215	=item urxvt::warn $string	449	=item urxvt::warn $string
216		450
217	Calls C<rxvt_warn> with the given string which should not include a	451	Calls C<rxvt_warn> with the given string which should include a trailing
218	newline. The module also overwrites the C<warn> builtin with a function	452	newline. The module also overwrites the C<warn> builtin with a function
219	that calls this function.	453	that calls this function.
220		454
221	Using this function has the advantage that its output ends up in the	455	Using this function has the advantage that its output ends up in the
222	correct place, e.g. on stderr of the connecting urxvtc client.	456	correct place, e.g. on stderr of the connecting urxvtc client.
223		457
		458	Messages have a size limit of 1023 bytes currently.
		459
		460	=item @terms = urxvt::termlist
		461
		462	Returns all urxvt::term objects that exist in this process, regardless of
		463	whether they are started, being destroyed etc., so be careful. Only term
		464	objects that have perl extensions attached will be returned (because there
		465	is no urxvt::term object associated with others).
		466
224	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
225		468
226	Returns the "current time" (as per the event loop).	469	Returns the "current time" (as per the event loop).
		470
		471	=item urxvt::CurrentTime
		472
		473	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		474	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		475	Button4Mask, Button5Mask, AnyModifier
		476
		477	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		478	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		479	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		480	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		481	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		482	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		483	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		484
		485	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		486	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		487	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		488	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		489	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		490	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		491	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		492
		493	Various constants for use in X calls and event processing.
227		494
228	=back	495	=back
229		496
230	=head2 RENDITION	497	=head2 RENDITION
231		498
…		…
246		513
247	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
248		515
249	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
250		517
251	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	518	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		519	urxvt::RS_RVid, urxvt::RS_Uline
252		520
253	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
254	underline, respectively. To enable such a style, just logically OR it into	522	underline, respectively. To enable such a style, just logically OR it into
255	the bitset.	523	the bitset.
256		524
…		…
258		526
259	=item $background = urxvt::GET_BASEBG $rend	527	=item $background = urxvt::GET_BASEBG $rend
260		528
261	Return the foreground/background colour index, respectively.	529	Return the foreground/background colour index, respectively.
262		530
263	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	531	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
264		532
265	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	533	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		534
		535	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
266		536
267	Replace the foreground/background colour in the rendition mask with the	537	Replace the foreground/background colour in the rendition mask with the
268	specified one.	538	specified one.
269		539
270	=item $value = urxvt::GET_CUSTOM ($rend)	540	=item $value = urxvt::GET_CUSTOM $rend
271		541
272	Return the "custom" value: Every rendition has 5 bits for use by	542	Return the "custom" value: Every rendition has 5 bits for use by
273	extensions. They can be set and changed as you like and are initially	543	extensions. They can be set and changed as you like and are initially
274	zero.	544	zero.
275		545
276	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	546	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
277		547
278	Change the custom value.	548	Change the custom value.
279		549
280	=back	550	=back
281		551
282	=cut	552	=cut
283		553
284	package urxvt;
285
286	use strict;
287	use Scalar::Util ();
288
289	our $TERM;
290	our @HOOKNAME;
291	our $LIBDIR;
292
293	BEGIN {	554	BEGIN {
294	urxvt->bootstrap;
295
296	# overwrite perl's warn	555	# overwrite perl's warn
297	*CORE::GLOBAL::warn = sub {	556	*CORE::GLOBAL::warn = sub {
298	my $msg = join "", @_;	557	my $msg = join "", @_;
299	$msg .= "\n"	558	$msg .= "\n"
300	unless $msg =~ /\n$/;	559	unless $msg =~ /\n$/;
301	urxvt::warn ($msg);	560	urxvt::warn ($msg);
302	};	561	};
303	}	562	}
304		563
305	my @hook_count;	564	no warnings 'utf8';
		565
		566	sub parse_resource {
		567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		568
		569	$name =~ y/-/./ if $isarg;
		570
		571	$term->scan_meta;
		572
		573	my $r = $term->{meta}{resource};
		574	keys %$r; # reste iterator
		575	while (my ($pattern, $v) = each %$r) {
		576	if (
		577	$pattern =~ /\.$/
		578	? $pattern eq substr $name, 0, length $pattern
		579	: $pattern eq $name
		580	) {
		581	$name = "$urxvt::RESCLASS.$name";
		582
		583	push @{ $term->{perl_ext_3} }, $v->[0];
		584
		585	if ($v->[1] eq "boolean") {
		586	$term->put_option_db ($name, $flag ? "true" : "false");
		587	return 1;
		588	} else {
		589	$term->put_option_db ($name, $value);
		590	return 1 + 2;
		591	}
		592	}
		593	}
		594
		595	0
		596	}
		597
		598	sub usage {
		599	my ($term, $usage_type) = @_;
		600
		601	$term->scan_meta;
		602
		603	my $r = $term->{meta}{resource};
		604
		605	for my $pattern (sort keys %$r) {
		606	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		607
		608	$desc .= " (-pe $ext)";
		609
		610	if ($usage_type == 1) {
		611	$pattern =~ y/./-/;
		612	$pattern =~ s/-$/-.../g;
		613
		614	if ($type eq "boolean") {
		615	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		616	} else {
		617	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		618	}
		619	} else {
		620	$pattern =~ s/\.$/.*/g;
		621	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		622	}
		623	}
		624	}
		625
306	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
307		627
308	sub verbose {	628	sub verbose {
309	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
310	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
311	}	631	}
312		632
313	# find on_xxx subs in the package and register them	633	my %extension_pkg;
314	# as hooks
315	sub register_package($) {
316	my ($pkg) = @_;
317
318	for my $htype (0.. $#HOOKNAME) {
319	my $name = $HOOKNAME[$htype];
320
321	my $ref = $pkg->can ("on_" . lc $name)
322	or next;
323
324	$TERM->{_hook}[$htype]{$pkg} = $ref;
325	$hook_count[$htype]++
326	or set_should_invoke $htype, 1;
327	}
328	}
329
330	my $script_pkg = "script0000";
331	my %script_pkg;
332		634
333	# load a single script into its own package, once only	635	# load a single script into its own package, once only
334	sub script_package($) {	636	sub extension_package($) {
335	my ($path) = @_;	637	my ($path) = @_;
336		638
337	$script_pkg{$path} ||= do {	639	$extension_pkg{$path} ||= do {
338	my $pkg = "urxvt::" . ($script_pkg++);	640	$path =~ /([^\/\\]+)$/;
		641	my $pkg = $1;
		642	$pkg =~ s/[^[:word:]]/_/g;
		643	$pkg = "urxvt::ext::$pkg";
339		644
340	verbose 3, "loading script '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
341		648
342	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
343	or die "$path: $!";	650	or die "$path: $!";
344		651
345	my $source = "package $pkg; use strict; use utf8;\n"	652	my $source =
		653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
346	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
347	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
348	. "\n};\n1";	656	. "\n};\n1";
349		657
		658	eval $source
350	eval $source or die "$path: $@";	659	or die "$path: $@";
351		660
352	$pkg	661	$pkg
353	}	662	}
354	}	663	}
		664
		665	our $retval; # return value for urxvt
355		666
356	# called by the rxvt core	667	# called by the rxvt core
357	sub invoke {	668	sub invoke {
358	local $TERM = shift;	669	local $TERM = shift;
359	my $htype = shift;	670	my $htype = shift;
360		671
361	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
363		674
364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	675	my %ext_arg;
		676
		677	{
		678	my @init = @TERM_INIT;
		679	@TERM_INIT = ();
		680	$_->($TERM) for @init;
		681	my @pkg = @TERM_EXT;
		682	@TERM_EXT = ();
		683	$TERM->register_package ($_) for @pkg;
		684	}
		685
		686	for (
		687	@{ delete $TERM->{perl_ext_3} },
		688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		689	) {
		690	if ($_ eq "default") {
		691	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
		692	} elsif (/^-(.*)$/) {
		693	delete $ext_arg{$1};
		694	} elsif (/^([^<]+)<(.*)>$/) {
		695	push @{ $ext_arg{$1} }, $2;
		696	} else {
		697	$ext_arg{$_} ||= [];
		698	}
		699	}
		700
		701	for my $ext (sort keys %ext_arg) {
365	my @files = grep -f $_, map "$_/$ext", @dirs;	702	my @files = grep -f $_, map "$_/$ext", @dirs;
366		703
367	if (@files) {	704	if (@files) {
368	register_package script_package $files[0];	705	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
369	} else {	706	} else {
370	warn "perl extension '$ext' not found in perl library search path\n";	707	warn "perl extension '$ext' not found in perl library search path\n";
371	}	708	}
372	}	709	}
373		710
		711	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		712	warn $@ if $@;
		713	}
		714
		715	$retval = undef;
		716
		717	if (my $cb = $TERM->{_hook}[$htype]) {
		718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		719	if $verbosity >= 10;
		720
		721	for my $pkg (keys %$cb) {
		722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
		723	$retval ||= $retval_;
		724
		725	if ($@) {
		726	$TERM->ungrab; # better to lose the grab than the session
		727	warn $@;
		728	}
		729	}
		730
		731	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		732	if $verbosity >= 11;
		733	}
		734
374	} elsif ($htype == 1) { # DESTROY	735	if ($htype == 1) { # DESTROY
375	if (my $hook = $TERM->{_hook}) {	736	# clear package objects
376	for my $htype (0..$#$hook) {	737	%$_ = () for values %{ $TERM->{_pkg} };
377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }	738
378	or set_should_invoke $htype, 0;	739	# clear package
		740	%$TERM = ();
		741	}
		742
		743	$retval
		744	}
		745
		746	sub SET_COLOR($$$) {
		747	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		748	}
		749
		750	sub rend2mask {
		751	no strict 'refs';
		752	my ($str, $mask) = (@_, 0);
		753	my %color = ( fg => undef, bg => undef );
		754	my @failed;
		755	for my $spec ( split /\s+/, $str ) {
		756	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		757	$color{lc($1)} = $2;
		758	} else {
		759	my $neg = $spec =~ s/^[-^]//;
		760	unless ( exists &{"RS_$spec"} ) {
		761	push @failed, $spec;
		762	next;
		763	}
		764	my $cur = &{"RS_$spec"};
		765	if ( $neg ) {
		766	$mask &= ~$cur;
		767	} else {
		768	$mask |= $cur;
379	}	769	}
380	}	770	}
381	}	771	}
382		772	($mask, @color{qw(fg bg)}, \@failed)
383	my $cb = $TERM->{_hook}[$htype]
384	or return;
385
386	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
387	if $verbosity >= 10;
388
389	while (my ($pkg, $cb) = each %$cb) {
390	return 1
391	if $cb->(
392	$TERM->{$pkg} ||= do {
393	my $proxy = bless { }, urxvt::term::proxy::;
394	Scalar::Util::weaken ($proxy->{term} = $TERM);
395	$proxy
396	},
397	@_,
398	);
399	}
400
401	0
402	}	773	}
403		774
404	sub urxvt::term::proxy::AUTOLOAD {	775	package urxvt::term::extension;
405	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	776
		777	=head2 The C<urxvt::term::extension> class
		778
		779	Each extension attached to a terminal object is represented by
		780	a C<urxvt::term::extension> object.
		781
		782	You can use these objects, which are passed to all callbacks to store any
		783	state related to the terminal and extension instance.
		784
		785	The methods (And data members) documented below can be called on extension
		786	objects, in addition to call methods documented for the <urxvt::term>
		787	class.
		788
		789	=over 4
		790
		791	=item $urxvt_term = $self->{term}
		792
		793	Returns the C<urxvt::term> object associated with this instance of the
		794	extension. This member I<must not> be changed in any way.
		795
		796	=cut
		797
		798	our $AUTOLOAD;
		799
		800	sub AUTOLOAD {
		801	$AUTOLOAD =~ /:([^:]+)$/
406	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	802	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
407		803
408	eval qq{	804	eval qq{
409	sub $urxvt::term::proxy::AUTOLOAD {	805	sub $AUTOLOAD {
410	my \$proxy = shift;	806	my \$proxy = shift;
411	\$proxy->{term}->$1 (\@_)	807	\$proxy->{term}->$1 (\@_)
412	}	808	}
413	1	809	1
414	} or die "FATAL: unable to compile method forwarder: $@";	810	} or die "FATAL: unable to compile method forwarder: $@";
415		811
416	goto &$urxvt::term::proxy::AUTOLOAD;	812	goto &$AUTOLOAD;
417	}	813	}
		814
		815	sub DESTROY {
		816	# nop
		817	}
		818
		819	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
		820
		821	sub urxvt::destroy_hook::DESTROY {
		822	${$_[0]}->();
		823	}
		824
		825	sub urxvt::destroy_hook(&) {
		826	bless \shift, urxvt::destroy_hook::
		827	}
		828
		829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		830
		831	Dynamically enable the given hooks (named without the C<on_> prefix) for
		832	this extension, replacing any previous hook. This is useful when you want
		833	to overwrite time-critical hooks only temporarily.
		834
		835	To install additional callbacks for the same hook, you can use the C<on>
		836	method of the C<urxvt::term> class.
		837
		838	=item $self->disable ($hook_name[, $hook_name..])
		839
		840	Dynamically disable the given hooks.
		841
		842	=cut
		843
		844	sub enable {
		845	my ($self, %hook) = @_;
		846	my $pkg = $self->{_pkg};
		847
		848	while (my ($name, $cb) = each %hook) {
		849	my $htype = $HOOKTYPE{uc $name};
		850	defined $htype
		851	or Carp::croak "unsupported hook type '$name'";
		852
		853	$self->set_should_invoke ($htype, +1)
		854	unless exists $self->{term}{_hook}[$htype]{$pkg};
		855
		856	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		857	}
		858	}
		859
		860	sub disable {
		861	my ($self, @hook) = @_;
		862	my $pkg = $self->{_pkg};
		863
		864	for my $name (@hook) {
		865	my $htype = $HOOKTYPE{uc $name};
		866	defined $htype
		867	or Carp::croak "unsupported hook type '$name'";
		868
		869	$self->set_should_invoke ($htype, -1)
		870	if delete $self->{term}{_hook}[$htype]{$pkg};
		871	}
		872	}
		873
		874	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		875
		876	Similar to the C<enable> enable, but installs additional callbacks for
		877	the given hook(s) (that is, it doesn't replace existing callbacks), and
		878	returns a guard object. When the guard object is destroyed the callbacks
		879	are disabled again.
		880
		881	=cut
		882
		883	sub urxvt::extension::on_disable::DESTROY {
		884	my $disable = shift;
		885
		886	my $term = delete $disable->{""};
		887
		888	while (my ($htype, $id) = each %$disable) {
		889	warn "disable hook $htype,$id\n";#d#
		890	delete $term->{_hook}[$htype]{$id};
		891	$term->set_should_invoke ($htype, -1);
		892	}
		893	}
		894
		895	sub on {
		896	my ($self, %hook) = @_;
		897
		898	my $term = $self->{term};
		899
		900	my %disable = ( "" => $term );
		901
		902	while (my ($name, $cb) = each %hook) {
		903	my $htype = $HOOKTYPE{uc $name};
		904	defined $htype
		905	or Carp::croak "unsupported hook type '$name'";
		906
		907	$term->set_should_invoke ($htype, +1);
		908	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		909	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		910	}
		911
		912	bless \%disable, "urxvt::extension::on_disable"
		913	}
		914
		915	=item $self->x_resource ($pattern)
		916
		917	=item $self->x_resource_boolean ($pattern)
		918
		919	These methods support an additional C<%> prefix when called on an
		920	extension object - see the description of these methods in the
		921	C<urxvt::term> class for details.
		922
		923	=cut
		924
		925	sub x_resource {
		926	my ($self, $name) = @_;
		927	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		928	$self->{term}->x_resource ($name)
		929	}
		930
		931	sub x_resource_boolean {
		932	my ($self, $name) = @_;
		933	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		934	$self->{term}->x_resource_boolean ($name)
		935	}
		936
		937	=back
		938
		939	=cut
		940
		941	package urxvt::anyevent;
		942
		943	=head2 The C<urxvt::anyevent> Class
		944
		945	The sole purpose of this class is to deliver an interface to the
		946	C<AnyEvent> module - any module using it will work inside urxvt without
		947	further programming. The only exception is that you cannot wait on
		948	condition variables, but non-blocking condvar use is ok.
		949
		950	In practical terms this means is that you cannot use blocking APIs, but
		951	the non-blocking variant should work.
		952
		953	=cut
		954
		955	our $VERSION = '5.23';
		956
		957	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		958	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		959
		960	sub timer {
		961	my ($class, %arg) = @_;
		962
		963	my $cb = $arg{cb};
		964
		965	urxvt::timer
		966	->new
		967	->after ($arg{after}, $arg{interval})
		968	->cb ($arg{interval} ? $cb : sub {
		969	$_[0]->stop; # need to cancel manually
		970	$cb->();
		971	})
		972	}
		973
		974	sub io {
		975	my ($class, %arg) = @_;
		976
		977	my $cb = $arg{cb};
		978	my $fd = fileno $arg{fh};
		979	defined $fd or $fd = $arg{fh};
		980
		981	bless [$arg{fh}, urxvt::iow
		982	->new
		983	->fd ($fd)
		984	->events (($arg{poll} =~ /r/ ? 1 : 0)
		985	| ($arg{poll} =~ /w/ ? 2 : 0))
		986	->start
		987	->cb ($cb)
		988	], urxvt::anyevent::
		989	}
		990
		991	sub idle {
		992	my ($class, %arg) = @_;
		993
		994	my $cb = $arg{cb};
		995
		996	urxvt::iw
		997	->new
		998	->start
		999	->cb ($cb)
		1000	}
		1001
		1002	sub child {
		1003	my ($class, %arg) = @_;
		1004
		1005	my $cb = $arg{cb};
		1006
		1007	urxvt::pw
		1008	->new
		1009	->start ($arg{pid})
		1010	->cb (sub {
		1011	$_[0]->stop; # need to cancel manually
		1012	$cb->($_[0]->rpid, $_[0]->rstatus);
		1013	})
		1014	}
		1015
		1016	sub DESTROY {
		1017	$_[0][1]->stop;
		1018	}
		1019
		1020	# only needed for AnyEvent < 6 compatibility
		1021	sub one_event {
		1022	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1023	}
		1024
		1025	package urxvt::term;
418		1026
419	=head2 The C<urxvt::term> Class	1027	=head2 The C<urxvt::term> Class
420		1028
421	=over 4	1029	=over 4
		1030
		1031	=cut
		1032
		1033	# find on_xxx subs in the package and register them
		1034	# as hooks
		1035	sub register_package {
		1036	my ($self, $pkg, $argv) = @_;
		1037
		1038	no strict 'refs';
		1039
		1040	urxvt::verbose 6, "register package $pkg to $self";
		1041
		1042	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1043
		1044	my $proxy = bless {
		1045	_pkg => $pkg,
		1046	_name => ${"$pkg\::_NAME"}, # hackish
		1047	argv => $argv,
		1048	}, $pkg;
		1049	Scalar::Util::weaken ($proxy->{term} = $self);
		1050
		1051	$self->{_pkg}{$pkg} = $proxy;
		1052
		1053	for my $name (@HOOKNAME) {
		1054	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1055	$proxy->enable ($name => $ref);
		1056	}
		1057	}
		1058	}
		1059
		1060	sub perl_libdirs {
		1061	map { split /:/ }
		1062	$_[0]->resource ("perl_lib"),
		1063	$ENV{URXVT_PERL_LIB},
		1064	"$ENV{HOME}/.urxvt/ext",
		1065	"$LIBDIR/perl"
		1066	}
		1067
		1068	sub scan_meta {
		1069	my ($self) = @_;
		1070	my @libdirs = perl_libdirs $self;
		1071
		1072	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1073
		1074	my %meta;
		1075
		1076	$self->{meta_libdirs} = join "\x00", @libdirs;
		1077	$self->{meta} = \%meta;
		1078
		1079	for my $dir (reverse @libdirs) {
		1080	opendir my $fh, $dir
		1081	or next;
		1082	for my $ext (readdir $fh) {
		1083	$ext ne "."
		1084	and $ext ne ".."
		1085	and open my $fh, "<", "$dir/$ext"
		1086	or next;
		1087
		1088	while (<$fh>) {
		1089	if (/^#:META:X_RESOURCE:(.*)/) {
		1090	my ($pattern, $type, $desc) = split /:/, $1;
		1091	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1092	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1093	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1094	} else {
		1095	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1096	}
		1097	} elsif (/^\s*(?:#|$)/) {
		1098	# skip other comments and empty lines
		1099	} else {
		1100	last; # stop parsing on first non-empty non-comment line
		1101	}
		1102	}
		1103	}
		1104	}
		1105	}
		1106
		1107	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1108
		1109	Creates a new terminal, very similar as if you had started it with system
		1110	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1111	hash which defines the environment of the new terminal.
		1112
		1113	Croaks (and probably outputs an error message) if the new instance
		1114	couldn't be created. Returns C<undef> if the new instance didn't
		1115	initialise perl, and the terminal object otherwise. The C<init> and
		1116	C<start> hooks will be called before this call returns, and are free to
		1117	refer to global data (which is race free).
		1118
		1119	=cut
		1120
		1121	sub new {
		1122	my ($class, $env, @args) = @_;
		1123
		1124	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1125	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1126
		1127	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1128	}
		1129
		1130	=item $term->destroy
		1131
		1132	Destroy the terminal object (close the window, free resources
		1133	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1134	watchers (timers, io watchers) are still active.
		1135
		1136	=item $term->exec_async ($cmd[, @args])
		1137
		1138	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1139	("starts") programs in the background. This function takes care of setting
		1140	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1141	be preferred over explicit calls to C<exec> or C<system>.
		1142
		1143	Returns the pid of the subprocess or C<undef> on error.
		1144
		1145	=cut
		1146
		1147	sub exec_async {
		1148	my $self = shift;
		1149
		1150	my $pid = fork;
		1151
		1152	return $pid
		1153	if !defined $pid or $pid;
		1154
		1155	%ENV = %{ $self->env };
		1156
		1157	exec @_;
		1158	urxvt::_exit 255;
		1159	}
		1160
		1161	=item $isset = $term->option ($optval[, $set])
		1162
		1163	Returns true if the option specified by C<$optval> is enabled, and
		1164	optionally change it. All option values are stored by name in the hash
		1165	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		1166
		1167	Here is a likely non-exhaustive list of option names, please see the
		1168	source file F</src/optinc.h> to see the actual list:
		1169
		1170	borderLess buffered console cursorBlink cursorUnderline hold iconic
		1171	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1172	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
		1173	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
		1174	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
		1175	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1176	urgentOnBell utmpInhibit visualBell
422		1177
423	=item $value = $term->resource ($name[, $newval])	1178	=item $value = $term->resource ($name[, $newval])
424		1179
425	Returns the current resource value associated with a given name and	1180	Returns the current resource value associated with a given name and
426	optionally sets a new value. Setting values is most useful in the C<init>	1181	optionally sets a new value. Setting values is most useful in the C<init>
…		…
435	likely change).	1190	likely change).
436		1191
437	Please note that resource strings will currently only be freed when the	1192	Please note that resource strings will currently only be freed when the
438	terminal is destroyed, so changing options frequently will eat memory.	1193	terminal is destroyed, so changing options frequently will eat memory.
439		1194
440	Here is a a likely non-exhaustive list of resource names, not all of which	1195	Here is a likely non-exhaustive list of resource names, not all of which
441	are supported in every build, please see the source to see the actual	1196	are supported in every build, please see the source file F</src/rsinc.h>
442	list:	1197	to see the actual list:
443		1198
444	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1199	answerbackstring backgroundPixmap backspace_key blurradius
445	borderLess color cursorBlink cursorUnderline cutchars delete_key	1200	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
446	display_name embed ext_bwidth fade font geometry hold iconName	1201	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
447	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1202	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1203	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
448	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1204	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
449	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	1205	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
450	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1206	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
451	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1207	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
452	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1208	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
453	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1209	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
454	shade term_name title transparent transparent_all tripleclickwords	1210	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1211	term_name title transient_for transparent tripleclickwords urgentOnBell
455	utmpInhibit visualBell	1212	utmpInhibit visualBell
456		1213
457	=cut	1214	=cut
458		1215
459	sub urxvt::term::resource($$;$) {	1216	sub resource($$;$) {
460	my ($self, $name) = (shift, shift);	1217	my ($self, $name) = (shift, shift);
461	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1218	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
462	goto &urxvt::term::_resource;	1219	goto &urxvt::term::_resource
463	}	1220	}
		1221
		1222	=item $value = $term->x_resource ($pattern)
		1223
		1224	Returns the X-Resource for the given pattern, excluding the program or
		1225	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1226	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1227	resource with that pattern exists.
		1228
		1229	Extensions that define extra resource or command line arguments also need
		1230	to call this method to access their values.
		1231
		1232	If the method is called on an extension object (basically, from an
		1233	extension), then the special prefix C<%.> will be replaced by the name of
		1234	the extension and a dot, and the lone string C<%> will be replaced by the
		1235	extension name itself. This makes it possible to code extensions so you
		1236	can rename them and get a new set of commandline switches and resources
		1237	without having to change the actual code.
		1238
		1239	This method should only be called during the C<on_start> hook, as there is
		1240	only one resource database per display, and later invocations might return
		1241	the wrong resources.
		1242
		1243	=item $value = $term->x_resource_boolean ($pattern)
		1244
		1245	Like C<x_resource>, above, but interprets the string value as a boolean
		1246	and returns C<1> for true values, C<0> for false values and C<undef> if
		1247	the resource or option isn't specified.
		1248
		1249	You should always use this method to parse boolean resources.
		1250
		1251	=cut
		1252
		1253	sub x_resource_boolean {
		1254	my $res = &x_resource;
		1255
		1256	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1257	}
		1258
		1259	=item $success = $term->parse_keysym ($key, $octets)
		1260
		1261	Adds a key binding exactly as specified via a resource. See the
		1262	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1263
		1264	=item $term->register_command ($keysym, $modifiermask, $string)
		1265
		1266	Adds a key binding. This is a lower level api compared to
		1267	C<parse_keysym>, as it expects a parsed key description, and can be
		1268	used only inside either the C<on_init> hook, to add a binding, or the
		1269	C<on_register_command> hook, to modify a parsed binding.
		1270
		1271	=item $rend = $term->rstyle ([$new_rstyle])
		1272
		1273	Return and optionally change the current rendition. Text that is output by
		1274	the terminal application will use this style.
		1275
		1276	=item ($row, $col) = $term->screen_cur ([$row, $col])
		1277
		1278	Return the current coordinates of the text cursor position and optionally
		1279	set it (which is usually bad as applications don't expect that).
464		1280
465	=item ($row, $col) = $term->selection_mark ([$row, $col])	1281	=item ($row, $col) = $term->selection_mark ([$row, $col])
466		1282
467	=item ($row, $col) = $term->selection_beg ([$row, $col])	1283	=item ($row, $col) = $term->selection_beg ([$row, $col])
468		1284
469	=item ($row, $col) = $term->selection_end ([$row, $col])	1285	=item ($row, $col) = $term->selection_end ([$row, $col])
470		1286
471	Return the current values of the selection mark, begin or end positions,	1287	Return the current values of the selection mark, begin or end positions.
472	and optionally set them to new values.
473		1288
		1289	When arguments are given, then the selection coordinates are set to
		1290	C<$row> and C<$col>, and the selection screen is set to the current
		1291	screen.
		1292
		1293	=item $screen = $term->selection_screen ([$screen])
		1294
		1295	Returns the current selection screen, and then optionally sets it.
		1296
		1297	=item $term->selection_make ($eventtime[, $rectangular])
		1298
		1299	Tries to make a selection as set by C<selection_beg> and
		1300	C<selection_end>. If C<$rectangular> is true (default: false), a
		1301	rectangular selection will be made. This is the preferred function to make
		1302	a selection.
		1303
474	=item $success = $term->selection_grab ($eventtime)	1304	=item $success = $term->selection_grab ($eventtime[, $clipboard])
475		1305
476	Try to request the primary selection from the server (for example, as set	1306	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
477	by the next method).	1307	true) selection from the server. The corresponding text can be set
		1308	with the next method. No visual feedback will be given. This function
		1309	is mostly useful from within C<on_sel_grab> hooks.
478		1310
479	=item $oldtext = $term->selection ([$newtext])	1311	=item $oldtext = $term->selection ([$newtext, $clipboard])
480		1312
481	Return the current selection text and optionally replace it by C<$newtext>.	1313	Return the current selection (clipboard if C<$clipboard> is true) text
		1314	and optionally replace it by C<$newtext>.
482		1315
		1316	=item $term->selection_clear ([$clipboard])
		1317
		1318	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1319
483	#=item $term->overlay ($x, $y, $text)	1320	=item $term->overlay_simple ($x, $y, $text)
484	#	1321
485	#Create a simple multi-line overlay box. See the next method for details.	1322	Create a simple multi-line overlay box. See the next method for details.
486	#	1323
487	#=cut	1324	=cut
488		1325
489	sub urxvt::term::scr_overlay {	1326	sub overlay_simple {
490	die;
491	my ($self, $x, $y, $text) = @_;	1327	my ($self, $x, $y, $text) = @_;
492		1328
493	my @lines = split /\n/, $text;	1329	my @lines = split /\n/, $text;
494		1330
495	my $w = 0;	1331	my $w = List::Util::max map $self->strwidth ($_), @lines;
496	for (map $self->strwidth ($_), @lines) {
497	$w = $_ if $w < $_;
498	}
499		1332
500	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	1333	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
501	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1334	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		1335
		1336	$overlay
502	}	1337	}
503		1338
504	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1339	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
505		1340
506	Create a new (empty) overlay at the given position with the given	1341	Create a new (empty) overlay at the given position with the given
…		…
518		1353
519	The methods currently supported on C<urxvt::overlay> objects are:	1354	The methods currently supported on C<urxvt::overlay> objects are:
520		1355
521	=over 4	1356	=over 4
522		1357
523	=item $overlay->set ($x, $y, $text, $rend)	1358	=item $overlay->set ($x, $y, $text[, $rend])
524		1359
525	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1360	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
526	text in rxvt-unicode's special encoding and an array of rendition values	1361	text in rxvt-unicode's special encoding and an array of rendition values
527	at a specific position inside the overlay.	1362	at a specific position inside the overlay.
528		1363
		1364	If C<$rend> is missing, then the rendition will not be changed.
		1365
529	=item $overlay->hide	1366	=item $overlay->hide
530		1367
531	If visible, hide the overlay, but do not destroy it.	1368	If visible, hide the overlay, but do not destroy it.
532		1369
533	=item $overlay->show	1370	=item $overlay->show
534		1371
535	If hidden, display the overlay again.	1372	If hidden, display the overlay again.
536		1373
537	=back	1374	=back
538		1375
		1376	=item $popup = $term->popup ($event)
		1377
		1378	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1379	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1380	currently).
		1381
		1382	=cut
		1383
		1384	sub popup {
		1385	my ($self, $event) = @_;
		1386
		1387	$self->grab ($event->{time}, 1)
		1388	or return;
		1389
		1390	my $popup = bless {
		1391	term => $self,
		1392	event => $event,
		1393	}, urxvt::popup::;
		1394
		1395	Scalar::Util::weaken $popup->{term};
		1396
		1397	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1398	Scalar::Util::weaken $self->{_destroy}{$popup};
		1399
		1400	$popup
		1401	}
		1402
539	=item $cellwidth = $term->strwidth $string	1403	=item $cellwidth = $term->strwidth ($string)
540		1404
541	Returns the number of screen-cells this string would need. Correctly	1405	Returns the number of screen-cells this string would need. Correctly
542	accounts for wide and combining characters.	1406	accounts for wide and combining characters.
543		1407
544	=item $octets = $term->locale_encode $string	1408	=item $octets = $term->locale_encode ($string)
545		1409
546	Convert the given text string into the corresponding locale encoding.	1410	Convert the given text string into the corresponding locale encoding.
547		1411
548	=item $string = $term->locale_decode $octets	1412	=item $string = $term->locale_decode ($octets)
549		1413
550	Convert the given locale-encoded octets into a perl string.	1414	Convert the given locale-encoded octets into a perl string.
551		1415
		1416	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1417
		1418	XORs the rendition values in the given span with the provided value
		1419	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1420	refresh hooks to provide effects similar to the selection.
		1421
		1422	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1423
		1424	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1425	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1426	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1427	it instead. Both styles I<MUST NOT> contain font styles.
		1428
		1429	=item $term->scr_bell
		1430
		1431	Ring the bell!
		1432
		1433	=item $term->scr_add_lines ($string)
		1434
		1435	Write the given text string to the screen, as if output by the application
		1436	running inside the terminal. It may not contain command sequences (escape
		1437	codes), but is free to use line feeds, carriage returns and tabs. The
		1438	string is a normal text string, not in locale-dependent encoding.
		1439
		1440	Normally its not a good idea to use this function, as programs might be
		1441	confused by changes in cursor position or scrolling. Its useful inside a
		1442	C<on_add_lines> hook, though.
		1443
		1444	=item $term->scr_change_screen ($screen)
		1445
		1446	Switch to given screen - 0 primary, 1 secondary.
		1447
		1448	=item $term->cmd_parse ($octets)
		1449
		1450	Similar to C<scr_add_lines>, but the argument must be in the
		1451	locale-specific encoding of the terminal and can contain command sequences
		1452	(escape codes) that will be interpreted.
		1453
552	=item $term->tt_write ($octets)	1454	=item $term->tt_write ($octets)
553		1455
554	Write the octets given in C<$data> to the tty (i.e. as program input). To	1456	Write the octets given in C<$octets> to the tty (i.e. as program input). To
555	pass characters instead of octets, you should convert your strings first	1457	pass characters instead of octets, you should convert your strings first
556	to the locale-specific encoding using C<< $term->locale_encode >>.	1458	to the locale-specific encoding using C<< $term->locale_encode >>.
557		1459
		1460	=item $term->tt_paste ($octets)
		1461
		1462	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1463	CR and bracketing the data with control sequences if bracketed paste mode
		1464	is set.
		1465
		1466	=item $old_events = $term->pty_ev_events ([$new_events])
		1467
		1468	Replaces the event mask of the pty watcher by the given event mask. Can
		1469	be used to suppress input and output handling to the pty/tty. See the
		1470	description of C<< urxvt::timer->events >>. Make sure to always restore
		1471	the previous value.
		1472
		1473	=item $fd = $term->pty_fd
		1474
		1475	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1476	is used.
		1477
		1478	=item $windowid = $term->parent
		1479
		1480	Return the window id of the toplevel window.
		1481
		1482	=item $windowid = $term->vt
		1483
		1484	Return the window id of the terminal window.
		1485
		1486	=item $term->vt_emask_add ($x_event_mask)
		1487
		1488	Adds the specified events to the vt event mask. Useful e.g. when you want
		1489	to receive pointer events all the times:
		1490
		1491	$term->vt_emask_add (urxvt::PointerMotionMask);
		1492
		1493	=item $term->set_urgency ($set)
		1494
		1495	Enable/disable the urgency hint on the toplevel window.
		1496
		1497	=item $term->focus_in
		1498
		1499	=item $term->focus_out
		1500
		1501	=item $term->key_press ($state, $keycode[, $time])
		1502
		1503	=item $term->key_release ($state, $keycode[, $time])
		1504
		1505	Deliver various fake events to to terminal.
		1506
		1507	=item $window_width = $term->width
		1508
		1509	=item $window_height = $term->height
		1510
		1511	=item $font_width = $term->fwidth
		1512
		1513	=item $font_height = $term->fheight
		1514
		1515	=item $font_ascent = $term->fbase
		1516
558	=item $nrow = $term->nrow	1517	=item $terminal_rows = $term->nrow
559		1518
560	=item $ncol = $term->ncol	1519	=item $terminal_columns = $term->ncol
561		1520
562	Return the number of rows/columns of the terminal window (i.e. as	1521	=item $has_focus = $term->focus
563	specified by C<-geometry>, excluding any scrollback).
564		1522
		1523	=item $is_mapped = $term->mapped
		1524
		1525	=item $max_scrollback = $term->saveLines
		1526
		1527	=item $nrow_plus_saveLines = $term->total_rows
		1528
		1529	=item $topmost_scrollback_row = $term->top_row
		1530
		1531	Return various integers describing terminal characteristics.
		1532
		1533	=item $x_display = $term->display_id
		1534
		1535	Return the DISPLAY used by rxvt-unicode.
		1536
		1537	=item $lc_ctype = $term->locale
		1538
		1539	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1540
565	=item $nsaved = $term->nsaved	1541	=item $env = $term->env
566		1542
567	Returns the number of lines in the scrollback buffer.	1543	Returns a copy of the environment in effect for the terminal as a hashref
		1544	similar to C<\%ENV>.
		1545
		1546	=item @envv = $term->envv
		1547
		1548	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1549
		1550	=item @argv = $term->argv
		1551
		1552	Return the argument vector as this terminal, similar to @ARGV, but
		1553	includes the program name as first element.
		1554
		1555	=cut
		1556
		1557	sub env {
		1558	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1559	}
		1560
		1561	=item $modifiermask = $term->ModLevel3Mask
		1562
		1563	=item $modifiermask = $term->ModMetaMask
		1564
		1565	=item $modifiermask = $term->ModNumLockMask
		1566
		1567	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1568	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1569
		1570	=item $screen = $term->current_screen
		1571
		1572	Returns the currently displayed screen (0 primary, 1 secondary).
		1573
		1574	=item $cursor_is_hidden = $term->hidden_cursor
		1575
		1576	Returns whether the cursor is currently hidden or not.
568		1577
569	=item $view_start = $term->view_start ([$newvalue])	1578	=item $view_start = $term->view_start ([$newvalue])
570		1579
571	Returns the negative row number of the topmost line. Minimum value is	1580	Returns the row number of the topmost displayed line. Maximum value is
572	C<0>, which displays the normal terminal contents. Larger values scroll	1581	C<0>, which displays the normal terminal contents. Lower values scroll
573	this many lines into the scrollback buffer.	1582	this many lines into the scrollback buffer.
574		1583
575	=item $term->want_refresh	1584	=item $term->want_refresh
576		1585
577	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1586	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
580		1589
581	Used after changing terminal contents to display them.	1590	Used after changing terminal contents to display them.
582		1591
583	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1592	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
584		1593
585	Returns the text of the entire row with number C<$row_number>. Row C<0>	1594	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
586	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1595	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
587	terminal line. The scrollback buffer starts at line C<-1> and extends to
588	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1596	terminal line. Nothing will be returned if a nonexistent line
589	is requested.	1597	is requested.
590		1598
591	If C<$new_text> is specified, it will replace characters in the current	1599	If C<$new_text> is specified, it will replace characters in the current
592	line, starting at column C<$start_col> (default C<0>), which is useful	1600	line, starting at column C<$start_col> (default C<0>), which is useful
593	to replace only parts of a line. The font index in the rendition will	1601	to replace only parts of a line. The font index in the rendition will
594	automatically be updated.	1602	automatically be updated.
595		1603
596	C<$text> is in a special encoding: tabs and wide characters that use more	1604	C<$text> is in a special encoding: tabs and wide characters that use more
597	than one cell when displayed are padded with urxvt::NOCHAR characters	1605	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
598	(C<chr 65535>). Characters with combining characters and other characters	1606	characters. Characters with combining characters and other characters that
599	that do not fit into the normal tetx encoding will be replaced with	1607	do not fit into the normal text encoding will be replaced with characters
600	characters in the private use area.	1608	in the private use area.
601		1609
602	You have to obey this encoding when changing text. The advantage is	1610	You have to obey this encoding when changing text. The advantage is
603	that C<substr> and similar functions work on screen cells and not on	1611	that C<substr> and similar functions work on screen cells and not on
604	characters.	1612	characters.
605		1613
…		…
635	about the logical line that row C<$row_number> is part of. It supports the	1643	about the logical line that row C<$row_number> is part of. It supports the
636	following methods:	1644	following methods:
637		1645
638	=over 4	1646	=over 4
639		1647
640	=item $text = $line->t	1648	=item $text = $line->t ([$new_text])
641		1649
642	Returns the full text of the line, similar to C<ROW_t>	1650	Returns or replaces the full text of the line, similar to C<ROW_t>
643		1651
644	=item $rend = $line->r	1652	=item $rend = $line->r ([$new_rend])
645		1653
646	Returns the full rendition array of the line, similar to C<ROW_r>	1654	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
647		1655
648	=item $length = $line->l	1656	=item $length = $line->l
649		1657
650	Returns the length of the line in cells, similar to C<ROW_l>.	1658	Returns the length of the line in cells, similar to C<ROW_l>.
651		1659
…		…
656	Return the row number of the first/last row of the line, respectively.	1664	Return the row number of the first/last row of the line, respectively.
657		1665
658	=item $offset = $line->offset_of ($row, $col)	1666	=item $offset = $line->offset_of ($row, $col)
659		1667
660	Returns the character offset of the given row|col pair within the logical	1668	Returns the character offset of the given row|col pair within the logical
661	line.	1669	line. Works for rows outside the line, too, and returns corresponding
		1670	offsets outside the string.
662		1671
663	=item ($row, $col) = $line->coord_of ($offset)	1672	=item ($row, $col) = $line->coord_of ($offset)
664		1673
665	Translates a string offset into terminal coordinates again.	1674	Translates a string offset into terminal coordinates again.
666		1675
667	=back	1676	=back
668		1677
669	=cut	1678	=cut
670		1679
671	sub urxvt::term::line {	1680	sub line {
672	my ($self, $row) = @_;	1681	my ($self, $row) = @_;
673		1682
674	my $maxrow = $self->nrow - 1;	1683	my $maxrow = $self->nrow - 1;
675		1684
676	my ($beg, $end) = ($row, $row);	1685	my ($beg, $end) = ($row, $row);
…		…
680		1689
681	bless {	1690	bless {
682	term => $self,	1691	term => $self,
683	beg => $beg,	1692	beg => $beg,
684	end => $end,	1693	end => $end,
		1694	ncol => $self->ncol,
685	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1695	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
686	}, urxvt::line::	1696	}, urxvt::line::
687	}	1697	}
688		1698
689	sub urxvt::line::t {	1699	sub urxvt::line::t {
690	my ($self) = @_;	1700	my ($self) = @_;
691		1701
		1702	if (@_ > 1)
		1703	{
		1704	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1705	for $self->{beg} .. $self->{end};
		1706	}
		1707
		1708	defined wantarray &&
692	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1709	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
693	0, $self->{len}	1710	0, $self->{len}
694	}	1711	}
695		1712
696	sub urxvt::line::r {	1713	sub urxvt::line::r {
697	my ($self) = @_;	1714	my ($self) = @_;
698		1715
		1716	if (@_ > 1)
		1717	{
		1718	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1719	for $self->{beg} .. $self->{end};
		1720	}
		1721
		1722	if (defined wantarray) {
699	my $rend = [	1723	my $rend = [
700	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1724	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
701	];	1725	];
702	$#$rend = $self->{len} - 1;	1726	$#$rend = $self->{len} - 1;
703	$rend	1727	return $rend;
		1728	}
		1729
		1730	()
704	}	1731	}
705		1732
706	sub urxvt::line::beg { $_[0]{beg} }	1733	sub urxvt::line::beg { $_[0]{beg} }
707	sub urxvt::line::end { $_[0]{end} }	1734	sub urxvt::line::end { $_[0]{end} }
708	sub urxvt::line::l { $_[0]{len} }	1735	sub urxvt::line::l { $_[0]{len} }
709		1736
710	sub urxvt::line::offset_of {	1737	sub urxvt::line::offset_of {
711	my ($self, $row, $col) = @_;	1738	my ($self, $row, $col) = @_;
712		1739
713	($row - $self->{beg}) * $self->{term}->ncol + $col	1740	($row - $self->{beg}) * $self->{ncol} + $col
714	}	1741	}
715		1742
716	sub urxvt::line::coord_of {	1743	sub urxvt::line::coord_of {
717	my ($self, $offset) = @_;	1744	my ($self, $offset) = @_;
718		1745
719	use integer;	1746	use integer;
720		1747
721	(	1748	(
722	$offset / $self->{term}->ncol + $self->{beg},	1749	$offset / $self->{ncol} + $self->{beg},
723	$offset % $self->{term}->ncol	1750	$offset % $self->{ncol}
724	)	1751	)
725	}	1752	}
726		1753
727	=item ($row, $col) = $line->coord_of ($offset)
728	=item $text = $term->special_encode $string	1754	=item $text = $term->special_encode $string
729		1755
730	Converts a perl string into the special encoding used by rxvt-unicode,	1756	Converts a perl string into the special encoding used by rxvt-unicode,
731	where one character corresponds to one screen cell. See	1757	where one character corresponds to one screen cell. See
732	C<< $term->ROW_t >> for details.	1758	C<< $term->ROW_t >> for details.
733		1759
734	=item $string = $term->special_decode $text	1760	=item $string = $term->special_decode $text
735		1761
736	Converts rxvt-unicodes text reprsentation into a perl string. See	1762	Converts rxvt-unicodes text representation into a perl string. See
737	C<< $term->ROW_t >> for details.	1763	C<< $term->ROW_t >> for details.
738		1764
		1765	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
		1766
		1767	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1768
		1769	Register/unregister a synchronous button grab. See the XGrabButton
		1770	manpage.
		1771
		1772	=item $success = $term->grab ($eventtime[, $sync])
		1773
		1774	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1775	synchronous (C<$sync> is true). Also remembers the grab timestamp.
		1776
		1777	=item $term->allow_events_async
		1778
		1779	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1780
		1781	=item $term->allow_events_sync
		1782
		1783	Calls XAllowEvents with SyncBoth for the most recent grab.
		1784
		1785	=item $term->allow_events_replay
		1786
		1787	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1788	recent grab.
		1789
		1790	=item $term->ungrab
		1791
		1792	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
		1793	evaluation errors, as it is better to lose the grab in the error case as
		1794	the session.
		1795
		1796	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1797
		1798	=item $atom_name = $term->XGetAtomName ($atom)
		1799
		1800	=item @atoms = $term->XListProperties ($window)
		1801
		1802	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1803
		1804	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1805
		1806	=item $term->XDeleteProperty ($window, $property)
		1807
		1808	=item $window = $term->DefaultRootWindow
		1809
		1810	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1811
		1812	=item $term->XMapWindow ($window)
		1813
		1814	=item $term->XUnmapWindow ($window)
		1815
		1816	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1817
		1818	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1819
		1820	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1821
		1822	=item $keysym = $term->XStringToKeysym ($string)
		1823
		1824	=item $string = $term->XKeysymToString ($keysym)
		1825
		1826	Various X or X-related functions. The C<$term> object only serves as
		1827	the source of the display, otherwise those functions map more-or-less
		1828	directly onto the X functions of the same name.
		1829
739	=back	1830	=back
		1831
		1832	=cut
		1833
		1834	package urxvt::popup;
		1835
		1836	=head2 The C<urxvt::popup> Class
		1837
		1838	=over 4
		1839
		1840	=cut
		1841
		1842	sub add_item {
		1843	my ($self, $item) = @_;
		1844
		1845	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1846	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1847	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1848
		1849	$item->{render} ||= sub { $_[0]{text} };
		1850
		1851	push @{ $self->{item} }, $item;
		1852	}
		1853
		1854	=item $popup->add_title ($title)
		1855
		1856	Adds a non-clickable title to the popup.
		1857
		1858	=cut
		1859
		1860	sub add_title {
		1861	my ($self, $title) = @_;
		1862
		1863	$self->add_item ({
		1864	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1865	text => $title,
		1866	activate => sub { },
		1867	});
		1868	}
		1869
		1870	=item $popup->add_separator ([$sepchr])
		1871
		1872	Creates a separator, optionally using the character given as C<$sepchr>.
		1873
		1874	=cut
		1875
		1876	sub add_separator {
		1877	my ($self, $sep) = @_;
		1878
		1879	$sep ||= "=";
		1880
		1881	$self->add_item ({
		1882	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1883	text => "",
		1884	render => sub { $sep x $self->{term}->ncol },
		1885	activate => sub { },
		1886	});
		1887	}
		1888
		1889	=item $popup->add_button ($text, $cb)
		1890
		1891	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1892	selected.
		1893
		1894	=cut
		1895
		1896	sub add_button {
		1897	my ($self, $text, $cb) = @_;
		1898
		1899	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1900	}
		1901
		1902	=item $popup->add_toggle ($text, $initial_value, $cb)
		1903
		1904	Adds a toggle/checkbox item to the popup. The callback gets called
		1905	whenever it gets toggled, with a boolean indicating its new value as its
		1906	first argument.
		1907
		1908	=cut
		1909
		1910	sub add_toggle {
		1911	my ($self, $text, $value, $cb) = @_;
		1912
		1913	my $item; $item = {
		1914	type => "button",
		1915	text => " $text",
		1916	value => $value,
		1917	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1918	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1919	};
		1920
		1921	$self->add_item ($item);
		1922	}
		1923
		1924	=item $popup->show
		1925
		1926	Displays the popup (which is initially hidden).
		1927
		1928	=cut
		1929
		1930	sub show {
		1931	my ($self) = @_;
		1932
		1933	local $urxvt::popup::self = $self;
		1934
		1935	my $env = $self->{term}->env;
		1936	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1937	delete $env->{LC_ALL};
		1938	$env->{LC_CTYPE} = $self->{term}->locale;
		1939
		1940	my $term = urxvt::term->new (
		1941	$env, "popup",
		1942	"--perl-lib" => "", "--perl-ext-common" => "",
		1943	"-pty-fd" => -1, "-sl" => 0,
		1944	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		1945	"--transient-for" => $self->{term}->parent,
		1946	"-display" => $self->{term}->display_id,
		1947	"-pe" => "urxvt-popup",
		1948	) or die "unable to create popup window\n";
		1949
		1950	unless (delete $term->{urxvt_popup_init_done}) {
		1951	$term->ungrab;
		1952	$term->destroy;
		1953	die "unable to initialise popup window\n";
		1954	}
		1955	}
		1956
		1957	sub DESTROY {
		1958	my ($self) = @_;
		1959
		1960	delete $self->{term}{_destroy}{$self};
		1961	$self->{term}->ungrab;
		1962	}
		1963
		1964	=back
		1965
		1966	=cut
		1967
		1968	package urxvt::watcher;
740		1969
741	=head2 The C<urxvt::timer> Class	1970	=head2 The C<urxvt::timer> Class
742		1971
743	This class implements timer watchers/events. Time is represented as a	1972	This class implements timer watchers/events. Time is represented as a
744	fractional number of seconds since the epoch. Example:	1973	fractional number of seconds since the epoch. Example:
…		…
748	->new	1977	->new
749	->interval (1)	1978	->interval (1)
750	->cb (sub {	1979	->cb (sub {
751	$term->{overlay}->set (0, 0,	1980	$term->{overlay}->set (0, 0,
752	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1981	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
753	});	1982	});
754		1983
755	=over 4	1984	=over 4
756		1985
757	=item $timer = new urxvt::timer	1986	=item $timer = new urxvt::timer
758		1987
…		…
761		1990
762	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1991	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
763		1992
764	Set the callback to be called when the timer triggers.	1993	Set the callback to be called when the timer triggers.
765		1994
766	=item $tstamp = $timer->at
767
768	Return the time this watcher will fire next.
769
770	=item $timer = $timer->set ($tstamp)	1995	=item $timer = $timer->set ($tstamp[, $interval])
771		1996
772	Set the time the event is generated to $tstamp.	1997	Set the time the event is generated to $tstamp (and optionally specifies a
		1998	new $interval).
773		1999
774	=item $timer = $timer->interval ($interval)	2000	=item $timer = $timer->interval ($interval)
775		2001
776	Normally (and when C<$interval> is C<0>), the timer will automatically	2002	By default (and when C<$interval> is C<0>), the timer will automatically
777	stop after it has fired once. If C<$interval> is non-zero, then the timer	2003	stop after it has fired once. If C<$interval> is non-zero, then the timer
778	is automatically rescheduled at the given intervals.	2004	is automatically rescheduled at the given intervals.
779		2005
780	=item $timer = $timer->start	2006	=item $timer = $timer->start
781		2007
782	Start the timer.	2008	Start the timer.
783		2009
784	=item $timer = $timer->start ($tstamp)	2010	=item $timer = $timer->start ($tstamp[, $interval])
785		2011
786	Set the event trigger time to C<$tstamp> and start the timer.	2012	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2013	also replaces the interval.
		2014
		2015	=item $timer = $timer->after ($delay[, $interval])
		2016
		2017	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
787		2018
788	=item $timer = $timer->stop	2019	=item $timer = $timer->stop
789		2020
790	Stop the timer.	2021	Stop the timer.
791		2022
…		…
797		2028
798	$term->{socket} = ...	2029	$term->{socket} = ...
799	$term->{iow} = urxvt::iow	2030	$term->{iow} = urxvt::iow
800	->new	2031	->new
801	->fd (fileno $term->{socket})	2032	->fd (fileno $term->{socket})
802	->events (1) # wait for read data	2033	->events (urxvt::EV_READ)
803	->start	2034	->start
804	->cb (sub {	2035	->cb (sub {
805	my ($iow, $revents) = @_;	2036	my ($iow, $revents) = @_;
806	# $revents must be 1 here, no need to check	2037	# $revents must be 1 here, no need to check
807	sysread $term->{socket}, my $buf, 8192	2038	sysread $term->{socket}, my $buf, 8192
…		…
820	Set the callback to be called when io events are triggered. C<$reventmask>	2051	Set the callback to be called when io events are triggered. C<$reventmask>
821	is a bitset as described in the C<events> method.	2052	is a bitset as described in the C<events> method.
822		2053
823	=item $iow = $iow->fd ($fd)	2054	=item $iow = $iow->fd ($fd)
824		2055
825	Set the filedescriptor (not handle) to watch.	2056	Set the file descriptor (not handle) to watch.
826		2057
827	=item $iow = $iow->events ($eventmask)	2058	=item $iow = $iow->events ($eventmask)
828		2059
829	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2060	Set the event mask to watch. The only allowed values are
830	data, Bit #1 (value C<2>) enables watching for write data.	2061	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
		2062	together, or C<urxvt::EV_NONE>.
831		2063
832	=item $iow = $iow->start	2064	=item $iow = $iow->start
833		2065
834	Start watching for requested events on the given handle.	2066	Start watching for requested events on the given handle.
835		2067
836	=item $iow = $iow->stop	2068	=item $iow = $iow->stop
837		2069
838	Stop watching for events on the given filehandle.	2070	Stop watching for events on the given file handle.
		2071
		2072	=back
		2073
		2074	=head2 The C<urxvt::iw> Class
		2075
		2076	This class implements idle watchers, that get called automatically when
		2077	the process is idle. They should return as fast as possible, after doing
		2078	some useful work.
		2079
		2080	=over 4
		2081
		2082	=item $iw = new urxvt::iw
		2083
		2084	Create a new idle watcher object in stopped state.
		2085
		2086	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2087
		2088	Set the callback to be called when the watcher triggers.
		2089
		2090	=item $timer = $timer->start
		2091
		2092	Start the watcher.
		2093
		2094	=item $timer = $timer->stop
		2095
		2096	Stop the watcher.
		2097
		2098	=back
		2099
		2100	=head2 The C<urxvt::pw> Class
		2101
		2102	This class implements process watchers. They create an event whenever a
		2103	process exits, after which they stop automatically.
		2104
		2105	my $pid = fork;
		2106	...
		2107	$term->{pw} = urxvt::pw
		2108	->new
		2109	->start ($pid)
		2110	->cb (sub {
		2111	my ($pw, $exit_status) = @_;
		2112	...
		2113	});
		2114
		2115	=over 4
		2116
		2117	=item $pw = new urxvt::pw
		2118
		2119	Create a new process watcher in stopped state.
		2120
		2121	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2122
		2123	Set the callback to be called when the timer triggers.
		2124
		2125	=item $pw = $timer->start ($pid)
		2126
		2127	Tells the watcher to start watching for process C<$pid>.
		2128
		2129	=item $pw = $pw->stop
		2130
		2131	Stop the watcher.
839		2132
840	=back	2133	=back
841		2134
842	=head1 ENVIRONMENT	2135	=head1 ENVIRONMENT
843		2136
…		…
846	This variable controls the verbosity level of the perl extension. Higher	2139	This variable controls the verbosity level of the perl extension. Higher
847	numbers indicate more verbose output.	2140	numbers indicate more verbose output.
848		2141
849	=over 4	2142	=over 4
850		2143
851	=item 0 - only fatal messages	2144	=item == 0 - fatal messages
852		2145
853	=item 3 - script loading and management	2146	=item >= 3 - script loading and management
854		2147
855	=item 10 - all events received	2148	=item >=10 - all called hooks
		2149
		2150	=item >=11 - hook return values
856		2151
857	=back	2152	=back
858		2153
859	=head1 AUTHOR	2154	=head1 AUTHOR
860		2155
861	Marc Lehmann <pcg@goof.com>	2156	Marc Lehmann <schmorp@schmorp.de>
862	http://software.schmorp.de/pkg/rxvt-unicode	2157	http://software.schmorp.de/pkg/rxvt-unicode
863		2158
864	=cut	2159	=cut
865		2160
866	1	2161	1
		2162
		2163	# vim: sw=3:

Diff Legend

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