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

Diff Legend

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