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.5 by root, Mon Jan 2 17:20:00 2006 UTC vs.
Revision 1.255 by root, Wed Jun 17 11:59:37 2015 UTC

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

Diff Legend

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