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

Diff Legend

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