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.2 by root, Mon Jan 2 15:36:27 2006 UTC vs.
Revision 1.252 by root, Sat Dec 27 19:27:42 2014 UTC

		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	urxvt - 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 $LIBDIR/perl-init/, 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 written in 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;
		13	()
17	}	14	}
18		15
19	1	16	# start a urxvt using it:
		17
		18	urxvt --perl-lib $HOME -pe grab_test
20		19
21	=head1 DESCRIPTION	20	=head1 DESCRIPTION
22		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
23	=head2 Hooks	134	=head2 Hooks
24		135
25	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
26	whenever the relevant event happens.	137	called whenever the relevant event happens.
27		138
28	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
29	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
30	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.
31		145
32	When in doubt, return a false value (preferably C<()>).	146	I<< When in doubt, return a false value (preferably C<()>). >>
33		147
34	=over 4	148	=over 4
35		149
36	=item on_init $term	150	=item on_init $term
37		151
38	Called after a new terminal object has been initialized, but before	152	Called after a new terminal object has been initialized, but before
39	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).
40		168
41	=item on_reset $term	169	=item on_reset $term
42		170
43	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
44	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
45	variables.	173	variables.
46		174
47	=item on_start $term	175	=item on_child_start $term, $pid
48		176
49	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.
50	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>.
51		183
52	=item on_sel_make $term, $eventtime	184	=item on_sel_make $term, $eventtime
53		185
54	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
55	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
…		…
62		194
63	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
64	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
65	by calling C<< $term->selection >>.	197	by calling C<< $term->selection >>.
66		198
67	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.
68		200
69	=item on_focus_in $term	201	=item on_sel_extend $term
70		202
71	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
72	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.
73		209
74	=item on_focus_out $term	210	See the F<selection> example extension.
75
76	Called wheneever the window loses keyboard focus, before urxvt does focus
77	out processing.
78		211
79	=item on_view_change $term, $offset	212	=item on_view_change $term, $offset
80		213
81	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
82	scrolls. Offset C<0> means display the normal terminal, positive values	215	scrolls. Offset C<0> means display the normal terminal, positive values
83	show this many lines of scrollback.	216	show this many lines of scrollback.
84		217
85	=item on_scroll_back $term, $lines, $saved	218	=item on_scroll_back $term, $lines, $saved
86		219
…		…
90		223
91	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,
92	$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
93	number of lines that will be in the scrollback buffer.	226	number of lines that will be in the scrollback buffer.
94		227
95	=item on_tty_activity $term *NYI*	228	=item on_osc_seq $term, $op, $args, $resp
96		229
97	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.
98		297
99	=item on_refresh_begin $term	298	=item on_refresh_begin $term
100		299
101	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
102	or similar effects by modify terminal contents in refresh_begin, and	301	similar effects by modifying the terminal contents in refresh_begin, and
103	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
104	code is run after this hook, and takes precedence.	303	code is run after this hook, and takes precedence.
105		304
106	=item on_refresh_end $term	305	=item on_refresh_end $term
107		306
108	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>.
109		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
110	=back	393	=back
111		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
112	=head2 Functions in the C<urxvt> Package	460	=head2 Functions in the C<urxvt> Package
113		461
114	=over 4	462	=over 4
115		463
116	=item urxvt::fatal $errormessage	464	=item urxvt::fatal $errormessage
117		465
118	Fatally aborts execution with the given error message. Avoid at all	466	Fatally aborts execution with the given error message (which should
119	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
120	starts up.	468	is acceptable (and useful) is in the init hook, where it prevents the
		469	terminal from starting up.
121		470
122	=item urxvt::warn $string	471	=item urxvt::warn $string
123		472
124	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
125	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
126	that calls this function.	475	that calls this function.
127		476
128	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
129	correct place, e.g. on stderr of the connecting urxvtc client.	478	correct place, e.g. on stderr of the connecting urxvtc client.
130		479
131	=item $cellwidth = urxvt::wcswidth $string	480	Messages have a size limit of 1023 bytes currently.
132		481
133	Returns the number of screen-cells this string would need. Correctly	482	=item @terms = urxvt::termlist
134	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).
135		488
136	=item $time = urxvt::NOW	489	=item $time = urxvt::NOW
137		490
138	Returns the "current time" (as per the event loop).	491	Returns the "current time" (as per the event loop).
139		492
140	=cut	493	=item urxvt::CurrentTime
141		494
142	package urxvt;	495	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		496	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		497	Button4Mask, Button5Mask, AnyModifier
143		498
144	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
145		506
146	our $term;	507	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
147	our @HOOKNAME;	508	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
148	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
149		575
150	BEGIN {	576	BEGIN {
151	urxvt->bootstrap;
152
153	# overwrite perl's warn	577	# overwrite perl's warn
154	*CORE::GLOBAL::warn = sub {	578	*CORE::GLOBAL::warn = sub {
155	my $msg = join "", @_;	579	my $msg = join "", @_;
156	$msg .= "\n"	580	$msg .= "\n"
157	unless $msg =~ /\n$/;	581	unless $msg =~ /\n$/;
158	urxvt::warn ($msg);	582	urxvt::warn ($msg);
159	};	583	};
160	}	584	}
161		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
162	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} || 10;	650	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
163		651
164	sub verbose {	652	sub verbose {
165	my ($level, $msg) = @_;	653	my ($level, $msg) = @_;
166	warn "$msg\n"; #d#	654	warn "$msg\n" if $level <= $verbosity;
167	}	655	}
168		656
169	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
170		690
171	# called by the rxvt core	691	# called by the rxvt core
172	sub invoke {	692	sub invoke {
173	local $term = shift;	693	local $TERM = shift;
174	my $htype = shift;	694	my $htype = shift;
175		695
176	my $cb = $invoke_cb[$htype];	696	if ($htype == HOOK_INIT) {
		697	my @dirs = $TERM->perl_libdirs;
177		698
178	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	699	$TERM->scan_extensions;
179	if $verbosity >= 10;
180		700
181	while (my ($k, $v) = each %$cb) {	701	my %ext_arg;
182	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 $@;
183	}	753	}
184		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;
185	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
186	}	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
187		1096
188	# find on_xxx subs in the package and register them	1097	# find on_xxx subs in the package and register them
189	# as hooks	1098	# as hooks
190	sub register_package($) {	1099	sub register_package {
191	my ($pkg) = @_;	1100	my ($self, $pkg, $argv) = @_;
192		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
193	for my $hook (0.. $#HOOKNAME) {	1117	for my $name (@HOOKNAME) {
194	my $name = $HOOKNAME[$hook];
195
196	my $ref = $pkg->can ("on_" . lc $name)	1118	if (my $ref = $pkg->can ("on_" . lc $name)) {
197	or next;	1119	$proxy->enable ($name => $ref);
198		1120	}
199	$invoke_cb[$hook]{$ref*1} = $ref;
200	set_should_invoke $hook, 1;
201	}	1121	}
202	}	1122	}
203		1123
204	my $script_pkg = "script0000";	1124	sub perl_libdirs {
205	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	}
206		1131
207	# load a single script into its own package, once only	1132	# scan for available extensions and collect their metadata
208	sub load_script($) {	1133	sub scan_extensions {
209	my ($path) = @_;	1134	my ($self) = @_;
210		1135
211	$script_pkg{$path} ||= do {	1136	return if exists $self->{meta};
212	my $pkg = $script_pkg++;
213	verbose 3, "loading script '$path' into package '$pkg'";
214		1137
215	open my $fh, "<:raw", $path	1138	my @urxvtdirs = perl_libdirs $self;
216	or die "$path: $!";	1139	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
217		1140
218	eval "package $pkg; use strict; use utf8;\n"	1141	$self->{meta} = \my %meta;
219	. "#line 1 \"$path\"\n"
220	. do { local $/; <$fh> }
221	or die "$path: $@";
222		1142
223	register_package $pkg;	1143	# first gather extensions
224		1144
225	$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	}
226	};	1184	};
227	}
228		1185
229	load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>;	1186	# $gather->($_, 0) for @cpandirs;
		1187	$gather->($_, 1) for @urxvtdirs;
230		1188
		1189	# and now merge resources
		1190
		1191	$meta{resource} = \my %resource;
		1192
		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
		1269
		1270	=item $value = $term->resource ($name[, $newval])
		1271
		1272	Returns the current resource value associated with a given name and
		1273	optionally sets a new value. Setting values is most useful in the C<init>
		1274	hook. Unset resources are returned and accepted as C<undef>.
		1275
		1276	The new value must be properly encoded to a suitable character encoding
		1277	before passing it to this method. Similarly, the returned value may need
		1278	to be converted from the used encoding to text.
		1279
		1280	Resource names are as defined in F<src/rsinc.h>. Colours can be specified
		1281	as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
		1282	likely change).
		1283
		1284	Please note that resource strings will currently only be freed when the
		1285	terminal is destroyed, so changing options frequently will eat memory.
		1286
		1287	Here is a likely non-exhaustive list of resource names, not all of which
		1288	are supported in every build, please see the source file F</src/rsinc.h>
		1289	to see the actual list:
		1290
		1291	answerbackstring backgroundPixmap backspace_key blurradius
		1292	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
		1293	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
		1294	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1295	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
		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
		1299	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
		1300	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
		1301	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		1302	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1303	term_name title transient_for transparent tripleclickwords urgentOnBell
		1304	utmpInhibit visualBell
		1305
		1306	=cut
		1307
		1308	sub resource($$;$) {
		1309	my ($self, $name) = (shift, shift);
		1310	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
		1311	goto &urxvt::term::_resource
		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 $success = $term->bind_action ($key, $action)
		1352
		1353	Adds a key binding exactly as specified via a C<keysym> resource. See the
		1354	C<keysym> resource in the urxvt(1) manpage.
		1355
		1356	To add default bindings for actions, an extension should call C<<
		1357	->bind_action >> in its C<init> hook for every such binding. Doing it
		1358	in the C<init> hook allows users to override or remove the binding
		1359	again.
		1360
		1361	Example: the C<searchable-scrollback> by default binds itself
		1362	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1363	$term->bind_action >>.
		1364
		1365	sub init {
		1366	my ($self) = @_;
		1367
		1368	$self->bind_action ("M-s" => "%:start");
		1369	}
		1370
		1371	=item $rend = $term->rstyle ([$new_rstyle])
		1372
		1373	Return and optionally change the current rendition. Text that is output by
		1374	the terminal application will use this style.
		1375
		1376	=item ($row, $col) = $term->screen_cur ([$row, $col])
		1377
		1378	Return the current coordinates of the text cursor position and optionally
		1379	set it (which is usually bad as applications don't expect that).
		1380
		1381	=item ($row, $col) = $term->selection_mark ([$row, $col])
		1382
		1383	=item ($row, $col) = $term->selection_beg ([$row, $col])
		1384
		1385	=item ($row, $col) = $term->selection_end ([$row, $col])
		1386
		1387	Return the current values of the selection mark, begin or end positions.
		1388
		1389	When arguments are given, then the selection coordinates are set to
		1390	C<$row> and C<$col>, and the selection screen is set to the current
		1391	screen.
		1392
		1393	=item $screen = $term->selection_screen ([$screen])
		1394
		1395	Returns the current selection screen, and then optionally sets it.
		1396
		1397	=item $term->selection_make ($eventtime[, $rectangular])
		1398
		1399	Tries to make a selection as set by C<selection_beg> and
		1400	C<selection_end>. If C<$rectangular> is true (default: false), a
		1401	rectangular selection will be made. This is the preferred function to make
		1402	a selection.
		1403
		1404	=item $success = $term->selection_grab ($eventtime[, $clipboard])
		1405
		1406	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1407	true) selection from the server. The corresponding text can be set
		1408	with the next method. No visual feedback will be given. This function
		1409	is mostly useful from within C<on_sel_grab> hooks.
		1410
		1411	=item $oldtext = $term->selection ([$newtext, $clipboard])
		1412
		1413	Return the current selection (clipboard if C<$clipboard> is true) text
		1414	and optionally replace it by C<$newtext>.
		1415
		1416	=item $term->selection_clear ([$clipboard])
		1417
		1418	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1419
		1420	=item $term->overlay_simple ($x, $y, $text)
		1421
		1422	Create a simple multi-line overlay box. See the next method for details.
		1423
		1424	=cut
		1425
		1426	sub overlay_simple {
		1427	my ($self, $x, $y, $text) = @_;
		1428
		1429	my @lines = split /\n/, $text;
		1430
		1431	my $w = List::Util::max map $self->strwidth ($_), @lines;
		1432
		1433	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
		1434	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		1435
		1436	$overlay
		1437	}
		1438
		1439	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
		1440
		1441	Create a new (empty) overlay at the given position with the given
		1442	width/height. C<$rstyle> defines the initial rendition style
		1443	(default: C<OVERLAY_RSTYLE>).
		1444
		1445	If C<$border> is C<2> (default), then a decorative border will be put
		1446	around the box.
		1447
		1448	If either C<$x> or C<$y> is negative, then this is counted from the
		1449	right/bottom side, respectively.
		1450
		1451	This method returns an urxvt::overlay object. The overlay will be visible
		1452	as long as the perl object is referenced.
		1453
		1454	The methods currently supported on C<urxvt::overlay> objects are:
		1455
		1456	=over 4
		1457
		1458	=item $overlay->set ($x, $y, $text[, $rend])
		1459
		1460	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		1461	text in rxvt-unicode's special encoding and an array of rendition values
		1462	at a specific position inside the overlay.
		1463
		1464	If C<$rend> is missing, then the rendition will not be changed.
		1465
		1466	=item $overlay->hide
		1467
		1468	If visible, hide the overlay, but do not destroy it.
		1469
		1470	=item $overlay->show
		1471
		1472	If hidden, display the overlay again.
231		1473
232	=back	1474	=back
233		1475
234	=head2 The C<urxvt::term> Class	1476	=item $popup = $term->popup ($event)
		1477
		1478	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1479	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1480	currently).
		1481
		1482	=cut
		1483
		1484	sub popup {
		1485	my ($self, $event) = @_;
		1486
		1487	$self->grab ($event->{time}, 1)
		1488	or return;
		1489
		1490	my $popup = bless {
		1491	term => $self,
		1492	event => $event,
		1493	}, urxvt::popup::;
		1494
		1495	Scalar::Util::weaken $popup->{term};
		1496
		1497	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1498	Scalar::Util::weaken $self->{_destroy}{$popup};
		1499
		1500	$popup
		1501	}
		1502
		1503	=item $cellwidth = $term->strwidth ($string)
		1504
		1505	Returns the number of screen-cells this string would need. Correctly
		1506	accounts for wide and combining characters.
		1507
		1508	=item $octets = $term->locale_encode ($string)
		1509
		1510	Convert the given text string into the corresponding locale encoding.
		1511
		1512	=item $string = $term->locale_decode ($octets)
		1513
		1514	Convert the given locale-encoded octets into a perl string.
		1515
		1516	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1517
		1518	XORs the rendition values in the given span with the provided value
		1519	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1520	refresh hooks to provide effects similar to the selection.
		1521
		1522	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1523
		1524	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1525	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1526	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1527	it instead. Both styles I<MUST NOT> contain font styles.
		1528
		1529	=item $term->scr_bell
		1530
		1531	Ring the bell!
		1532
		1533	=item $term->scr_add_lines ($string)
		1534
		1535	Write the given text string to the screen, as if output by the application
		1536	running inside the terminal. It may not contain command sequences (escape
		1537	codes - see C<cmd_parse> for that), but is free to use line feeds,
		1538	carriage returns and tabs. The string is a normal text string, not in
		1539	locale-dependent encoding.
		1540
		1541	Normally its not a good idea to use this function, as programs might be
		1542	confused by changes in cursor position or scrolling. Its useful inside a
		1543	C<on_add_lines> hook, though.
		1544
		1545	=item $term->scr_change_screen ($screen)
		1546
		1547	Switch to given screen - 0 primary, 1 secondary.
		1548
		1549	=item $term->cmd_parse ($octets)
		1550
		1551	Similar to C<scr_add_lines>, but the argument must be in the
		1552	locale-specific encoding of the terminal and can contain command sequences
		1553	(escape codes) that will be interpreted.
		1554
		1555	=item $term->tt_write ($octets)
		1556
		1557	Write the octets given in C<$octets> to the tty (i.e. as user input
		1558	to the program, see C<cmd_parse> for the opposite direction). To pass
		1559	characters instead of octets, you should convert your strings first to the
		1560	locale-specific encoding using C<< $term->locale_encode >>.
		1561
		1562	=item $term->tt_write_user_input ($octets)
		1563
		1564	Like C<tt_write>, but should be used when writing strings in response to
		1565	the user pressing a key, to invoke the additional actions requested by
		1566	the user for that case (C<tt_write> doesn't do that).
		1567
		1568	The typical use case would be inside C<on_action> hooks.
		1569
		1570	=item $term->tt_paste ($octets)
		1571
		1572	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1573	CR and bracketing the data with control sequences if bracketed paste mode
		1574	is set.
		1575
		1576	=item $old_events = $term->pty_ev_events ([$new_events])
		1577
		1578	Replaces the event mask of the pty watcher by the given event mask. Can
		1579	be used to suppress input and output handling to the pty/tty. See the
		1580	description of C<< urxvt::timer->events >>. Make sure to always restore
		1581	the previous value.
		1582
		1583	=item $fd = $term->pty_fd
		1584
		1585	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1586	is used.
		1587
		1588	=item $windowid = $term->parent
		1589
		1590	Return the window id of the toplevel window.
		1591
		1592	=item $windowid = $term->vt
		1593
		1594	Return the window id of the terminal window.
		1595
		1596	=item $term->vt_emask_add ($x_event_mask)
		1597
		1598	Adds the specified events to the vt event mask. Useful e.g. when you want
		1599	to receive pointer events all the times:
		1600
		1601	$term->vt_emask_add (urxvt::PointerMotionMask);
		1602
		1603	=item $term->set_urgency ($set)
		1604
		1605	Enable/disable the urgency hint on the toplevel window.
		1606
		1607	=item $term->focus_in
		1608
		1609	=item $term->focus_out
		1610
		1611	=item $term->key_press ($state, $keycode[, $time])
		1612
		1613	=item $term->key_release ($state, $keycode[, $time])
		1614
		1615	Deliver various fake events to to terminal.
		1616
		1617	=item $window_width = $term->width
		1618
		1619	=item $window_height = $term->height
		1620
		1621	=item $font_width = $term->fwidth
		1622
		1623	=item $font_height = $term->fheight
		1624
		1625	=item $font_ascent = $term->fbase
		1626
		1627	=item $terminal_rows = $term->nrow
		1628
		1629	=item $terminal_columns = $term->ncol
		1630
		1631	=item $has_focus = $term->focus
		1632
		1633	=item $is_mapped = $term->mapped
		1634
		1635	=item $max_scrollback = $term->saveLines
		1636
		1637	=item $nrow_plus_saveLines = $term->total_rows
		1638
		1639	=item $topmost_scrollback_row = $term->top_row
		1640
		1641	Return various integers describing terminal characteristics.
		1642
		1643	=item $x_display = $term->display_id
		1644
		1645	Return the DISPLAY used by rxvt-unicode.
		1646
		1647	=item $lc_ctype = $term->locale
		1648
		1649	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1650
		1651	=item $env = $term->env
		1652
		1653	Returns a copy of the environment in effect for the terminal as a hashref
		1654	similar to C<\%ENV>.
		1655
		1656	=item @envv = $term->envv
		1657
		1658	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1659
		1660	=item @argv = $term->argv
		1661
		1662	Return the argument vector as this terminal, similar to @ARGV, but
		1663	includes the program name as first element.
		1664
		1665	=cut
		1666
		1667	sub env {
		1668	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1669	}
		1670
		1671	=item $modifiermask = $term->ModLevel3Mask
		1672
		1673	=item $modifiermask = $term->ModMetaMask
		1674
		1675	=item $modifiermask = $term->ModNumLockMask
		1676
		1677	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1678	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1679
		1680	=item $screen = $term->current_screen
		1681
		1682	Returns the currently displayed screen (0 primary, 1 secondary).
		1683
		1684	=item $cursor_is_hidden = $term->hidden_cursor
		1685
		1686	Returns whether the cursor is currently hidden or not.
		1687
		1688	=item $view_start = $term->view_start ([$newvalue])
		1689
		1690	Returns the row number of the topmost displayed line. Maximum value is
		1691	C<0>, which displays the normal terminal contents. Lower values scroll
		1692	this many lines into the scrollback buffer.
		1693
		1694	=item $term->want_refresh
		1695
		1696	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		1697	compare the on-screen display with its stored representation. If they
		1698	differ, it redraws the differences.
		1699
		1700	Used after changing terminal contents to display them.
		1701
		1702	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		1703
		1704	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
		1705	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
		1706	terminal line. Nothing will be returned if a nonexistent line
		1707	is requested.
		1708
		1709	If C<$new_text> is specified, it will replace characters in the current
		1710	line, starting at column C<$start_col> (default C<0>), which is useful
		1711	to replace only parts of a line. The font index in the rendition will
		1712	automatically be updated.
		1713
		1714	C<$text> is in a special encoding: tabs and wide characters that use more
		1715	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
		1716	characters. Characters with combining characters and other characters that
		1717	do not fit into the normal text encoding will be replaced with characters
		1718	in the private use area.
		1719
		1720	You have to obey this encoding when changing text. The advantage is
		1721	that C<substr> and similar functions work on screen cells and not on
		1722	characters.
		1723
		1724	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		1725	can be used to convert normal strings into this encoding and vice versa.
		1726
		1727	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		1728
		1729	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		1730	bitsets. Rendition bitsets contain information about colour, font, font
		1731	styles and similar information. See also C<< $term->ROW_t >>.
		1732
		1733	When setting rendition, the font mask will be ignored.
		1734
		1735	See the section on RENDITION, above.
		1736
		1737	=item $length = $term->ROW_l ($row_number[, $new_length])
		1738
		1739	Returns the number of screen cells that are in use ("the line
		1740	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
		1741	line is joined with the following one.
		1742
		1743	=item $bool = $term->is_longer ($row_number)
		1744
		1745	Returns true if the row is part of a multiple-row logical "line" (i.e.
		1746	joined with the following row), which means all characters are in use
		1747	and it is continued on the next row (and possibly a continuation of the
		1748	previous row(s)).
		1749
		1750	=item $line = $term->line ($row_number)
		1751
		1752	Create and return a new C<urxvt::line> object that stores information
		1753	about the logical line that row C<$row_number> is part of. It supports the
		1754	following methods:
235		1755
236	=over 4	1756	=over 4
237		1757
238	=item ($row, $col) = $term->selection_mark ([$row, $col])
239
240	=item ($row, $col) = $term->selection_beg ([$row, $col])
241
242	=item ($row, $col) = $term->selection_end ([$row, $col])
243
244	Return the current values of the selection mark, begin or end positions,
245	and optionally set them to new values.
246
247	=item $success = $term->selection_grab ($eventtime)
248
249	Try to request the primary selection from the server (for example, as set
250	by the next method).
251
252	=item $oldtext = $term->selection ([$newtext])	1758	=item $text = $line->t ([$new_text])
253		1759
254	Return the current selection text and optionally replace it by C<$newtext>.	1760	Returns or replaces the full text of the line, similar to C<ROW_t>
255		1761
256	=item $term->scr_overlay ($x, $y, $text)	1762	=item $rend = $line->r ([$new_rend])
257		1763
258	Create a simple multi-line overlay box. See the next method for details.	1764	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
259		1765
260	=cut	1766	=item $length = $line->l
261		1767
262	sub urxvt::term::scr_overlay {	1768	Returns the length of the line in cells, similar to C<ROW_l>.
263	my ($self, $x, $y, $text) = @_;
264		1769
265	my @lines = split /\n/, $text;	1770	=item $rownum = $line->beg
266		1771
267	my $w = 0;	1772	=item $rownum = $line->end
268	for (map urxvt::wcswidth $_, @lines) {	1773
269	$w = $_ if $w < $_;	1774	Return the row number of the first/last row of the line, respectively.
		1775
		1776	=item $offset = $line->offset_of ($row, $col)
		1777
		1778	Returns the character offset of the given row|col pair within the logical
		1779	line. Works for rows outside the line, too, and returns corresponding
		1780	offsets outside the string.
		1781
		1782	=item ($row, $col) = $line->coord_of ($offset)
		1783
		1784	Translates a string offset into terminal coordinates again.
		1785
		1786	=back
		1787
		1788	=cut
		1789
		1790	sub line {
		1791	my ($self, $row) = @_;
		1792
		1793	my $maxrow = $self->nrow - 1;
		1794
		1795	my ($beg, $end) = ($row, $row);
		1796
		1797	--$beg while $self->ROW_is_longer ($beg - 1);
		1798	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1799
		1800	bless {
		1801	term => $self,
		1802	beg => $beg,
		1803	end => $end,
		1804	ncol => $self->ncol,
		1805	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1806	}, urxvt::line::
		1807	}
		1808
		1809	sub urxvt::line::t {
		1810	my ($self) = @_;
		1811
		1812	if (@_ > 1) {
		1813	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1814	for $self->{beg} .. $self->{end};
270	}	1815	}
271		1816
272	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	1817	defined wantarray &&
273	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1818	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1819	0, $self->{len}
274	}	1820	}
275		1821
276	=item $term->scr_overlay_new ($x, $y, $width, $height)	1822	sub urxvt::line::r {
		1823	my ($self) = @_;
277		1824
278	Create a new (empty) overlay at the given position with the given	1825	if (@_ > 1) {
279	width/height. A border will be put around the box. If either C<$x> or	1826	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
280	C<$y> is negative, then this is counted from the right/bottom side,	1827	for $self->{beg} .. $self->{end};
281	respectively.	1828	}
282		1829
283	=item $term->scr_overlay_off	1830	if (defined wantarray) {
		1831	my $rend = [
		1832	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1833	];
		1834	$#$rend = $self->{len} - 1;
		1835	return $rend;
		1836	}
284		1837
285	Switch the overlay off again.	1838	()
		1839	}
286		1840
287	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	1841	sub urxvt::line::beg { $_[0]{beg} }
		1842	sub urxvt::line::end { $_[0]{end} }
		1843	sub urxvt::line::l { $_[0]{len} }
288		1844
289	Put a single character (specified numerically) at the given overlay	1845	sub urxvt::line::offset_of {
290	position.	1846	my ($self, $row, $col) = @_;
291		1847
292	=item $term->scr_overlay_set ($x, $y, $text)	1848	($row - $self->{beg}) * $self->{ncol} + $col
		1849	}
293		1850
294	Write a string at the given position into the overlay.	1851	sub urxvt::line::coord_of {
		1852	my ($self, $offset) = @_;
		1853
		1854	use integer;
		1855
		1856	(
		1857	$offset / $self->{ncol} + $self->{beg},
		1858	$offset % $self->{ncol}
		1859	)
		1860	}
		1861
		1862	=item $text = $term->special_encode $string
		1863
		1864	Converts a perl string into the special encoding used by rxvt-unicode,
		1865	where one character corresponds to one screen cell. See
		1866	C<< $term->ROW_t >> for details.
		1867
		1868	=item $string = $term->special_decode $text
		1869
		1870	Converts rxvt-unicodes text representation into a perl string. See
		1871	C<< $term->ROW_t >> for details.
		1872
		1873	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
		1874
		1875	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1876
		1877	Register/unregister a synchronous button grab. See the XGrabButton
		1878	manpage.
		1879
		1880	=item $success = $term->grab ($eventtime[, $sync])
		1881
		1882	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1883	synchronous (C<$sync> is true). Also remembers the grab timestamp.
		1884
		1885	=item $term->allow_events_async
		1886
		1887	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1888
		1889	=item $term->allow_events_sync
		1890
		1891	Calls XAllowEvents with SyncBoth for the most recent grab.
		1892
		1893	=item $term->allow_events_replay
		1894
		1895	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1896	recent grab.
		1897
		1898	=item $term->ungrab
		1899
		1900	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
		1901	evaluation errors, as it is better to lose the grab in the error case as
		1902	the session.
		1903
		1904	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1905
		1906	=item $atom_name = $term->XGetAtomName ($atom)
		1907
		1908	=item @atoms = $term->XListProperties ($window)
		1909
		1910	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1911
		1912	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1913
		1914	=item $term->XDeleteProperty ($window, $property)
		1915
		1916	=item $window = $term->DefaultRootWindow
		1917
		1918	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1919
		1920	=item $term->XMapWindow ($window)
		1921
		1922	=item $term->XUnmapWindow ($window)
		1923
		1924	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1925
		1926	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1927
		1928	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1929
		1930	=item $keysym = $term->XStringToKeysym ($string)
		1931
		1932	=item $string = $term->XKeysymToString ($keysym)
		1933
		1934	Various X or X-related functions. The C<$term> object only serves as
		1935	the source of the display, otherwise those functions map more-or-less
		1936	directly onto the X functions of the same name.
295		1937
296	=back	1938	=back
		1939
		1940	=cut
		1941
		1942	package urxvt::popup;
		1943
		1944	=head2 The C<urxvt::popup> Class
		1945
		1946	=over 4
		1947
		1948	=cut
		1949
		1950	sub add_item {
		1951	my ($self, $item) = @_;
		1952
		1953	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1954	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1955	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1956
		1957	$item->{render} ||= sub { $_[0]{text} };
		1958
		1959	push @{ $self->{item} }, $item;
		1960	}
		1961
		1962	=item $popup->add_title ($title)
		1963
		1964	Adds a non-clickable title to the popup.
		1965
		1966	=cut
		1967
		1968	sub add_title {
		1969	my ($self, $title) = @_;
		1970
		1971	$self->add_item ({
		1972	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1973	text => $title,
		1974	activate => sub { },
		1975	});
		1976	}
		1977
		1978	=item $popup->add_separator ([$sepchr])
		1979
		1980	Creates a separator, optionally using the character given as C<$sepchr>.
		1981
		1982	=cut
		1983
		1984	sub add_separator {
		1985	my ($self, $sep) = @_;
		1986
		1987	$sep ||= "=";
		1988
		1989	$self->add_item ({
		1990	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1991	text => "",
		1992	render => sub { $sep x $self->{term}->ncol },
		1993	activate => sub { },
		1994	});
		1995	}
		1996
		1997	=item $popup->add_button ($text, $cb)
		1998
		1999	Adds a clickable button to the popup. C<$cb> is called whenever it is
		2000	selected.
		2001
		2002	=cut
		2003
		2004	sub add_button {
		2005	my ($self, $text, $cb) = @_;
		2006
		2007	$self->add_item ({ type => "button", text => $text, activate => $cb});
		2008	}
		2009
		2010	=item $popup->add_toggle ($text, $initial_value, $cb)
		2011
		2012	Adds a toggle/checkbox item to the popup. The callback gets called
		2013	whenever it gets toggled, with a boolean indicating its new value as its
		2014	first argument.
		2015
		2016	=cut
		2017
		2018	sub add_toggle {
		2019	my ($self, $text, $value, $cb) = @_;
		2020
		2021	my $item; $item = {
		2022	type => "button",
		2023	text => " $text",
		2024	value => $value,
		2025	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		2026	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		2027	};
		2028
		2029	$self->add_item ($item);
		2030	}
		2031
		2032	=item $popup->show
		2033
		2034	Displays the popup (which is initially hidden).
		2035
		2036	=cut
		2037
		2038	sub show {
		2039	my ($self) = @_;
		2040
		2041	local $urxvt::popup::self = $self;
		2042
		2043	my $env = $self->{term}->env;
		2044	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		2045	delete $env->{LC_ALL};
		2046	$env->{LC_CTYPE} = $self->{term}->locale;
		2047
		2048	my $term = urxvt::term->new (
		2049	$env, "popup",
		2050	"--perl-lib" => "", "--perl-ext-common" => "",
		2051	"-pty-fd" => -1, "-sl" => 0,
		2052	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		2053	"--transient-for" => $self->{term}->parent,
		2054	"-display" => $self->{term}->display_id,
		2055	"-pe" => "urxvt-popup",
		2056	) or die "unable to create popup window\n";
		2057
		2058	unless (delete $term->{urxvt_popup_init_done}) {
		2059	$term->ungrab;
		2060	$term->destroy;
		2061	die "unable to initialise popup window\n";
		2062	}
		2063	}
		2064
		2065	sub DESTROY {
		2066	my ($self) = @_;
		2067
		2068	delete $self->{term}{_destroy}{$self};
		2069	$self->{term}->ungrab;
		2070	}
		2071
		2072	=back
		2073
		2074	=cut
		2075
		2076	package urxvt::watcher;
297		2077
298	=head2 The C<urxvt::timer> Class	2078	=head2 The C<urxvt::timer> Class
299		2079
300	This class implements timer watchers/events. Time is represented as a	2080	This class implements timer watchers/events. Time is represented as a
301	fractional number of seconds since the epoch. Example:	2081	fractional number of seconds since the epoch. Example:
302		2082
303	# create a digital clock display in upper right corner	2083	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
304	$term->{timer} = urxvt::timer	2084	$term->{timer} = urxvt::timer
305	->new	2085	->new
306	->start (urxvt::NOW)	2086	->interval (1)
307	->cb (sub {	2087	->cb (sub {
308	my ($timer) = @_;
309	my $time = $timer->at;
310	$timer->start ($time + 1);
311	$self->scr_overlay (-1, 0,	2088	$term->{overlay}->set (0, 0,
312	POSIX::strftime "%H:%M:%S", localtime $time);	2089	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
313	});	2090	});
314		2091
315	=over 4	2092	=over 4
316		2093
317	=item $timer = new urxvt::timer	2094	=item $timer = new urxvt::timer
318		2095
319	Create a new timer object in stopped state.	2096	Create a new timer object in started state. It is scheduled to fire
		2097	immediately.
320		2098
321	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2099	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
322		2100
323	Set the callback to be called when the timer triggers.	2101	Set the callback to be called when the timer triggers.
324		2102
325	=item $tstamp = $timer->at
326
327	Return the time this watcher will fire next.
328
329	=item $timer = $timer->set ($tstamp)	2103	=item $timer = $timer->set ($tstamp[, $interval])
330		2104
331	Set the time the event is generated to $tstamp.	2105	Set the time the event is generated to $tstamp (and optionally specifies a
		2106	new $interval).
		2107
		2108	=item $timer = $timer->interval ($interval)
		2109
		2110	By default (and when C<$interval> is C<0>), the timer will automatically
		2111	stop after it has fired once. If C<$interval> is non-zero, then the timer
		2112	is automatically rescheduled at the given intervals.
332		2113
333	=item $timer = $timer->start	2114	=item $timer = $timer->start
334		2115
335	Start the timer.	2116	Start the timer.
336		2117
337	=item $timer = $timer->start ($tstamp)	2118	=item $timer = $timer->start ($tstamp[, $interval])
338		2119
339	Set the event trigger time to C<$tstamp> and start the timer.	2120	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2121	also replaces the interval.
		2122
		2123	=item $timer = $timer->after ($delay[, $interval])
		2124
		2125	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
340		2126
341	=item $timer = $timer->stop	2127	=item $timer = $timer->stop
342		2128
343	Stop the timer.	2129	Stop the timer.
344		2130
…		…
350		2136
351	$term->{socket} = ...	2137	$term->{socket} = ...
352	$term->{iow} = urxvt::iow	2138	$term->{iow} = urxvt::iow
353	->new	2139	->new
354	->fd (fileno $term->{socket})	2140	->fd (fileno $term->{socket})
355	->events (1) # wait for read data	2141	->events (urxvt::EV_READ)
356	->start	2142	->start
357	->cb (sub {	2143	->cb (sub {
358	my ($iow, $revents) = @_;	2144	my ($iow, $revents) = @_;
359	# $revents must be 1 here, no need to check	2145	# $revents must be 1 here, no need to check
360	sysread $term->{socket}, my $buf, 8192	2146	sysread $term->{socket}, my $buf, 8192
…		…
373	Set the callback to be called when io events are triggered. C<$reventmask>	2159	Set the callback to be called when io events are triggered. C<$reventmask>
374	is a bitset as described in the C<events> method.	2160	is a bitset as described in the C<events> method.
375		2161
376	=item $iow = $iow->fd ($fd)	2162	=item $iow = $iow->fd ($fd)
377		2163
378	Set the filedescriptor (not handle) to watch.	2164	Set the file descriptor (not handle) to watch.
379		2165
380	=item $iow = $iow->events ($eventmask)	2166	=item $iow = $iow->events ($eventmask)
381		2167
382	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2168	Set the event mask to watch. The only allowed values are
383	data, Bit #1 (value C<2>) enables watching for write data.	2169	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
		2170	together, or C<urxvt::EV_NONE>.
384		2171
385	=item $iow = $iow->start	2172	=item $iow = $iow->start
386		2173
387	Start watching for requested events on the given handle.	2174	Start watching for requested events on the given handle.
388		2175
389	=item $iow = $iow->stop	2176	=item $iow = $iow->stop
390		2177
391	Stop watching for events on the given filehandle.	2178	Stop watching for events on the given file handle.
392		2179
393	=back	2180	=back
394		2181
		2182	=head2 The C<urxvt::iw> Class
		2183
		2184	This class implements idle watchers, that get called automatically when
		2185	the process is idle. They should return as fast as possible, after doing
		2186	some useful work.
		2187
		2188	=over 4
		2189
		2190	=item $iw = new urxvt::iw
		2191
		2192	Create a new idle watcher object in stopped state.
		2193
		2194	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2195
		2196	Set the callback to be called when the watcher triggers.
		2197
		2198	=item $timer = $timer->start
		2199
		2200	Start the watcher.
		2201
		2202	=item $timer = $timer->stop
		2203
		2204	Stop the watcher.
		2205
		2206	=back
		2207
		2208	=head2 The C<urxvt::pw> Class
		2209
		2210	This class implements process watchers. They create an event whenever a
		2211	process exits, after which they stop automatically.
		2212
		2213	my $pid = fork;
		2214	...
		2215	$term->{pw} = urxvt::pw
		2216	->new
		2217	->start ($pid)
		2218	->cb (sub {
		2219	my ($pw, $exit_status) = @_;
		2220	...
		2221	});
		2222
		2223	=over 4
		2224
		2225	=item $pw = new urxvt::pw
		2226
		2227	Create a new process watcher in stopped state.
		2228
		2229	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2230
		2231	Set the callback to be called when the timer triggers.
		2232
		2233	=item $pw = $timer->start ($pid)
		2234
		2235	Tells the watcher to start watching for process C<$pid>.
		2236
		2237	=item $pw = $pw->stop
		2238
		2239	Stop the watcher.
		2240
		2241	=back
		2242
		2243	=head1 ENVIRONMENT
		2244
		2245	=head2 URXVT_PERL_VERBOSITY
		2246
		2247	This variable controls the verbosity level of the perl extension. Higher
		2248	numbers indicate more verbose output.
		2249
		2250	=over 4
		2251
		2252	=item == 0 - fatal messages
		2253
		2254	=item >= 3 - script loading and management
		2255
		2256	=item >=10 - all called hooks
		2257
		2258	=item >=11 - hook return values
		2259
		2260	=back
		2261
395	=head1 AUTHOR	2262	=head1 AUTHOR
396		2263
397	Marc Lehmann <pcg@goof.com>	2264	Marc Lehmann <schmorp@schmorp.de>
398	http://software.schmorp.de/pkg/rxvt-unicode	2265	http://software.schmorp.de/pkg/rxvt-unicode
399		2266
400	=cut	2267	=cut
401		2268
402	1	2269	1
		2270
		2271	# vim: sw=3:

Diff Legend

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