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

Diff Legend

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