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

Diff Legend

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