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.22 by root, Tue Jan 3 19:10:54 2006 UTC vs.
Revision 1.229 by root, Sat Apr 26 18:53:51 2014 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --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 urxvtd, 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<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	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	urxvt -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
75	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
76	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
77	modified).	59	modified).
78		60
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 called	113	The following subroutines can be declared in extension files, and will be
87	whenever the relevant event happens.	114	called whenever the relevant event happens.
88		115
89	All of them must return a boolean value. If it is true, then the event	116	The first argument passed to them is an extension object as described in
90	counts as being I<consumed>, and the invocation of other hooks is skipped,	117	the in the C<Extension Objects> section.
		118
		119	B<All> of these hooks must return a boolean value. If any of the called
		120	hooks returns true, then the event counts as being I<consumed>, and the
91	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.
92		122
93	When in doubt, return a false value (preferably C<()>).	123	I<< When in doubt, return a false value (preferably C<()>). >>
94		124
95	=over 4	125	=over 4
96		126
97	=item on_init $term	127	=item on_init $term
98		128
99	Called after a new terminal object has been initialized, but before	129	Called after a new terminal object has been initialized, but before
100	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).
101		145
102	=item on_reset $term	146	=item on_reset $term
103		147
104	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
105	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
106	variables.	150	variables.
107		151
108	=item on_start $term	152	=item on_child_start $term, $pid
109		153
110	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.
111	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>.
112		160
113	=item on_sel_make $term, $eventtime	161	=item on_sel_make $term, $eventtime
114		162
115	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
116	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
…		…
123		171
124	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
125	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
126	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
127		175
128	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.
129		177
130	=item on_sel_extend $term	178	=item on_sel_extend $term
131		179
132	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
133	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
134	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
135	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.
136		186
137	See the F<selection> example extension.	187	See the F<selection> example extension.
138		188
139	=item on_focus_in $term
140
141	Called whenever the window gets the keyboard focus, before urxvt does
142	focus in processing.
143
144	=item on_focus_out $term
145
146	Called wheneever the window loses keyboard focus, before urxvt does focus
147	out processing.
148
149	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
150		190
151	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
152	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
153	show this many lines of scrollback.	193	show this many lines of scrollback.
154		194
155	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
156		196
…		…
160		200
161	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,
162	$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
163	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
164		204
165	=item on_tty_activity $term *NYI*	205	=item on_osc_seq $term, $op, $args, $resp
166		206
167	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.
168		274
169	=item on_refresh_begin $term	275	=item on_refresh_begin $term
170		276
171	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
172	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
173	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
174	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
175		281
176	=item on_refresh_end $term	282	=item on_refresh_end $term
177		283
178	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>.
179		285
180	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
181		287
182	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
183	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>
184	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
		291
		292	The event is simply the action string. This interface is going away in
		293	preference to the C<< ->register_keysym_action >> method.
		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 a true value the binding
		299	is not 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 a true value, 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.
185		370
186	=back	371	=back
187		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
		398	=head2 Variables in the C<urxvt> Package
		399
		400	=over 4
		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
		415	=item $urxvt::TERM
		416
		417	The current terminal. This variable stores the current C<urxvt::term>
		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>.
		435
		436	=back
		437
188	=head2 Functions in the C<urxvt> Package	438	=head2 Functions in the C<urxvt> Package
189		439
190	=over 4	440	=over 4
191		441
192	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
193		443
194	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
195	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
196	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
197		448
198	=item urxvt::warn $string	449	=item urxvt::warn $string
199		450
200	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
201	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
202	that calls this function.	453	that calls this function.
203		454
204	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
205	correct place, e.g. on stderr of the connecting urxvtc client.	456	correct place, e.g. on stderr of the connecting urxvtc client.
206		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
207	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
208		468
209	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.
210		494
211	=back	495	=back
212		496
213	=head2 RENDITION	497	=head2 RENDITION
214		498
…		…
229		513
230	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
231		515
232	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
233		517
234	=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
235		520
236	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
237	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
238	the bitset.	523	the bitset.
239		524
…		…
241		526
242	=item $background = urxvt::GET_BASEBG $rend	527	=item $background = urxvt::GET_BASEBG $rend
243		528
244	Return the foreground/background colour index, respectively.	529	Return the foreground/background colour index, respectively.
245		530
246	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	531	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
247		532
248	=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
249		536
250	Replace the foreground/background colour in the rendition mask with the	537	Replace the foreground/background colour in the rendition mask with the
251	specified one.	538	specified one.
252		539
253	=item $value = urxvt::GET_CUSTOM ($rend)	540	=item $value = urxvt::GET_CUSTOM $rend
254		541
255	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
256	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
257	zero.	544	zero.
258		545
259	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	546	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
260		547
261	Change the custom value.	548	Change the custom value.
262		549
263	=back	550	=back
264		551
265	=cut	552	=cut
266		553
267	package urxvt;
268
269	use strict;
270
271	our $term;
272	our @HOOKNAME;
273	our $LIBDIR;
274
275	BEGIN {	554	BEGIN {
276	urxvt->bootstrap;
277
278	# overwrite perl's warn	555	# overwrite perl's warn
279	*CORE::GLOBAL::warn = sub {	556	*CORE::GLOBAL::warn = sub {
280	my $msg = join "", @_;	557	my $msg = join "", @_;
281	$msg .= "\n"	558	$msg .= "\n"
282	unless $msg =~ /\n$/;	559	unless $msg =~ /\n$/;
283	urxvt::warn ($msg);	560	urxvt::warn ($msg);
284	};	561	};
285	}	562	}
286		563
287	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; # reset 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
288	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
289		627
290	sub verbose {	628	sub verbose {
291	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
292	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
293	}	631	}
294		632
295	# find on_xxx subs in the package and register them	633	my %extension_pkg;
296	# as hooks
297	sub register_package($) {
298	my ($pkg) = @_;
299
300	for my $htype (0.. $#HOOKNAME) {
301	my $name = $HOOKNAME[$htype];
302
303	my $ref = $pkg->can ("on_" . lc $name)
304	or next;
305
306	$term->{_hook}[$htype]{$ref*1} = $ref;
307	$hook_count[$htype]++
308	or set_should_invoke $htype, 1;
309	}
310	}
311
312	my $script_pkg = "script0000";
313	my %script_pkg;
314		634
315	# load a single script into its own package, once only	635	# load a single script into its own package, once only
316	sub script_package($) {	636	sub extension_package($) {
317	my ($path) = @_;	637	my ($path) = @_;
318		638
319	$script_pkg{$path} ||= do {	639	$extension_pkg{$path} ||= do {
320	my $pkg = "urxvt::" . ($script_pkg++);	640	$path =~ /([^\/\\]+)$/;
		641	my $pkg = $1;
		642	$pkg =~ s/[^[:word:]]/_/g;
		643	$pkg = "urxvt::ext::$pkg";
321		644
322	verbose 3, "loading script '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
323		648
324	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
325	or die "$path: $!";	650	or die "$path: $!";
326		651
327	my $source = "package $pkg; use strict; use utf8;\n"	652	my $source =
		653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
328	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
329	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
330	. "\n};\n1";	656	. "\n};\n1";
331		657
		658	eval $source
332	eval $source or die "$path: $@";	659	or die "$path: $@";
333		660
334	$pkg	661	$pkg
335	}	662	}
336	}	663	}
337		664
		665	our $retval; # return value for urxvt
		666
338	# called by the rxvt core	667	# called by the rxvt core
339	sub invoke {	668	sub invoke {
340	local $term = shift;	669	local $TERM = shift;
341	my $htype = shift;	670	my $htype = shift;
342		671
343	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
344	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
345		674
346	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) {
347	my @files = grep -f $_, map "$_/$ext", @dirs;	702	my @files = grep -f $_, map "$_/$ext", @dirs;
348		703
349	if (@files) {	704	if (@files) {
350	register_package script_package $files[0];	705	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
351	} else {	706	} else {
352	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";
353	}	708	}
354	}	709	}
355		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
356	} elsif ($htype == 1) { # DESTROY	735	if ($htype == 1) { # DESTROY
357	if (my $hook = $term->{_hook}) {	736	# clear package objects
358	for my $htype (0..$#$hook) {	737	%$_ = () for values %{ $TERM->{_pkg} };
359	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }	738
360	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;
361	}	769	}
362	}	770	}
363	}	771	}
		772	($mask, @color{qw(fg bg)}, \@failed)
		773	}
364		774
365	my $cb = $term->{_hook}[$htype]	775	package urxvt::term::extension;
366	or return;
367		776
368	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	777	=head2 The C<urxvt::term::extension> class
369	if $verbosity >= 10;
370		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 =~ /:([^:]+)$/
		802	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
		803
		804	eval qq{
		805	sub $AUTOLOAD {
		806	my \$proxy = shift;
		807	\$proxy->{term}->$1 (\@_)
		808	}
		809	1
		810	} or die "FATAL: unable to compile method forwarder: $@";
		811
		812	goto &$AUTOLOAD;
		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 hook previously installed via C<enable> in
		833	this extension.
		834
		835	This is useful when you want to overwrite time-critical hooks only
		836	temporarily.
		837
		838	To install additional callbacks for the same hook, you can use the C<on>
		839	method of the C<urxvt::term> class.
		840
		841	=item $self->disable ($hook_name[, $hook_name..])
		842
		843	Dynamically disable the given hooks.
		844
		845	=cut
		846
		847	sub enable {
		848	my ($self, %hook) = @_;
		849	my $pkg = $self->{_pkg};
		850
371	while (my ($k, $v) = each %$cb) {	851	while (my ($name, $cb) = each %hook) {
372	return 1 if $v->($term, @_);	852	my $htype = $HOOKTYPE{uc $name};
		853	defined $htype
		854	or Carp::croak "unsupported hook type '$name'";
		855
		856	$self->set_should_invoke ($htype, +1)
		857	unless exists $self->{term}{_hook}[$htype]{$pkg};
		858
		859	$self->{term}{_hook}[$htype]{$pkg} = $cb;
373	}	860	}
		861	}
374		862
		863	sub disable {
		864	my ($self, @hook) = @_;
		865	my $pkg = $self->{_pkg};
		866
		867	for my $name (@hook) {
		868	my $htype = $HOOKTYPE{uc $name};
		869	defined $htype
		870	or Carp::croak "unsupported hook type '$name'";
		871
		872	$self->set_should_invoke ($htype, -1)
		873	if delete $self->{term}{_hook}[$htype]{$pkg};
375	0	874	}
376	}	875	}
		876
		877	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		878
		879	Similar to the C<enable> enable, but installs additional callbacks for
		880	the given hook(s) (that is, it doesn't replace existing callbacks), and
		881	returns a guard object. When the guard object is destroyed the callbacks
		882	are disabled again.
		883
		884	=cut
		885
		886	sub urxvt::extension::on_disable::DESTROY {
		887	my $disable = shift;
		888
		889	my $term = delete $disable->{""};
		890
		891	while (my ($htype, $id) = each %$disable) {
		892	delete $term->{_hook}[$htype]{$id};
		893	$term->set_should_invoke ($htype, -1);
		894	}
		895	}
		896
		897	sub on {
		898	my ($self, %hook) = @_;
		899
		900	my $term = $self->{term};
		901
		902	my %disable = ( "" => $term );
		903
		904	while (my ($name, $cb) = each %hook) {
		905	my $htype = $HOOKTYPE{uc $name};
		906	defined $htype
		907	or Carp::croak "unsupported hook type '$name'";
		908
		909	$term->set_should_invoke ($htype, +1);
		910	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		911	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		912	}
		913
		914	bless \%disable, "urxvt::extension::on_disable"
		915	}
		916
		917	=item $self->x_resource ($pattern)
		918
		919	=item $self->x_resource_boolean ($pattern)
		920
		921	These methods support an additional C<%> prefix when called on an
		922	extension object - see the description of these methods in the
		923	C<urxvt::term> class for details.
		924
		925	=cut
		926
		927	sub x_resource {
		928	my ($self, $name) = @_;
		929	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		930	$self->{term}->x_resource ($name)
		931	}
		932
		933	sub x_resource_boolean {
		934	my ($self, $name) = @_;
		935	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		936	$self->{term}->x_resource_boolean ($name)
		937	}
		938
		939	=back
		940
		941	=cut
		942
		943	package urxvt::anyevent;
		944
		945	=head2 The C<urxvt::anyevent> Class
		946
		947	The sole purpose of this class is to deliver an interface to the
		948	C<AnyEvent> module - any module using it will work inside urxvt without
		949	further programming. The only exception is that you cannot wait on
		950	condition variables, but non-blocking condvar use is ok.
		951
		952	In practical terms this means is that you cannot use blocking APIs, but
		953	the non-blocking variant should work.
		954
		955	=cut
		956
		957	our $VERSION = '5.23';
		958
		959	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		960	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		961
		962	sub timer {
		963	my ($class, %arg) = @_;
		964
		965	my $cb = $arg{cb};
		966
		967	urxvt::timer
		968	->new
		969	->after ($arg{after}, $arg{interval})
		970	->cb ($arg{interval} ? $cb : sub {
		971	$_[0]->stop; # need to cancel manually
		972	$cb->();
		973	})
		974	}
		975
		976	sub io {
		977	my ($class, %arg) = @_;
		978
		979	my $cb = $arg{cb};
		980	my $fd = fileno $arg{fh};
		981	defined $fd or $fd = $arg{fh};
		982
		983	bless [$arg{fh}, urxvt::iow
		984	->new
		985	->fd ($fd)
		986	->events (($arg{poll} =~ /r/ ? 1 : 0)
		987	| ($arg{poll} =~ /w/ ? 2 : 0))
		988	->start
		989	->cb ($cb)
		990	], urxvt::anyevent::
		991	}
		992
		993	sub idle {
		994	my ($class, %arg) = @_;
		995
		996	my $cb = $arg{cb};
		997
		998	urxvt::iw
		999	->new
		1000	->start
		1001	->cb ($cb)
		1002	}
		1003
		1004	sub child {
		1005	my ($class, %arg) = @_;
		1006
		1007	my $cb = $arg{cb};
		1008
		1009	urxvt::pw
		1010	->new
		1011	->start ($arg{pid})
		1012	->cb (sub {
		1013	$_[0]->stop; # need to cancel manually
		1014	$cb->($_[0]->rpid, $_[0]->rstatus);
		1015	})
		1016	}
		1017
		1018	sub DESTROY {
		1019	$_[0][1]->stop;
		1020	}
		1021
		1022	# only needed for AnyEvent < 6 compatibility
		1023	sub one_event {
		1024	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1025	}
		1026
		1027	package urxvt::term;
377		1028
378	=head2 The C<urxvt::term> Class	1029	=head2 The C<urxvt::term> Class
379		1030
380	=over 4	1031	=over 4
		1032
		1033	=cut
		1034
		1035	# find on_xxx subs in the package and register them
		1036	# as hooks
		1037	sub register_package {
		1038	my ($self, $pkg, $argv) = @_;
		1039
		1040	no strict 'refs';
		1041
		1042	urxvt::verbose 6, "register package $pkg to $self";
		1043
		1044	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1045
		1046	my $proxy = bless {
		1047	_pkg => $pkg,
		1048	_name => ${"$pkg\::_NAME"}, # hackish
		1049	argv => $argv,
		1050	}, $pkg;
		1051	Scalar::Util::weaken ($proxy->{term} = $self);
		1052
		1053	$self->{_pkg}{$pkg} = $proxy;
		1054
		1055	for my $name (@HOOKNAME) {
		1056	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1057	$proxy->enable ($name => $ref);
		1058	}
		1059	}
		1060	}
		1061
		1062	sub perl_libdirs {
		1063	map { split /:/ }
		1064	$_[0]->resource ("perl_lib"),
		1065	$ENV{URXVT_PERL_LIB},
		1066	"$ENV{HOME}/.urxvt/ext",
		1067	"$LIBDIR/perl"
		1068	}
		1069
		1070	sub scan_meta {
		1071	my ($self) = @_;
		1072	my @libdirs = perl_libdirs $self;
		1073
		1074	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1075
		1076	my %meta;
		1077
		1078	$self->{meta_libdirs} = join "\x00", @libdirs;
		1079	$self->{meta} = \%meta;
		1080
		1081	for my $dir (reverse @libdirs) {
		1082	opendir my $fh, $dir
		1083	or next;
		1084	for my $ext (readdir $fh) {
		1085	$ext !~ /^\./
		1086	and open my $fh, "<", "$dir/$ext"
		1087	or next;
		1088
		1089	while (<$fh>) {
		1090	if (/^#:META:X_RESOURCE:(.*)/) {
		1091	my ($pattern, $type, $desc) = split /:/, $1;
		1092	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1093	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1094	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1095	} else {
		1096	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1097	}
		1098	} elsif (/^\s*(?:#|$)/) {
		1099	# skip other comments and empty lines
		1100	} else {
		1101	last; # stop parsing on first non-empty non-comment line
		1102	}
		1103	}
		1104	}
		1105	}
		1106	}
		1107
		1108	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1109
		1110	Creates a new terminal, very similar as if you had started it with system
		1111	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1112	hash which defines the environment of the new terminal.
		1113
		1114	Croaks (and probably outputs an error message) if the new instance
		1115	couldn't be created. Returns C<undef> if the new instance didn't
		1116	initialise perl, and the terminal object otherwise. The C<init> and
		1117	C<start> hooks will be called before this call returns, and are free to
		1118	refer to global data (which is race free).
		1119
		1120	=cut
		1121
		1122	sub new {
		1123	my ($class, $env, @args) = @_;
		1124
		1125	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1126	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1127
		1128	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1129	}
		1130
		1131	=item $term->destroy
		1132
		1133	Destroy the terminal object (close the window, free resources
		1134	etc.). Please note that urxvt will not exit as long as any event
		1135	watchers (timers, io watchers) are still active.
		1136
		1137	=item $term->exec_async ($cmd[, @args])
		1138
		1139	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1140	("starts") programs in the background. This function takes care of setting
		1141	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1142	be preferred over explicit calls to C<exec> or C<system>.
		1143
		1144	Returns the pid of the subprocess or C<undef> on error.
		1145
		1146	=cut
		1147
		1148	sub exec_async {
		1149	my $self = shift;
		1150
		1151	my $pid = fork;
		1152
		1153	return $pid
		1154	if !defined $pid or $pid;
		1155
		1156	%ENV = %{ $self->env };
		1157
		1158	exec @_;
		1159	urxvt::_exit 255;
		1160	}
		1161
		1162	=item $isset = $term->option ($optval[, $set])
		1163
		1164	Returns true if the option specified by C<$optval> is enabled, and
		1165	optionally change it. All option values are stored by name in the hash
		1166	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		1167
		1168	Here is a likely non-exhaustive list of option names, please see the
		1169	source file F</src/optinc.h> to see the actual list:
		1170
		1171	borderLess buffered console cursorBlink cursorUnderline hold iconic
		1172	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1173	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
		1174	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
		1175	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
		1176	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1177	urgentOnBell utmpInhibit visualBell
381		1178
382	=item $value = $term->resource ($name[, $newval])	1179	=item $value = $term->resource ($name[, $newval])
383		1180
384	Returns the current resource value associated with a given name and	1181	Returns the current resource value associated with a given name and
385	optionally sets a new value. Setting values is most useful in the C<init>	1182	optionally sets a new value. Setting values is most useful in the C<init>
…		…
394	likely change).	1191	likely change).
395		1192
396	Please note that resource strings will currently only be freed when the	1193	Please note that resource strings will currently only be freed when the
397	terminal is destroyed, so changing options frequently will eat memory.	1194	terminal is destroyed, so changing options frequently will eat memory.
398		1195
399	Here is a a likely non-exhaustive list of resource names, not all of which	1196	Here is a likely non-exhaustive list of resource names, not all of which
400	are supported in every build, please see the source to see the actual	1197	are supported in every build, please see the source file F</src/rsinc.h>
401	list:	1198	to see the actual list:
402		1199
403	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1200	answerbackstring backgroundPixmap backspace_key blurradius
404	borderLess color cursorBlink cursorUnderline cutchars delete_key	1201	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
405	display_name embed ext_bwidth fade font geometry hold iconName	1202	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
406	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1203	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1204	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
407	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1205	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
408	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	1206	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
409	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1207	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
410	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1208	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
411	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1209	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
412	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1210	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
413	shade term_name title transparent transparent_all tripleclickwords	1211	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1212	term_name title transient_for transparent tripleclickwords urgentOnBell
414	utmpInhibit visualBell	1213	utmpInhibit visualBell
415		1214
416	=cut	1215	=cut
417		1216
418	sub urxvt::term::resource($$;$) {	1217	sub resource($$;$) {
419	my ($self, $name) = (shift, shift);	1218	my ($self, $name) = (shift, shift);
420	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1219	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
421	goto &urxvt::term::_resource;	1220	goto &urxvt::term::_resource
422	}	1221	}
		1222
		1223	=item $value = $term->x_resource ($pattern)
		1224
		1225	Returns the X-Resource for the given pattern, excluding the program or
		1226	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1227	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1228	resource with that pattern exists.
		1229
		1230	Extensions that define extra resource or command line arguments also need
		1231	to call this method to access their values.
		1232
		1233	If the method is called on an extension object (basically, from an
		1234	extension), then the special prefix C<%.> will be replaced by the name of
		1235	the extension and a dot, and the lone string C<%> will be replaced by the
		1236	extension name itself. This makes it possible to code extensions so you
		1237	can rename them and get a new set of commandline switches and resources
		1238	without having to change the actual code.
		1239
		1240	This method should only be called during the C<on_start> hook, as there is
		1241	only one resource database per display, and later invocations might return
		1242	the wrong resources.
		1243
		1244	=item $value = $term->x_resource_boolean ($pattern)
		1245
		1246	Like C<x_resource>, above, but interprets the string value as a boolean
		1247	and returns C<1> for true values, C<0> for false values and C<undef> if
		1248	the resource or option isn't specified.
		1249
		1250	You should always use this method to parse boolean resources.
		1251
		1252	=cut
		1253
		1254	sub x_resource_boolean {
		1255	my $res = &x_resource;
		1256
		1257	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1258	}
		1259
		1260	=item $success = $term->parse_keysym ($key, $octets)
		1261
		1262	Adds a key binding exactly as specified via a resource. See the
		1263	C<keysym> resource in the urxvt(1) manpage.
		1264
		1265	=item $term->register_command ($keysym, $modifiermask, $string)
		1266
		1267	Adds a key binding. This is a lower level api compared to
		1268	C<parse_keysym>, as it expects a parsed key description, and can be
		1269	used only inside either the C<on_init> hook, to add a binding, or the
		1270	C<on_register_command> hook, to modify a parsed binding.
		1271
		1272	=item $rend = $term->rstyle ([$new_rstyle])
		1273
		1274	Return and optionally change the current rendition. Text that is output by
		1275	the terminal application will use this style.
		1276
		1277	=item ($row, $col) = $term->screen_cur ([$row, $col])
		1278
		1279	Return the current coordinates of the text cursor position and optionally
		1280	set it (which is usually bad as applications don't expect that).
423		1281
424	=item ($row, $col) = $term->selection_mark ([$row, $col])	1282	=item ($row, $col) = $term->selection_mark ([$row, $col])
425		1283
426	=item ($row, $col) = $term->selection_beg ([$row, $col])	1284	=item ($row, $col) = $term->selection_beg ([$row, $col])
427		1285
428	=item ($row, $col) = $term->selection_end ([$row, $col])	1286	=item ($row, $col) = $term->selection_end ([$row, $col])
429		1287
430	Return the current values of the selection mark, begin or end positions,	1288	Return the current values of the selection mark, begin or end positions.
431	and optionally set them to new values.
432		1289
		1290	When arguments are given, then the selection coordinates are set to
		1291	C<$row> and C<$col>, and the selection screen is set to the current
		1292	screen.
		1293
		1294	=item $screen = $term->selection_screen ([$screen])
		1295
		1296	Returns the current selection screen, and then optionally sets it.
		1297
		1298	=item $term->selection_make ($eventtime[, $rectangular])
		1299
		1300	Tries to make a selection as set by C<selection_beg> and
		1301	C<selection_end>. If C<$rectangular> is true (default: false), a
		1302	rectangular selection will be made. This is the preferred function to make
		1303	a selection.
		1304
433	=item $success = $term->selection_grab ($eventtime)	1305	=item $success = $term->selection_grab ($eventtime[, $clipboard])
434		1306
435	Try to request the primary selection from the server (for example, as set	1307	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
436	by the next method).	1308	true) selection from the server. The corresponding text can be set
		1309	with the next method. No visual feedback will be given. This function
		1310	is mostly useful from within C<on_sel_grab> hooks.
437		1311
438	=item $oldtext = $term->selection ([$newtext])	1312	=item $oldtext = $term->selection ([$newtext, $clipboard])
439		1313
440	Return the current selection text and optionally replace it by C<$newtext>.	1314	Return the current selection (clipboard if C<$clipboard> is true) text
		1315	and optionally replace it by C<$newtext>.
441		1316
		1317	=item $term->selection_clear ([$clipboard])
		1318
		1319	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1320
442	#=item $term->overlay ($x, $y, $text)	1321	=item $term->overlay_simple ($x, $y, $text)
443	#	1322
444	#Create a simple multi-line overlay box. See the next method for details.	1323	Create a simple multi-line overlay box. See the next method for details.
445	#	1324
446	#=cut	1325	=cut
447		1326
448	sub urxvt::term::scr_overlay {	1327	sub overlay_simple {
449	die;
450	my ($self, $x, $y, $text) = @_;	1328	my ($self, $x, $y, $text) = @_;
451		1329
452	my @lines = split /\n/, $text;	1330	my @lines = split /\n/, $text;
453		1331
454	my $w = 0;	1332	my $w = List::Util::max map $self->strwidth ($_), @lines;
455	for (map $self->strwidth ($_), @lines) {
456	$w = $_ if $w < $_;
457	}
458		1333
459	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	1334	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
460	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1335	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		1336
		1337	$overlay
461	}	1338	}
462		1339
463	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1340	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
464		1341
465	Create a new (empty) overlay at the given position with the given	1342	Create a new (empty) overlay at the given position with the given
…		…
477		1354
478	The methods currently supported on C<urxvt::overlay> objects are:	1355	The methods currently supported on C<urxvt::overlay> objects are:
479		1356
480	=over 4	1357	=over 4
481		1358
482	=item $overlay->set ($x, $y, $text, $rend)	1359	=item $overlay->set ($x, $y, $text[, $rend])
483		1360
484	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1361	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
485	text in rxvt-unicode's special encoding and an array of rendition values	1362	text in rxvt-unicode's special encoding and an array of rendition values
486	at a specific position inside the overlay.	1363	at a specific position inside the overlay.
487		1364
		1365	If C<$rend> is missing, then the rendition will not be changed.
		1366
488	=item $overlay->hide	1367	=item $overlay->hide
489		1368
490	If visible, hide the overlay, but do not destroy it.	1369	If visible, hide the overlay, but do not destroy it.
491		1370
492	=item $overlay->show	1371	=item $overlay->show
493		1372
494	If hidden, display the overlay again.	1373	If hidden, display the overlay again.
495		1374
496	=back	1375	=back
497		1376
		1377	=item $popup = $term->popup ($event)
		1378
		1379	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1380	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1381	currently).
		1382
		1383	=cut
		1384
		1385	sub popup {
		1386	my ($self, $event) = @_;
		1387
		1388	$self->grab ($event->{time}, 1)
		1389	or return;
		1390
		1391	my $popup = bless {
		1392	term => $self,
		1393	event => $event,
		1394	}, urxvt::popup::;
		1395
		1396	Scalar::Util::weaken $popup->{term};
		1397
		1398	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1399	Scalar::Util::weaken $self->{_destroy}{$popup};
		1400
		1401	$popup
		1402	}
		1403
498	=item $cellwidth = $term->strwidth $string	1404	=item $cellwidth = $term->strwidth ($string)
499		1405
500	Returns the number of screen-cells this string would need. Correctly	1406	Returns the number of screen-cells this string would need. Correctly
501	accounts for wide and combining characters.	1407	accounts for wide and combining characters.
502		1408
503	=item $octets = $term->locale_encode $string	1409	=item $octets = $term->locale_encode ($string)
504		1410
505	Convert the given text string into the corresponding locale encoding.	1411	Convert the given text string into the corresponding locale encoding.
506		1412
507	=item $string = $term->locale_decode $octets	1413	=item $string = $term->locale_decode ($octets)
508		1414
509	Convert the given locale-encoded octets into a perl string.	1415	Convert the given locale-encoded octets into a perl string.
510		1416
		1417	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1418
		1419	XORs the rendition values in the given span with the provided value
		1420	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1421	refresh hooks to provide effects similar to the selection.
		1422
		1423	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1424
		1425	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1426	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1427	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1428	it instead. Both styles I<MUST NOT> contain font styles.
		1429
		1430	=item $term->scr_bell
		1431
		1432	Ring the bell!
		1433
		1434	=item $term->scr_add_lines ($string)
		1435
		1436	Write the given text string to the screen, as if output by the application
		1437	running inside the terminal. It may not contain command sequences (escape
		1438	codes), but is free to use line feeds, carriage returns and tabs. The
		1439	string is a normal text string, not in locale-dependent encoding.
		1440
		1441	Normally its not a good idea to use this function, as programs might be
		1442	confused by changes in cursor position or scrolling. Its useful inside a
		1443	C<on_add_lines> hook, though.
		1444
		1445	=item $term->scr_change_screen ($screen)
		1446
		1447	Switch to given screen - 0 primary, 1 secondary.
		1448
		1449	=item $term->cmd_parse ($octets)
		1450
		1451	Similar to C<scr_add_lines>, but the argument must be in the
		1452	locale-specific encoding of the terminal and can contain command sequences
		1453	(escape codes) that will be interpreted.
		1454
511	=item $term->tt_write ($octets)	1455	=item $term->tt_write ($octets)
512		1456
513	Write the octets given in C<$data> to the tty (i.e. as program input). To	1457	Write the octets given in C<$octets> to the tty (i.e. as program input). To
514	pass characters instead of octets, you should convert your strings first	1458	pass characters instead of octets, you should convert your strings first
515	to the locale-specific encoding using C<< $term->locale_encode >>.	1459	to the locale-specific encoding using C<< $term->locale_encode >>.
516		1460
		1461	=item $term->tt_paste ($octets)
		1462
		1463	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1464	CR and bracketing the data with control sequences if bracketed paste mode
		1465	is set.
		1466
		1467	=item $old_events = $term->pty_ev_events ([$new_events])
		1468
		1469	Replaces the event mask of the pty watcher by the given event mask. Can
		1470	be used to suppress input and output handling to the pty/tty. See the
		1471	description of C<< urxvt::timer->events >>. Make sure to always restore
		1472	the previous value.
		1473
		1474	=item $fd = $term->pty_fd
		1475
		1476	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1477	is used.
		1478
		1479	=item $windowid = $term->parent
		1480
		1481	Return the window id of the toplevel window.
		1482
		1483	=item $windowid = $term->vt
		1484
		1485	Return the window id of the terminal window.
		1486
		1487	=item $term->vt_emask_add ($x_event_mask)
		1488
		1489	Adds the specified events to the vt event mask. Useful e.g. when you want
		1490	to receive pointer events all the times:
		1491
		1492	$term->vt_emask_add (urxvt::PointerMotionMask);
		1493
		1494	=item $term->set_urgency ($set)
		1495
		1496	Enable/disable the urgency hint on the toplevel window.
		1497
		1498	=item $term->focus_in
		1499
		1500	=item $term->focus_out
		1501
		1502	=item $term->key_press ($state, $keycode[, $time])
		1503
		1504	=item $term->key_release ($state, $keycode[, $time])
		1505
		1506	Deliver various fake events to to terminal.
		1507
		1508	=item $window_width = $term->width
		1509
		1510	=item $window_height = $term->height
		1511
		1512	=item $font_width = $term->fwidth
		1513
		1514	=item $font_height = $term->fheight
		1515
		1516	=item $font_ascent = $term->fbase
		1517
517	=item $nrow = $term->nrow	1518	=item $terminal_rows = $term->nrow
518		1519
519	=item $ncol = $term->ncol	1520	=item $terminal_columns = $term->ncol
520		1521
521	Return the number of rows/columns of the terminal window (i.e. as	1522	=item $has_focus = $term->focus
522	specified by C<-geometry>, excluding any scrollback).
523		1523
		1524	=item $is_mapped = $term->mapped
		1525
		1526	=item $max_scrollback = $term->saveLines
		1527
		1528	=item $nrow_plus_saveLines = $term->total_rows
		1529
		1530	=item $topmost_scrollback_row = $term->top_row
		1531
		1532	Return various integers describing terminal characteristics.
		1533
		1534	=item $x_display = $term->display_id
		1535
		1536	Return the DISPLAY used by rxvt-unicode.
		1537
		1538	=item $lc_ctype = $term->locale
		1539
		1540	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1541
524	=item $nsaved = $term->nsaved	1542	=item $env = $term->env
525		1543
526	Returns the number of lines in the scrollback buffer.	1544	Returns a copy of the environment in effect for the terminal as a hashref
		1545	similar to C<\%ENV>.
		1546
		1547	=item @envv = $term->envv
		1548
		1549	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1550
		1551	=item @argv = $term->argv
		1552
		1553	Return the argument vector as this terminal, similar to @ARGV, but
		1554	includes the program name as first element.
		1555
		1556	=cut
		1557
		1558	sub env {
		1559	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1560	}
		1561
		1562	=item $modifiermask = $term->ModLevel3Mask
		1563
		1564	=item $modifiermask = $term->ModMetaMask
		1565
		1566	=item $modifiermask = $term->ModNumLockMask
		1567
		1568	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1569	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1570
		1571	=item $screen = $term->current_screen
		1572
		1573	Returns the currently displayed screen (0 primary, 1 secondary).
		1574
		1575	=item $cursor_is_hidden = $term->hidden_cursor
		1576
		1577	Returns whether the cursor is currently hidden or not.
527		1578
528	=item $view_start = $term->view_start ([$newvalue])	1579	=item $view_start = $term->view_start ([$newvalue])
529		1580
530	Returns the negative row number of the topmost line. Minimum value is	1581	Returns the row number of the topmost displayed line. Maximum value is
531	C<0>, which displays the normal terminal contents. Larger values scroll	1582	C<0>, which displays the normal terminal contents. Lower values scroll
532	this many lines into the scrollback buffer.	1583	this many lines into the scrollback buffer.
533		1584
534	=item $term->want_refresh	1585	=item $term->want_refresh
535		1586
536	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1587	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
539		1590
540	Used after changing terminal contents to display them.	1591	Used after changing terminal contents to display them.
541		1592
542	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1593	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
543		1594
544	Returns the text of the entire row with number C<$row_number>. Row C<0>	1595	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
545	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1596	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
546	terminal line. The scrollback buffer starts at line C<-1> and extends to	1597	terminal line. Nothing will be returned if a nonexistent line
547	line C<< -$term->nsaved >>.	1598	is requested.
548		1599
549	If C<$new_text> is specified, it will replace characters in the current	1600	If C<$new_text> is specified, it will replace characters in the current
550	line, starting at column C<$start_col> (default C<0>), which is useful	1601	line, starting at column C<$start_col> (default C<0>), which is useful
551	to replace only parts of a line. The font index in the rendition will	1602	to replace only parts of a line. The font index in the rendition will
552	automatically be updated.	1603	automatically be updated.
553		1604
554	C<$text> is in a special encoding: tabs and wide characters that use more	1605	C<$text> is in a special encoding: tabs and wide characters that use more
555	than one cell when displayed are padded with urxvt::NOCHAR characters	1606	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
556	(C<chr 65535>). Characters with combining characters and other characters	1607	characters. Characters with combining characters and other characters that
557	that do not fit into the normal tetx encoding will be replaced with	1608	do not fit into the normal text encoding will be replaced with characters
558	characters in the private use area.	1609	in the private use area.
559		1610
560	You have to obey this encoding when changing text. The advantage is	1611	You have to obey this encoding when changing text. The advantage is
561	that C<substr> and similar functions work on screen cells and not on	1612	that C<substr> and similar functions work on screen cells and not on
562	characters.	1613	characters.
563		1614
…		…
574		1625
575	See the section on RENDITION, above.	1626	See the section on RENDITION, above.
576		1627
577	=item $length = $term->ROW_l ($row_number[, $new_length])	1628	=item $length = $term->ROW_l ($row_number[, $new_length])
578		1629
579	Returns the number of screen cells that are in use ("the line length"). If	1630	Returns the number of screen cells that are in use ("the line
580	it is C<-1>, then the line is part of a multiple-row logical "line", which	1631	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
581	means all characters are in use and it is continued on the next row.	1632	line is joined with the following one.
		1633
		1634	=item $bool = $term->is_longer ($row_number)
		1635
		1636	Returns true if the row is part of a multiple-row logical "line" (i.e.
		1637	joined with the following row), which means all characters are in use
		1638	and it is continued on the next row (and possibly a continuation of the
		1639	previous row(s)).
		1640
		1641	=item $line = $term->line ($row_number)
		1642
		1643	Create and return a new C<urxvt::line> object that stores information
		1644	about the logical line that row C<$row_number> is part of. It supports the
		1645	following methods:
		1646
		1647	=over 4
		1648
		1649	=item $text = $line->t ([$new_text])
		1650
		1651	Returns or replaces the full text of the line, similar to C<ROW_t>
		1652
		1653	=item $rend = $line->r ([$new_rend])
		1654
		1655	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		1656
		1657	=item $length = $line->l
		1658
		1659	Returns the length of the line in cells, similar to C<ROW_l>.
		1660
		1661	=item $rownum = $line->beg
		1662
		1663	=item $rownum = $line->end
		1664
		1665	Return the row number of the first/last row of the line, respectively.
		1666
		1667	=item $offset = $line->offset_of ($row, $col)
		1668
		1669	Returns the character offset of the given row|col pair within the logical
		1670	line. Works for rows outside the line, too, and returns corresponding
		1671	offsets outside the string.
		1672
		1673	=item ($row, $col) = $line->coord_of ($offset)
		1674
		1675	Translates a string offset into terminal coordinates again.
		1676
		1677	=back
		1678
		1679	=cut
		1680
		1681	sub line {
		1682	my ($self, $row) = @_;
		1683
		1684	my $maxrow = $self->nrow - 1;
		1685
		1686	my ($beg, $end) = ($row, $row);
		1687
		1688	--$beg while $self->ROW_is_longer ($beg - 1);
		1689	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1690
		1691	bless {
		1692	term => $self,
		1693	beg => $beg,
		1694	end => $end,
		1695	ncol => $self->ncol,
		1696	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1697	}, urxvt::line::
		1698	}
		1699
		1700	sub urxvt::line::t {
		1701	my ($self) = @_;
		1702
		1703	if (@_ > 1) {
		1704	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1705	for $self->{beg} .. $self->{end};
		1706	}
		1707
		1708	defined wantarray &&
		1709	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1710	0, $self->{len}
		1711	}
		1712
		1713	sub urxvt::line::r {
		1714	my ($self) = @_;
		1715
		1716	if (@_ > 1) {
		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) {
		1722	my $rend = [
		1723	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1724	];
		1725	$#$rend = $self->{len} - 1;
		1726	return $rend;
		1727	}
		1728
		1729	()
		1730	}
		1731
		1732	sub urxvt::line::beg { $_[0]{beg} }
		1733	sub urxvt::line::end { $_[0]{end} }
		1734	sub urxvt::line::l { $_[0]{len} }
		1735
		1736	sub urxvt::line::offset_of {
		1737	my ($self, $row, $col) = @_;
		1738
		1739	($row - $self->{beg}) * $self->{ncol} + $col
		1740	}
		1741
		1742	sub urxvt::line::coord_of {
		1743	my ($self, $offset) = @_;
		1744
		1745	use integer;
		1746
		1747	(
		1748	$offset / $self->{ncol} + $self->{beg},
		1749	$offset % $self->{ncol}
		1750	)
		1751	}
582		1752
583	=item $text = $term->special_encode $string	1753	=item $text = $term->special_encode $string
584		1754
585	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,
586	where one character corresponds to one screen cell. See	1756	where one character corresponds to one screen cell. See
587	C<< $term->ROW_t >> for details.	1757	C<< $term->ROW_t >> for details.
588		1758
589	=item $string = $term->special_decode $text	1759	=item $string = $term->special_decode $text
590		1760
591	Converts rxvt-unicodes text reprsentation into a perl string. See	1761	Converts rxvt-unicodes text representation into a perl string. See
592	C<< $term->ROW_t >> for details.	1762	C<< $term->ROW_t >> for details.
593		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
594	=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;
595		1968
596	=head2 The C<urxvt::timer> Class	1969	=head2 The C<urxvt::timer> Class
597		1970
598	This class implements timer watchers/events. Time is represented as a	1971	This class implements timer watchers/events. Time is represented as a
599	fractional number of seconds since the epoch. Example:	1972	fractional number of seconds since the epoch. Example:
…		…
603	->new	1976	->new
604	->interval (1)	1977	->interval (1)
605	->cb (sub {	1978	->cb (sub {
606	$term->{overlay}->set (0, 0,	1979	$term->{overlay}->set (0, 0,
607	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1980	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
608	});	1981	});
609		1982
610	=over 4	1983	=over 4
611		1984
612	=item $timer = new urxvt::timer	1985	=item $timer = new urxvt::timer
613		1986
…		…
616		1989
617	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1990	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
618		1991
619	Set the callback to be called when the timer triggers.	1992	Set the callback to be called when the timer triggers.
620		1993
621	=item $tstamp = $timer->at
622
623	Return the time this watcher will fire next.
624
625	=item $timer = $timer->set ($tstamp)	1994	=item $timer = $timer->set ($tstamp[, $interval])
626		1995
627	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).
628		1998
629	=item $timer = $timer->interval ($interval)	1999	=item $timer = $timer->interval ($interval)
630		2000
631	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
632	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
633	is automatically rescheduled at the given intervals.	2003	is automatically rescheduled at the given intervals.
634		2004
635	=item $timer = $timer->start	2005	=item $timer = $timer->start
636		2006
637	Start the timer.	2007	Start the timer.
638		2008
639	=item $timer = $timer->start ($tstamp)	2009	=item $timer = $timer->start ($tstamp[, $interval])
640		2010
641	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>.
642		2017
643	=item $timer = $timer->stop	2018	=item $timer = $timer->stop
644		2019
645	Stop the timer.	2020	Stop the timer.
646		2021
…		…
652		2027
653	$term->{socket} = ...	2028	$term->{socket} = ...
654	$term->{iow} = urxvt::iow	2029	$term->{iow} = urxvt::iow
655	->new	2030	->new
656	->fd (fileno $term->{socket})	2031	->fd (fileno $term->{socket})
657	->events (1) # wait for read data	2032	->events (urxvt::EV_READ)
658	->start	2033	->start
659	->cb (sub {	2034	->cb (sub {
660	my ($iow, $revents) = @_;	2035	my ($iow, $revents) = @_;
661	# $revents must be 1 here, no need to check	2036	# $revents must be 1 here, no need to check
662	sysread $term->{socket}, my $buf, 8192	2037	sysread $term->{socket}, my $buf, 8192
…		…
675	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>
676	is a bitset as described in the C<events> method.	2051	is a bitset as described in the C<events> method.
677		2052
678	=item $iow = $iow->fd ($fd)	2053	=item $iow = $iow->fd ($fd)
679		2054
680	Set the filedescriptor (not handle) to watch.	2055	Set the file descriptor (not handle) to watch.
681		2056
682	=item $iow = $iow->events ($eventmask)	2057	=item $iow = $iow->events ($eventmask)
683		2058
684	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
685	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>.
686		2062
687	=item $iow = $iow->start	2063	=item $iow = $iow->start
688		2064
689	Start watching for requested events on the given handle.	2065	Start watching for requested events on the given handle.
690		2066
691	=item $iow = $iow->stop	2067	=item $iow = $iow->stop
692		2068
693	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.
694		2131
695	=back	2132	=back
696		2133
697	=head1 ENVIRONMENT	2134	=head1 ENVIRONMENT
698		2135
…		…
701	This variable controls the verbosity level of the perl extension. Higher	2138	This variable controls the verbosity level of the perl extension. Higher
702	numbers indicate more verbose output.	2139	numbers indicate more verbose output.
703		2140
704	=over 4	2141	=over 4
705		2142
706	=item 0 - only fatal messages	2143	=item == 0 - fatal messages
707		2144
708	=item 3 - script loading and management	2145	=item >= 3 - script loading and management
709		2146
710	=item 10 - all events received	2147	=item >=10 - all called hooks
		2148
		2149	=item >=11 - hook return values
711		2150
712	=back	2151	=back
713		2152
714	=head1 AUTHOR	2153	=head1 AUTHOR
715		2154
716	Marc Lehmann <pcg@goof.com>	2155	Marc Lehmann <schmorp@schmorp.de>
717	http://software.schmorp.de/pkg/rxvt-unicode	2156	http://software.schmorp.de/pkg/rxvt-unicode
718		2157
719	=cut	2158	=cut
720		2159
721	1	2160	1
		2161
		2162	# vim: sw=3:

Diff Legend

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