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.25 by root, Tue Jan 3 21:08:39 2006 UTC vs.
Revision 1.222 by root, Sat Jul 7 07:00:17 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	keys %$cb;
390
391	while (my ($pkg, $cb) = each %$cb) {
392	return 1
393	if $cb->(
394	$TERM->{$pkg} ||= do {
395	my $proxy = bless { }, urxvt::term::proxy::;
396	Scalar::Util::weaken ($proxy->{term} = $TERM);
397	$proxy
398	},
399	@_,
400	);
401	}
402
403	0
404	}	773	}
405		774
406	sub urxvt::term::proxy::AUTOLOAD {	775	package urxvt::term::extension;
407	$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 =~ /:([^:]+)$/
408	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	802	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
409		803
410	eval qq{	804	eval qq{
411	sub $urxvt::term::proxy::AUTOLOAD {	805	sub $AUTOLOAD {
412	my \$proxy = shift;	806	my \$proxy = shift;
413	\$proxy->{term}->$1 (\@_)	807	\$proxy->{term}->$1 (\@_)
414	}	808	}
415	1	809	1
416	} or die "FATAL: unable to compile method forwarder: $@";	810	} or die "FATAL: unable to compile method forwarder: $@";
417		811
418	goto &$urxvt::term::proxy::AUTOLOAD;	812	goto &$AUTOLOAD;
419	}	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 $self = delete $disable->{""};
		887
		888	while (my ($htype, $id) = each %$disable) {
		889	delete $self->{_hook}[$htype]{$id};
		890	$self->set_should_invoke ($htype, -1);
		891	}
		892	}
		893
		894	sub on {
		895	my ($self, %hook) = @_;
		896
		897	my %disable = ( "" => $self );
		898
		899	while (my ($name, $cb) = each %hook) {
		900	my $htype = $HOOKTYPE{uc $name};
		901	defined $htype
		902	or Carp::croak "unsupported hook type '$name'";
		903
		904	my $id = $cb+0;
		905
		906	$self->set_should_invoke ($htype, +1);
		907	$disable{$htype} = $id;
		908	$self->{_hook}[$htype]{$id} = sub { shift; $cb->($self, @_) }; # very ugly indeed
		909	}
		910
		911	bless \%disable, "urxvt::extension::on_disable"
		912	}
		913
		914	=item $self->x_resource ($pattern)
		915
		916	=item $self->x_resource_boolean ($pattern)
		917
		918	These methods support an additional C<%> prefix when called on an
		919	extension object - see the description of these methods in the
		920	C<urxvt::term> class for details.
		921
		922	=cut
		923
		924	sub x_resource {
		925	my ($self, $name) = @_;
		926	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		927	$self->{term}->x_resource ($name)
		928	}
		929
		930	sub x_resource_boolean {
		931	my ($self, $name) = @_;
		932	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		933	$self->{term}->x_resource_boolean ($name)
		934	}
		935
		936	=back
		937
		938	=cut
		939
		940	package urxvt::anyevent;
		941
		942	=head2 The C<urxvt::anyevent> Class
		943
		944	The sole purpose of this class is to deliver an interface to the
		945	C<AnyEvent> module - any module using it will work inside urxvt without
		946	further programming. The only exception is that you cannot wait on
		947	condition variables, but non-blocking condvar use is ok.
		948
		949	In practical terms this means is that you cannot use blocking APIs, but
		950	the non-blocking variant should work.
		951
		952	=cut
		953
		954	our $VERSION = '5.23';
		955
		956	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		957	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		958
		959	sub timer {
		960	my ($class, %arg) = @_;
		961
		962	my $cb = $arg{cb};
		963
		964	urxvt::timer
		965	->new
		966	->after ($arg{after}, $arg{interval})
		967	->cb ($arg{interval} ? $cb : sub {
		968	$_[0]->stop; # need to cancel manually
		969	$cb->();
		970	})
		971	}
		972
		973	sub io {
		974	my ($class, %arg) = @_;
		975
		976	my $cb = $arg{cb};
		977	my $fd = fileno $arg{fh};
		978	defined $fd or $fd = $arg{fh};
		979
		980	bless [$arg{fh}, urxvt::iow
		981	->new
		982	->fd ($fd)
		983	->events (($arg{poll} =~ /r/ ? 1 : 0)
		984	| ($arg{poll} =~ /w/ ? 2 : 0))
		985	->start
		986	->cb ($cb)
		987	], urxvt::anyevent::
		988	}
		989
		990	sub idle {
		991	my ($class, %arg) = @_;
		992
		993	my $cb = $arg{cb};
		994
		995	urxvt::iw
		996	->new
		997	->start
		998	->cb ($cb)
		999	}
		1000
		1001	sub child {
		1002	my ($class, %arg) = @_;
		1003
		1004	my $cb = $arg{cb};
		1005
		1006	urxvt::pw
		1007	->new
		1008	->start ($arg{pid})
		1009	->cb (sub {
		1010	$_[0]->stop; # need to cancel manually
		1011	$cb->($_[0]->rpid, $_[0]->rstatus);
		1012	})
		1013	}
		1014
		1015	sub DESTROY {
		1016	$_[0][1]->stop;
		1017	}
		1018
		1019	# only needed for AnyEvent < 6 compatibility
		1020	sub one_event {
		1021	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1022	}
		1023
		1024	package urxvt::term;
420		1025
421	=head2 The C<urxvt::term> Class	1026	=head2 The C<urxvt::term> Class
422		1027
423	=over 4	1028	=over 4
		1029
		1030	=cut
		1031
		1032	# find on_xxx subs in the package and register them
		1033	# as hooks
		1034	sub register_package {
		1035	my ($self, $pkg, $argv) = @_;
		1036
		1037	no strict 'refs';
		1038
		1039	urxvt::verbose 6, "register package $pkg to $self";
		1040
		1041	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1042
		1043	my $proxy = bless {
		1044	_pkg => $pkg,
		1045	_name => ${"$pkg\::_NAME"}, # hackish
		1046	argv => $argv,
		1047	}, $pkg;
		1048	Scalar::Util::weaken ($proxy->{term} = $self);
		1049
		1050	$self->{_pkg}{$pkg} = $proxy;
		1051
		1052	for my $name (@HOOKNAME) {
		1053	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1054	$proxy->enable ($name => $ref);
		1055	}
		1056	}
		1057	}
		1058
		1059	sub perl_libdirs {
		1060	map { split /:/ }
		1061	$_[0]->resource ("perl_lib"),
		1062	$ENV{URXVT_PERL_LIB},
		1063	"$ENV{HOME}/.urxvt/ext",
		1064	"$LIBDIR/perl"
		1065	}
		1066
		1067	sub scan_meta {
		1068	my ($self) = @_;
		1069	my @libdirs = perl_libdirs $self;
		1070
		1071	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1072
		1073	my %meta;
		1074
		1075	$self->{meta_libdirs} = join "\x00", @libdirs;
		1076	$self->{meta} = \%meta;
		1077
		1078	for my $dir (reverse @libdirs) {
		1079	opendir my $fh, $dir
		1080	or next;
		1081	for my $ext (readdir $fh) {
		1082	$ext ne "."
		1083	and $ext ne ".."
		1084	and open my $fh, "<", "$dir/$ext"
		1085	or next;
		1086
		1087	while (<$fh>) {
		1088	if (/^#:META:X_RESOURCE:(.*)/) {
		1089	my ($pattern, $type, $desc) = split /:/, $1;
		1090	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1091	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1092	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1093	} else {
		1094	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1095	}
		1096	} elsif (/^\s*(?:#|$)/) {
		1097	# skip other comments and empty lines
		1098	} else {
		1099	last; # stop parsing on first non-empty non-comment line
		1100	}
		1101	}
		1102	}
		1103	}
		1104	}
		1105
		1106	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1107
		1108	Creates a new terminal, very similar as if you had started it with system
		1109	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1110	hash which defines the environment of the new terminal.
		1111
		1112	Croaks (and probably outputs an error message) if the new instance
		1113	couldn't be created. Returns C<undef> if the new instance didn't
		1114	initialise perl, and the terminal object otherwise. The C<init> and
		1115	C<start> hooks will be called before this call returns, and are free to
		1116	refer to global data (which is race free).
		1117
		1118	=cut
		1119
		1120	sub new {
		1121	my ($class, $env, @args) = @_;
		1122
		1123	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1124	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1125
		1126	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1127	}
		1128
		1129	=item $term->destroy
		1130
		1131	Destroy the terminal object (close the window, free resources
		1132	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1133	watchers (timers, io watchers) are still active.
		1134
		1135	=item $term->exec_async ($cmd[, @args])
		1136
		1137	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1138	("starts") programs in the background. This function takes care of setting
		1139	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1140	be preferred over explicit calls to C<exec> or C<system>.
		1141
		1142	Returns the pid of the subprocess or C<undef> on error.
		1143
		1144	=cut
		1145
		1146	sub exec_async {
		1147	my $self = shift;
		1148
		1149	my $pid = fork;
		1150
		1151	return $pid
		1152	if !defined $pid or $pid;
		1153
		1154	%ENV = %{ $self->env };
		1155
		1156	exec @_;
		1157	urxvt::_exit 255;
		1158	}
		1159
		1160	=item $isset = $term->option ($optval[, $set])
		1161
		1162	Returns true if the option specified by C<$optval> is enabled, and
		1163	optionally change it. All option values are stored by name in the hash
		1164	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		1165
		1166	Here is a likely non-exhaustive list of option names, please see the
		1167	source file F</src/optinc.h> to see the actual list:
		1168
		1169	borderLess buffered console cursorBlink cursorUnderline hold iconic
		1170	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1171	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
		1172	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
		1173	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
		1174	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1175	urgentOnBell utmpInhibit visualBell
424		1176
425	=item $value = $term->resource ($name[, $newval])	1177	=item $value = $term->resource ($name[, $newval])
426		1178
427	Returns the current resource value associated with a given name and	1179	Returns the current resource value associated with a given name and
428	optionally sets a new value. Setting values is most useful in the C<init>	1180	optionally sets a new value. Setting values is most useful in the C<init>
…		…
437	likely change).	1189	likely change).
438		1190
439	Please note that resource strings will currently only be freed when the	1191	Please note that resource strings will currently only be freed when the
440	terminal is destroyed, so changing options frequently will eat memory.	1192	terminal is destroyed, so changing options frequently will eat memory.
441		1193
442	Here is a a likely non-exhaustive list of resource names, not all of which	1194	Here is a likely non-exhaustive list of resource names, not all of which
443	are supported in every build, please see the source to see the actual	1195	are supported in every build, please see the source file F</src/rsinc.h>
444	list:	1196	to see the actual list:
445		1197
446	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1198	answerbackstring backgroundPixmap backspace_key blurradius
447	borderLess color cursorBlink cursorUnderline cutchars delete_key	1199	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
448	display_name embed ext_bwidth fade font geometry hold iconName	1200	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
449	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1201	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1202	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
450	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1203	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
451	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	1204	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
452	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1205	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
453	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1206	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
454	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1207	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
455	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1208	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
456	shade term_name title transparent transparent_all tripleclickwords	1209	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1210	term_name title transient_for transparent tripleclickwords urgentOnBell
457	utmpInhibit visualBell	1211	utmpInhibit visualBell
458		1212
459	=cut	1213	=cut
460		1214
461	sub urxvt::term::resource($$;$) {	1215	sub resource($$;$) {
462	my ($self, $name) = (shift, shift);	1216	my ($self, $name) = (shift, shift);
463	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1217	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
464	goto &urxvt::term::_resource;	1218	goto &urxvt::term::_resource
465	}	1219	}
		1220
		1221	=item $value = $term->x_resource ($pattern)
		1222
		1223	Returns the X-Resource for the given pattern, excluding the program or
		1224	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1225	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1226	resource with that pattern exists.
		1227
		1228	Extensions that define extra resource or command line arguments also need
		1229	to call this method to access their values.
		1230
		1231	If the method is called on an extension object (basically, from an
		1232	extension), then the special prefix C<%.> will be replaced by the name of
		1233	the extension and a dot, and the lone string C<%> will be replaced by the
		1234	extension name itself. This makes it possible to code extensions so you
		1235	can rename them and get a new set of commandline switches and resources
		1236	without having to change the actual code.
		1237
		1238	This method should only be called during the C<on_start> hook, as there is
		1239	only one resource database per display, and later invocations might return
		1240	the wrong resources.
		1241
		1242	=item $value = $term->x_resource_boolean ($pattern)
		1243
		1244	Like C<x_resource>, above, but interprets the string value as a boolean
		1245	and returns C<1> for true values, C<0> for false values and C<undef> if
		1246	the resource or option isn't specified.
		1247
		1248	You should always use this method to parse boolean resources.
		1249
		1250	=cut
		1251
		1252	sub x_resource_boolean {
		1253	my $res = &x_resource;
		1254
		1255	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1256	}
		1257
		1258	=item $success = $term->parse_keysym ($key, $octets)
		1259
		1260	Adds a key binding exactly as specified via a resource. See the
		1261	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1262
		1263	=item $term->register_command ($keysym, $modifiermask, $string)
		1264
		1265	Adds a key binding. This is a lower level api compared to
		1266	C<parse_keysym>, as it expects a parsed key description, and can be
		1267	used only inside either the C<on_init> hook, to add a binding, or the
		1268	C<on_register_command> hook, to modify a parsed binding.
		1269
		1270	=item $rend = $term->rstyle ([$new_rstyle])
		1271
		1272	Return and optionally change the current rendition. Text that is output by
		1273	the terminal application will use this style.
		1274
		1275	=item ($row, $col) = $term->screen_cur ([$row, $col])
		1276
		1277	Return the current coordinates of the text cursor position and optionally
		1278	set it (which is usually bad as applications don't expect that).
466		1279
467	=item ($row, $col) = $term->selection_mark ([$row, $col])	1280	=item ($row, $col) = $term->selection_mark ([$row, $col])
468		1281
469	=item ($row, $col) = $term->selection_beg ([$row, $col])	1282	=item ($row, $col) = $term->selection_beg ([$row, $col])
470		1283
471	=item ($row, $col) = $term->selection_end ([$row, $col])	1284	=item ($row, $col) = $term->selection_end ([$row, $col])
472		1285
473	Return the current values of the selection mark, begin or end positions,	1286	Return the current values of the selection mark, begin or end positions.
474	and optionally set them to new values.
475		1287
		1288	When arguments are given, then the selection coordinates are set to
		1289	C<$row> and C<$col>, and the selection screen is set to the current
		1290	screen.
		1291
		1292	=item $screen = $term->selection_screen ([$screen])
		1293
		1294	Returns the current selection screen, and then optionally sets it.
		1295
		1296	=item $term->selection_make ($eventtime[, $rectangular])
		1297
		1298	Tries to make a selection as set by C<selection_beg> and
		1299	C<selection_end>. If C<$rectangular> is true (default: false), a
		1300	rectangular selection will be made. This is the preferred function to make
		1301	a selection.
		1302
476	=item $success = $term->selection_grab ($eventtime)	1303	=item $success = $term->selection_grab ($eventtime[, $clipboard])
477		1304
478	Try to request the primary selection from the server (for example, as set	1305	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
479	by the next method).	1306	true) selection from the server. The corresponding text can be set
		1307	with the next method. No visual feedback will be given. This function
		1308	is mostly useful from within C<on_sel_grab> hooks.
480		1309
481	=item $oldtext = $term->selection ([$newtext])	1310	=item $oldtext = $term->selection ([$newtext, $clipboard])
482		1311
483	Return the current selection text and optionally replace it by C<$newtext>.	1312	Return the current selection (clipboard if C<$clipboard> is true) text
		1313	and optionally replace it by C<$newtext>.
484		1314
		1315	=item $term->selection_clear ([$clipboard])
		1316
		1317	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1318
485	#=item $term->overlay ($x, $y, $text)	1319	=item $term->overlay_simple ($x, $y, $text)
486	#	1320
487	#Create a simple multi-line overlay box. See the next method for details.	1321	Create a simple multi-line overlay box. See the next method for details.
488	#	1322
489	#=cut	1323	=cut
490		1324
491	sub urxvt::term::scr_overlay {	1325	sub overlay_simple {
492	die;
493	my ($self, $x, $y, $text) = @_;	1326	my ($self, $x, $y, $text) = @_;
494		1327
495	my @lines = split /\n/, $text;	1328	my @lines = split /\n/, $text;
496		1329
497	my $w = 0;	1330	my $w = List::Util::max map $self->strwidth ($_), @lines;
498	for (map $self->strwidth ($_), @lines) {
499	$w = $_ if $w < $_;
500	}
501		1331
502	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	1332	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
503	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1333	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		1334
		1335	$overlay
504	}	1336	}
505		1337
506	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1338	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
507		1339
508	Create a new (empty) overlay at the given position with the given	1340	Create a new (empty) overlay at the given position with the given
…		…
520		1352
521	The methods currently supported on C<urxvt::overlay> objects are:	1353	The methods currently supported on C<urxvt::overlay> objects are:
522		1354
523	=over 4	1355	=over 4
524		1356
525	=item $overlay->set ($x, $y, $text, $rend)	1357	=item $overlay->set ($x, $y, $text[, $rend])
526		1358
527	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1359	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
528	text in rxvt-unicode's special encoding and an array of rendition values	1360	text in rxvt-unicode's special encoding and an array of rendition values
529	at a specific position inside the overlay.	1361	at a specific position inside the overlay.
530		1362
		1363	If C<$rend> is missing, then the rendition will not be changed.
		1364
531	=item $overlay->hide	1365	=item $overlay->hide
532		1366
533	If visible, hide the overlay, but do not destroy it.	1367	If visible, hide the overlay, but do not destroy it.
534		1368
535	=item $overlay->show	1369	=item $overlay->show
536		1370
537	If hidden, display the overlay again.	1371	If hidden, display the overlay again.
538		1372
539	=back	1373	=back
540		1374
		1375	=item $popup = $term->popup ($event)
		1376
		1377	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1378	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1379	currently).
		1380
		1381	=cut
		1382
		1383	sub popup {
		1384	my ($self, $event) = @_;
		1385
		1386	$self->grab ($event->{time}, 1)
		1387	or return;
		1388
		1389	my $popup = bless {
		1390	term => $self,
		1391	event => $event,
		1392	}, urxvt::popup::;
		1393
		1394	Scalar::Util::weaken $popup->{term};
		1395
		1396	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1397	Scalar::Util::weaken $self->{_destroy}{$popup};
		1398
		1399	$popup
		1400	}
		1401
541	=item $cellwidth = $term->strwidth $string	1402	=item $cellwidth = $term->strwidth ($string)
542		1403
543	Returns the number of screen-cells this string would need. Correctly	1404	Returns the number of screen-cells this string would need. Correctly
544	accounts for wide and combining characters.	1405	accounts for wide and combining characters.
545		1406
546	=item $octets = $term->locale_encode $string	1407	=item $octets = $term->locale_encode ($string)
547		1408
548	Convert the given text string into the corresponding locale encoding.	1409	Convert the given text string into the corresponding locale encoding.
549		1410
550	=item $string = $term->locale_decode $octets	1411	=item $string = $term->locale_decode ($octets)
551		1412
552	Convert the given locale-encoded octets into a perl string.	1413	Convert the given locale-encoded octets into a perl string.
553		1414
		1415	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1416
		1417	XORs the rendition values in the given span with the provided value
		1418	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1419	refresh hooks to provide effects similar to the selection.
		1420
		1421	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1422
		1423	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1424	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1425	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1426	it instead. Both styles I<MUST NOT> contain font styles.
		1427
		1428	=item $term->scr_bell
		1429
		1430	Ring the bell!
		1431
		1432	=item $term->scr_add_lines ($string)
		1433
		1434	Write the given text string to the screen, as if output by the application
		1435	running inside the terminal. It may not contain command sequences (escape
		1436	codes), but is free to use line feeds, carriage returns and tabs. The
		1437	string is a normal text string, not in locale-dependent encoding.
		1438
		1439	Normally its not a good idea to use this function, as programs might be
		1440	confused by changes in cursor position or scrolling. Its useful inside a
		1441	C<on_add_lines> hook, though.
		1442
		1443	=item $term->scr_change_screen ($screen)
		1444
		1445	Switch to given screen - 0 primary, 1 secondary.
		1446
		1447	=item $term->cmd_parse ($octets)
		1448
		1449	Similar to C<scr_add_lines>, but the argument must be in the
		1450	locale-specific encoding of the terminal and can contain command sequences
		1451	(escape codes) that will be interpreted.
		1452
554	=item $term->tt_write ($octets)	1453	=item $term->tt_write ($octets)
555		1454
556	Write the octets given in C<$data> to the tty (i.e. as program input). To	1455	Write the octets given in C<$octets> to the tty (i.e. as program input). To
557	pass characters instead of octets, you should convert your strings first	1456	pass characters instead of octets, you should convert your strings first
558	to the locale-specific encoding using C<< $term->locale_encode >>.	1457	to the locale-specific encoding using C<< $term->locale_encode >>.
559		1458
		1459	=item $term->tt_paste ($octets)
		1460
		1461	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1462	CR and bracketing the data with control sequences if bracketed paste mode
		1463	is set.
		1464
		1465	=item $old_events = $term->pty_ev_events ([$new_events])
		1466
		1467	Replaces the event mask of the pty watcher by the given event mask. Can
		1468	be used to suppress input and output handling to the pty/tty. See the
		1469	description of C<< urxvt::timer->events >>. Make sure to always restore
		1470	the previous value.
		1471
		1472	=item $fd = $term->pty_fd
		1473
		1474	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1475	is used.
		1476
		1477	=item $windowid = $term->parent
		1478
		1479	Return the window id of the toplevel window.
		1480
		1481	=item $windowid = $term->vt
		1482
		1483	Return the window id of the terminal window.
		1484
		1485	=item $term->vt_emask_add ($x_event_mask)
		1486
		1487	Adds the specified events to the vt event mask. Useful e.g. when you want
		1488	to receive pointer events all the times:
		1489
		1490	$term->vt_emask_add (urxvt::PointerMotionMask);
		1491
		1492	=item $term->set_urgency ($set)
		1493
		1494	Enable/disable the urgency hint on the toplevel window.
		1495
		1496	=item $term->focus_in
		1497
		1498	=item $term->focus_out
		1499
		1500	=item $term->key_press ($state, $keycode[, $time])
		1501
		1502	=item $term->key_release ($state, $keycode[, $time])
		1503
		1504	Deliver various fake events to to terminal.
		1505
		1506	=item $window_width = $term->width
		1507
		1508	=item $window_height = $term->height
		1509
		1510	=item $font_width = $term->fwidth
		1511
		1512	=item $font_height = $term->fheight
		1513
		1514	=item $font_ascent = $term->fbase
		1515
560	=item $nrow = $term->nrow	1516	=item $terminal_rows = $term->nrow
561		1517
562	=item $ncol = $term->ncol	1518	=item $terminal_columns = $term->ncol
563		1519
564	Return the number of rows/columns of the terminal window (i.e. as	1520	=item $has_focus = $term->focus
565	specified by C<-geometry>, excluding any scrollback).
566		1521
		1522	=item $is_mapped = $term->mapped
		1523
		1524	=item $max_scrollback = $term->saveLines
		1525
		1526	=item $nrow_plus_saveLines = $term->total_rows
		1527
		1528	=item $topmost_scrollback_row = $term->top_row
		1529
		1530	Return various integers describing terminal characteristics.
		1531
		1532	=item $x_display = $term->display_id
		1533
		1534	Return the DISPLAY used by rxvt-unicode.
		1535
		1536	=item $lc_ctype = $term->locale
		1537
		1538	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1539
567	=item $nsaved = $term->nsaved	1540	=item $env = $term->env
568		1541
569	Returns the number of lines in the scrollback buffer.	1542	Returns a copy of the environment in effect for the terminal as a hashref
		1543	similar to C<\%ENV>.
		1544
		1545	=item @envv = $term->envv
		1546
		1547	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1548
		1549	=item @argv = $term->argv
		1550
		1551	Return the argument vector as this terminal, similar to @ARGV, but
		1552	includes the program name as first element.
		1553
		1554	=cut
		1555
		1556	sub env {
		1557	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1558	}
		1559
		1560	=item $modifiermask = $term->ModLevel3Mask
		1561
		1562	=item $modifiermask = $term->ModMetaMask
		1563
		1564	=item $modifiermask = $term->ModNumLockMask
		1565
		1566	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1567	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1568
		1569	=item $screen = $term->current_screen
		1570
		1571	Returns the currently displayed screen (0 primary, 1 secondary).
		1572
		1573	=item $cursor_is_hidden = $term->hidden_cursor
		1574
		1575	Returns whether the cursor is currently hidden or not.
570		1576
571	=item $view_start = $term->view_start ([$newvalue])	1577	=item $view_start = $term->view_start ([$newvalue])
572		1578
573	Returns the negative row number of the topmost line. Minimum value is	1579	Returns the row number of the topmost displayed line. Maximum value is
574	C<0>, which displays the normal terminal contents. Larger values scroll	1580	C<0>, which displays the normal terminal contents. Lower values scroll
575	this many lines into the scrollback buffer.	1581	this many lines into the scrollback buffer.
576		1582
577	=item $term->want_refresh	1583	=item $term->want_refresh
578		1584
579	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1585	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
582		1588
583	Used after changing terminal contents to display them.	1589	Used after changing terminal contents to display them.
584		1590
585	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1591	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
586		1592
587	Returns the text of the entire row with number C<$row_number>. Row C<0>	1593	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
588	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1594	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
589	terminal line. The scrollback buffer starts at line C<-1> and extends to
590	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1595	terminal line. Nothing will be returned if a nonexistent line
591	is requested.	1596	is requested.
592		1597
593	If C<$new_text> is specified, it will replace characters in the current	1598	If C<$new_text> is specified, it will replace characters in the current
594	line, starting at column C<$start_col> (default C<0>), which is useful	1599	line, starting at column C<$start_col> (default C<0>), which is useful
595	to replace only parts of a line. The font index in the rendition will	1600	to replace only parts of a line. The font index in the rendition will
596	automatically be updated.	1601	automatically be updated.
597		1602
598	C<$text> is in a special encoding: tabs and wide characters that use more	1603	C<$text> is in a special encoding: tabs and wide characters that use more
599	than one cell when displayed are padded with urxvt::NOCHAR characters	1604	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
600	(C<chr 65535>). Characters with combining characters and other characters	1605	characters. Characters with combining characters and other characters that
601	that do not fit into the normal tetx encoding will be replaced with	1606	do not fit into the normal text encoding will be replaced with characters
602	characters in the private use area.	1607	in the private use area.
603		1608
604	You have to obey this encoding when changing text. The advantage is	1609	You have to obey this encoding when changing text. The advantage is
605	that C<substr> and similar functions work on screen cells and not on	1610	that C<substr> and similar functions work on screen cells and not on
606	characters.	1611	characters.
607		1612
…		…
637	about the logical line that row C<$row_number> is part of. It supports the	1642	about the logical line that row C<$row_number> is part of. It supports the
638	following methods:	1643	following methods:
639		1644
640	=over 4	1645	=over 4
641		1646
642	=item $text = $line->t	1647	=item $text = $line->t ([$new_text])
643		1648
644	Returns the full text of the line, similar to C<ROW_t>	1649	Returns or replaces the full text of the line, similar to C<ROW_t>
645		1650
646	=item $rend = $line->r	1651	=item $rend = $line->r ([$new_rend])
647		1652
648	Returns the full rendition array of the line, similar to C<ROW_r>	1653	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
649		1654
650	=item $length = $line->l	1655	=item $length = $line->l
651		1656
652	Returns the length of the line in cells, similar to C<ROW_l>.	1657	Returns the length of the line in cells, similar to C<ROW_l>.
653		1658
…		…
658	Return the row number of the first/last row of the line, respectively.	1663	Return the row number of the first/last row of the line, respectively.
659		1664
660	=item $offset = $line->offset_of ($row, $col)	1665	=item $offset = $line->offset_of ($row, $col)
661		1666
662	Returns the character offset of the given row|col pair within the logical	1667	Returns the character offset of the given row|col pair within the logical
663	line.	1668	line. Works for rows outside the line, too, and returns corresponding
		1669	offsets outside the string.
664		1670
665	=item ($row, $col) = $line->coord_of ($offset)	1671	=item ($row, $col) = $line->coord_of ($offset)
666		1672
667	Translates a string offset into terminal coordinates again.	1673	Translates a string offset into terminal coordinates again.
668		1674
669	=back	1675	=back
670		1676
671	=cut	1677	=cut
672		1678
673	sub urxvt::term::line {	1679	sub line {
674	my ($self, $row) = @_;	1680	my ($self, $row) = @_;
675		1681
676	my $maxrow = $self->nrow - 1;	1682	my $maxrow = $self->nrow - 1;
677		1683
678	my ($beg, $end) = ($row, $row);	1684	my ($beg, $end) = ($row, $row);
…		…
682		1688
683	bless {	1689	bless {
684	term => $self,	1690	term => $self,
685	beg => $beg,	1691	beg => $beg,
686	end => $end,	1692	end => $end,
		1693	ncol => $self->ncol,
687	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1694	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
688	}, urxvt::line::	1695	}, urxvt::line::
689	}	1696	}
690		1697
691	sub urxvt::line::t {	1698	sub urxvt::line::t {
692	my ($self) = @_;	1699	my ($self) = @_;
693		1700
		1701	if (@_ > 1)
		1702	{
		1703	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1704	for $self->{beg} .. $self->{end};
		1705	}
		1706
		1707	defined wantarray &&
694	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1708	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
695	0, $self->{len}	1709	0, $self->{len}
696	}	1710	}
697		1711
698	sub urxvt::line::r {	1712	sub urxvt::line::r {
699	my ($self) = @_;	1713	my ($self) = @_;
700		1714
		1715	if (@_ > 1)
		1716	{
		1717	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1718	for $self->{beg} .. $self->{end};
		1719	}
		1720
		1721	if (defined wantarray) {
701	my $rend = [	1722	my $rend = [
702	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1723	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
703	];	1724	];
704	$#$rend = $self->{len} - 1;	1725	$#$rend = $self->{len} - 1;
705	$rend	1726	return $rend;
		1727	}
		1728
		1729	()
706	}	1730	}
707		1731
708	sub urxvt::line::beg { $_[0]{beg} }	1732	sub urxvt::line::beg { $_[0]{beg} }
709	sub urxvt::line::end { $_[0]{end} }	1733	sub urxvt::line::end { $_[0]{end} }
710	sub urxvt::line::l { $_[0]{len} }	1734	sub urxvt::line::l { $_[0]{len} }
711		1735
712	sub urxvt::line::offset_of {	1736	sub urxvt::line::offset_of {
713	my ($self, $row, $col) = @_;	1737	my ($self, $row, $col) = @_;
714		1738
715	($row - $self->{beg}) * $self->{term}->ncol + $col	1739	($row - $self->{beg}) * $self->{ncol} + $col
716	}	1740	}
717		1741
718	sub urxvt::line::coord_of {	1742	sub urxvt::line::coord_of {
719	my ($self, $offset) = @_;	1743	my ($self, $offset) = @_;
720		1744
721	use integer;	1745	use integer;
722		1746
723	(	1747	(
724	$offset / $self->{term}->ncol + $self->{beg},	1748	$offset / $self->{ncol} + $self->{beg},
725	$offset % $self->{term}->ncol	1749	$offset % $self->{ncol}
726	)	1750	)
727	}	1751	}
728		1752
729	=item ($row, $col) = $line->coord_of ($offset)
730	=item $text = $term->special_encode $string	1753	=item $text = $term->special_encode $string
731		1754
732	Converts a perl string into the special encoding used by rxvt-unicode,	1755	Converts a perl string into the special encoding used by rxvt-unicode,
733	where one character corresponds to one screen cell. See	1756	where one character corresponds to one screen cell. See
734	C<< $term->ROW_t >> for details.	1757	C<< $term->ROW_t >> for details.
735		1758
736	=item $string = $term->special_decode $text	1759	=item $string = $term->special_decode $text
737		1760
738	Converts rxvt-unicodes text reprsentation into a perl string. See	1761	Converts rxvt-unicodes text representation into a perl string. See
739	C<< $term->ROW_t >> for details.	1762	C<< $term->ROW_t >> for details.
740		1763
		1764	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
		1765
		1766	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1767
		1768	Register/unregister a synchronous button grab. See the XGrabButton
		1769	manpage.
		1770
		1771	=item $success = $term->grab ($eventtime[, $sync])
		1772
		1773	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1774	synchronous (C<$sync> is true). Also remembers the grab timestamp.
		1775
		1776	=item $term->allow_events_async
		1777
		1778	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1779
		1780	=item $term->allow_events_sync
		1781
		1782	Calls XAllowEvents with SyncBoth for the most recent grab.
		1783
		1784	=item $term->allow_events_replay
		1785
		1786	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1787	recent grab.
		1788
		1789	=item $term->ungrab
		1790
		1791	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
		1792	evaluation errors, as it is better to lose the grab in the error case as
		1793	the session.
		1794
		1795	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1796
		1797	=item $atom_name = $term->XGetAtomName ($atom)
		1798
		1799	=item @atoms = $term->XListProperties ($window)
		1800
		1801	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1802
		1803	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1804
		1805	=item $term->XDeleteProperty ($window, $property)
		1806
		1807	=item $window = $term->DefaultRootWindow
		1808
		1809	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1810
		1811	=item $term->XMapWindow ($window)
		1812
		1813	=item $term->XUnmapWindow ($window)
		1814
		1815	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1816
		1817	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1818
		1819	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1820
		1821	=item $keysym = $term->XStringToKeysym ($string)
		1822
		1823	=item $string = $term->XKeysymToString ($keysym)
		1824
		1825	Various X or X-related functions. The C<$term> object only serves as
		1826	the source of the display, otherwise those functions map more-or-less
		1827	directly onto the X functions of the same name.
		1828
741	=back	1829	=back
		1830
		1831	=cut
		1832
		1833	package urxvt::popup;
		1834
		1835	=head2 The C<urxvt::popup> Class
		1836
		1837	=over 4
		1838
		1839	=cut
		1840
		1841	sub add_item {
		1842	my ($self, $item) = @_;
		1843
		1844	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1845	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1846	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1847
		1848	$item->{render} ||= sub { $_[0]{text} };
		1849
		1850	push @{ $self->{item} }, $item;
		1851	}
		1852
		1853	=item $popup->add_title ($title)
		1854
		1855	Adds a non-clickable title to the popup.
		1856
		1857	=cut
		1858
		1859	sub add_title {
		1860	my ($self, $title) = @_;
		1861
		1862	$self->add_item ({
		1863	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1864	text => $title,
		1865	activate => sub { },
		1866	});
		1867	}
		1868
		1869	=item $popup->add_separator ([$sepchr])
		1870
		1871	Creates a separator, optionally using the character given as C<$sepchr>.
		1872
		1873	=cut
		1874
		1875	sub add_separator {
		1876	my ($self, $sep) = @_;
		1877
		1878	$sep ||= "=";
		1879
		1880	$self->add_item ({
		1881	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1882	text => "",
		1883	render => sub { $sep x $self->{term}->ncol },
		1884	activate => sub { },
		1885	});
		1886	}
		1887
		1888	=item $popup->add_button ($text, $cb)
		1889
		1890	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1891	selected.
		1892
		1893	=cut
		1894
		1895	sub add_button {
		1896	my ($self, $text, $cb) = @_;
		1897
		1898	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1899	}
		1900
		1901	=item $popup->add_toggle ($text, $initial_value, $cb)
		1902
		1903	Adds a toggle/checkbox item to the popup. The callback gets called
		1904	whenever it gets toggled, with a boolean indicating its new value as its
		1905	first argument.
		1906
		1907	=cut
		1908
		1909	sub add_toggle {
		1910	my ($self, $text, $value, $cb) = @_;
		1911
		1912	my $item; $item = {
		1913	type => "button",
		1914	text => " $text",
		1915	value => $value,
		1916	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1917	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1918	};
		1919
		1920	$self->add_item ($item);
		1921	}
		1922
		1923	=item $popup->show
		1924
		1925	Displays the popup (which is initially hidden).
		1926
		1927	=cut
		1928
		1929	sub show {
		1930	my ($self) = @_;
		1931
		1932	local $urxvt::popup::self = $self;
		1933
		1934	my $env = $self->{term}->env;
		1935	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1936	delete $env->{LC_ALL};
		1937	$env->{LC_CTYPE} = $self->{term}->locale;
		1938
		1939	my $term = urxvt::term->new (
		1940	$env, "popup",
		1941	"--perl-lib" => "", "--perl-ext-common" => "",
		1942	"-pty-fd" => -1, "-sl" => 0,
		1943	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		1944	"--transient-for" => $self->{term}->parent,
		1945	"-display" => $self->{term}->display_id,
		1946	"-pe" => "urxvt-popup",
		1947	) or die "unable to create popup window\n";
		1948
		1949	unless (delete $term->{urxvt_popup_init_done}) {
		1950	$term->ungrab;
		1951	$term->destroy;
		1952	die "unable to initialise popup window\n";
		1953	}
		1954	}
		1955
		1956	sub DESTROY {
		1957	my ($self) = @_;
		1958
		1959	delete $self->{term}{_destroy}{$self};
		1960	$self->{term}->ungrab;
		1961	}
		1962
		1963	=back
		1964
		1965	=cut
		1966
		1967	package urxvt::watcher;
742		1968
743	=head2 The C<urxvt::timer> Class	1969	=head2 The C<urxvt::timer> Class
744		1970
745	This class implements timer watchers/events. Time is represented as a	1971	This class implements timer watchers/events. Time is represented as a
746	fractional number of seconds since the epoch. Example:	1972	fractional number of seconds since the epoch. Example:
…		…
750	->new	1976	->new
751	->interval (1)	1977	->interval (1)
752	->cb (sub {	1978	->cb (sub {
753	$term->{overlay}->set (0, 0,	1979	$term->{overlay}->set (0, 0,
754	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1980	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
755	});	1981	});
756		1982
757	=over 4	1983	=over 4
758		1984
759	=item $timer = new urxvt::timer	1985	=item $timer = new urxvt::timer
760		1986
…		…
763		1989
764	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1990	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
765		1991
766	Set the callback to be called when the timer triggers.	1992	Set the callback to be called when the timer triggers.
767		1993
768	=item $tstamp = $timer->at
769
770	Return the time this watcher will fire next.
771
772	=item $timer = $timer->set ($tstamp)	1994	=item $timer = $timer->set ($tstamp[, $interval])
773		1995
774	Set the time the event is generated to $tstamp.	1996	Set the time the event is generated to $tstamp (and optionally specifies a
		1997	new $interval).
775		1998
776	=item $timer = $timer->interval ($interval)	1999	=item $timer = $timer->interval ($interval)
777		2000
778	Normally (and when C<$interval> is C<0>), the timer will automatically	2001	By default (and when C<$interval> is C<0>), the timer will automatically
779	stop after it has fired once. If C<$interval> is non-zero, then the timer	2002	stop after it has fired once. If C<$interval> is non-zero, then the timer
780	is automatically rescheduled at the given intervals.	2003	is automatically rescheduled at the given intervals.
781		2004
782	=item $timer = $timer->start	2005	=item $timer = $timer->start
783		2006
784	Start the timer.	2007	Start the timer.
785		2008
786	=item $timer = $timer->start ($tstamp)	2009	=item $timer = $timer->start ($tstamp[, $interval])
787		2010
788	Set the event trigger time to C<$tstamp> and start the timer.	2011	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2012	also replaces the interval.
		2013
		2014	=item $timer = $timer->after ($delay[, $interval])
		2015
		2016	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
789		2017
790	=item $timer = $timer->stop	2018	=item $timer = $timer->stop
791		2019
792	Stop the timer.	2020	Stop the timer.
793		2021
…		…
799		2027
800	$term->{socket} = ...	2028	$term->{socket} = ...
801	$term->{iow} = urxvt::iow	2029	$term->{iow} = urxvt::iow
802	->new	2030	->new
803	->fd (fileno $term->{socket})	2031	->fd (fileno $term->{socket})
804	->events (1) # wait for read data	2032	->events (urxvt::EV_READ)
805	->start	2033	->start
806	->cb (sub {	2034	->cb (sub {
807	my ($iow, $revents) = @_;	2035	my ($iow, $revents) = @_;
808	# $revents must be 1 here, no need to check	2036	# $revents must be 1 here, no need to check
809	sysread $term->{socket}, my $buf, 8192	2037	sysread $term->{socket}, my $buf, 8192
…		…
822	Set the callback to be called when io events are triggered. C<$reventmask>	2050	Set the callback to be called when io events are triggered. C<$reventmask>
823	is a bitset as described in the C<events> method.	2051	is a bitset as described in the C<events> method.
824		2052
825	=item $iow = $iow->fd ($fd)	2053	=item $iow = $iow->fd ($fd)
826		2054
827	Set the filedescriptor (not handle) to watch.	2055	Set the file descriptor (not handle) to watch.
828		2056
829	=item $iow = $iow->events ($eventmask)	2057	=item $iow = $iow->events ($eventmask)
830		2058
831	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2059	Set the event mask to watch. The only allowed values are
832	data, Bit #1 (value C<2>) enables watching for write data.	2060	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
		2061	together, or C<urxvt::EV_NONE>.
833		2062
834	=item $iow = $iow->start	2063	=item $iow = $iow->start
835		2064
836	Start watching for requested events on the given handle.	2065	Start watching for requested events on the given handle.
837		2066
838	=item $iow = $iow->stop	2067	=item $iow = $iow->stop
839		2068
840	Stop watching for events on the given filehandle.	2069	Stop watching for events on the given file handle.
		2070
		2071	=back
		2072
		2073	=head2 The C<urxvt::iw> Class
		2074
		2075	This class implements idle watchers, that get called automatically when
		2076	the process is idle. They should return as fast as possible, after doing
		2077	some useful work.
		2078
		2079	=over 4
		2080
		2081	=item $iw = new urxvt::iw
		2082
		2083	Create a new idle watcher object in stopped state.
		2084
		2085	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2086
		2087	Set the callback to be called when the watcher triggers.
		2088
		2089	=item $timer = $timer->start
		2090
		2091	Start the watcher.
		2092
		2093	=item $timer = $timer->stop
		2094
		2095	Stop the watcher.
		2096
		2097	=back
		2098
		2099	=head2 The C<urxvt::pw> Class
		2100
		2101	This class implements process watchers. They create an event whenever a
		2102	process exits, after which they stop automatically.
		2103
		2104	my $pid = fork;
		2105	...
		2106	$term->{pw} = urxvt::pw
		2107	->new
		2108	->start ($pid)
		2109	->cb (sub {
		2110	my ($pw, $exit_status) = @_;
		2111	...
		2112	});
		2113
		2114	=over 4
		2115
		2116	=item $pw = new urxvt::pw
		2117
		2118	Create a new process watcher in stopped state.
		2119
		2120	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2121
		2122	Set the callback to be called when the timer triggers.
		2123
		2124	=item $pw = $timer->start ($pid)
		2125
		2126	Tells the watcher to start watching for process C<$pid>.
		2127
		2128	=item $pw = $pw->stop
		2129
		2130	Stop the watcher.
841		2131
842	=back	2132	=back
843		2133
844	=head1 ENVIRONMENT	2134	=head1 ENVIRONMENT
845		2135
…		…
848	This variable controls the verbosity level of the perl extension. Higher	2138	This variable controls the verbosity level of the perl extension. Higher
849	numbers indicate more verbose output.	2139	numbers indicate more verbose output.
850		2140
851	=over 4	2141	=over 4
852		2142
853	=item 0 - only fatal messages	2143	=item == 0 - fatal messages
854		2144
855	=item 3 - script loading and management	2145	=item >= 3 - script loading and management
856		2146
857	=item 10 - all events received	2147	=item >=10 - all called hooks
		2148
		2149	=item >=11 - hook return values
858		2150
859	=back	2151	=back
860		2152
861	=head1 AUTHOR	2153	=head1 AUTHOR
862		2154
863	Marc Lehmann <pcg@goof.com>	2155	Marc Lehmann <schmorp@schmorp.de>
864	http://software.schmorp.de/pkg/rxvt-unicode	2156	http://software.schmorp.de/pkg/rxvt-unicode
865		2157
866	=cut	2158	=cut
867		2159
868	1	2160	1
		2161
		2162	# vim: sw=3:

Diff Legend

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