ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC vs.
Revision 1.218 by root, Sun Jun 10 17:31:53 2012 UTC

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

Diff Legend

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