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.1 by root, Mon Jan 2 15:35:43 2006 UTC vs.
Revision 1.104 by root, Wed Jan 18 17:49:47 2006 UTC

		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	urxvt - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
6		8
7	Put your scripts into $LIBDIR/perl-init/, they will be loaded automatically.	9	# create a file grab_test in $HOME:
8
9	Each script will only be loaded once, even in urxvtd, and will be valid
10	globally.
11
12	Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
13	thus must be written in utf-8.
14		10
15	sub on_sel_grab {	11	sub on_sel_grab {
16	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
		13	()
17	}	14	}
18		15
19	1	16	# start a @@RXVT_NAME@@ using it:
		17
		18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
20		19
21	=head1 DESCRIPTION	20	=head1 DESCRIPTION
22		21
		22	Everytime 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' 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 @@RXVT_NAME@@d, where
		29	scripts will be shared (but not enabled) for all terminals.
		30
		31	=head1 PREPACKAGED EXTENSIONS
		32
		33	This section describes the extensions delivered with this release. You can
		34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		35
		36	You can activate them like this:
		37
		38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	=over 4
		41
		42	=item selection (enabled by default)
		43
		44	(More) intelligent selection. This extension tries to be more intelligent
		45	when the user extends selections (double-click and further clicks). Right
		46	now, it tries to select words, urls and complete shell-quoted
		47	arguments, which is very convenient, too, if your F<ls> supports
		48	C<--quoting-style=shell>.
		49
		50	A double-click usually selects the word under the cursor, further clicks
		51	will enlarge the selection.
		52
		53	The selection works by trying to match a number of regexes and displaying
		54	them in increasing order of length. You can add your own regexes by
		55	specifying resources of the form:
		56
		57	URxvt.selection.pattern-0: perl-regex
		58	URxvt.selection.pattern-1: perl-regex
		59	...
		60
		61	The index number (0, 1...) must not have any holes, and each regex must
		62	contain at least one pair of capturing parentheses, which will be used for
		63	the match. For example, the followign adds a regex that matches everything
		64	between two vertical bars:
		65
		66	URxvt.selection.pattern-0: \\|([^|]+)\\|
		67
		68	You can look at the source of the selection extension to see more
		69	interesting uses, such as parsing a line from beginning to end.
		70
		71	This extension also offers following bindable keyboard commands:
		72
		73	=over 4
		74
		75	=item rot13
		76
		77	Rot-13 the selection when activated. Used via keyboard trigger:
		78
		79	URxvt.keysym.C-M-r: perl:selection:rot13
		80
		81	=back
		82
		83	=item option-popup (enabled by default)
		84
		85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		86	runtime.
		87
		88	=item selection-popup (enabled by default)
		89
		90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
		93
		94	Other extensions can extend this popup menu by pushing a code reference onto
		95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
		96
		97	It's sole argument is the popup menu, which can be modified. The selection
		98	is in C<$_>, which can be used to decide wether to add something or not.
		99	It should either return nothing or a string and a code reference. The
		100	string will be used as button text and the code reference will be called
		101	when the button gets activated and should transform C<$_>.
		102
		103	The following will add an entry C<a to b> that transforms all C<a>s in
		104	the selection to C<b>s, but only if the selection currently contains any
		105	C<a>s:
		106
		107	push urxvt::ext::selection_popup::hook, sub {
		108	/a/ ? ("a to be" => sub { s/a/b/g }
		109	: ()
		110	};
		111
		112	=item searchable-scrollback<hotkey> (enabled by default)
		113
		114	Adds regex search functionality to the scrollback buffer, triggered
		115	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		116	input/output is suspended and a regex is displayed at the bottom of the
		117	screen.
		118
		119	Inputting characters appends them to the regex and continues incremental
		120	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		121	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		122	bottom. C<Escape> leaves search mode and returns to the point where search
		123	was started, while C<Enter> or C<Return> stay at the current position and
		124	additionally stores the first match in the current line into the primary
		125	selection.
		126
		127	=item selection-autotransform
		128
		129	This selection allows you to do automatic transforms on a selection
		130	whenever a selection is made.
		131
		132	It works by specifying perl snippets (most useful is a single C<s///>
		133	operator) that modify C<$_> as resources:
		134
		135	URxvt.selection-autotransform.0: transform
		136	URxvt.selection-autotransform.1: transform
		137	...
		138
		139	For example, the following will transform selections of the form
		140	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		141	$word>:
		142
		143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		144
		145	And this example matches the same,but replaces it with vi-commands you can
		146	paste directly into your (vi :) editor:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		149
		150	Of course, this can be modified to suit your needs and your editor :)
		151
		152	To expand the example above to typical perl error messages ("XXX at
		153	FILENAME line YYY."), you need a slightly more elaborate solution:
		154
		155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		157
		158	The first line tells the selection code to treat the unchanging part of
		159	every error message as a selection pattern, and the second line transforms
		160	the message into vi commands to load the file.
		161
		162	=item mark-urls
		163
		164	Uses per-line display filtering (C<on_line_update>) to underline urls and
		165	make them clickable. When middle-clicked, the program specified in the
		166	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		167	the URL as first argument.
		168
		169	=item automove-background
		170
		171	This is basically a one-line extension that dynamically changes the background pixmap offset
		172	to the window position, in effect creating the same effect as pseudo transparency with
		173	a custom pixmap. No scaling is supported in this mode. Exmaple:
		174
		175	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		176
		177	=item block-graphics-to-ascii
		178
		179	A not very useful example of filtering all text output to the terminal,
		180	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		181	similar-looking ascii character.
		182
		183	=item digital-clock
		184
		185	Displays a digital clock using the built-in overlay.
		186
		187	=item example-refresh-hooks
		188
		189	Displays a very simple digital clock in the upper right corner of the
		190	window. Illustrates overwriting the refresh callbacks to create your own
		191	overlays or changes.
		192
		193	=item selection-pastebin
		194
		195	This is a little rarely useful extension that Uploads the selection as
		196	textfile to a remote site (or does other things). (The implementation is
		197	not currently secure for use in a multiuser environment as it writes to
		198	F</tmp> directly.).
		199
		200	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		201	i.e.
		202
		203	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		204
		205	Pressing this combination runs a command with C<%> replaced by the name of
		206	the textfile. This command can be set via a resource:
		207
		208	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		209
		210	And the default is likely not useful to anybody but the few people around
		211	here :)
		212
		213	The name of the textfile is the hex encoded md5 sum of the selection, so
		214	the same content should lead to the same filename.
		215
		216	After a successful upload the selection will be replaced by the text given
		217	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		218	for the filename):
		219
		220	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		221
		222	=back
		223
		224	=head1 API DOCUMENTATION
		225
		226	=head2 General API Considerations
		227
		228	All objects (such as terminals, time watchers etc.) are typical
		229	reference-to-hash objects. The hash can be used to store anything you
		230	like. All members starting with an underscore (such as C<_ptr> or
		231	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
		232	modified).
		233
		234	When objects are destroyed on the C++ side, the perl object hashes are
		235	emptied, so its best to store related objects such as time watchers and
		236	the like inside the terminal object so they get destroyed as soon as the
		237	terminal is destroyed.
		238
		239	Argument names also often indicate the type of a parameter. Here are some
		240	hints on what they mean:
		241
		242	=over 4
		243
		244	=item $text
		245
		246	Rxvt-unicodes special way of encoding text, where one "unicode" character
		247	always represents one screen cell. See L<ROW_t> for a discussion of this format.
		248
		249	=item $string
		250
		251	A perl text string, with an emphasis on I<text>. It can store all unicode
		252	characters and is to be distinguished with text encoded in a specific
		253	encoding (often locale-specific) and binary data.
		254
		255	=item $octets
		256
		257	Either binary data or - more common - a text string encoded in a
		258	locale-specific way.
		259
		260	=back
		261
		262	=head2 Extension Objects
		263
		264	Very perl extension is a perl class. A separate perl object is created
		265	for each terminal and each extension and passed as the first parameter to
		266	hooks. So extensions can use their C<$self> object without having to think
		267	about other extensions, with the exception of methods and members that
		268	begin with an underscore character C<_>: these are reserved for internal
		269	use.
		270
		271	Although it isn't a C<urxvt::term> object, you can call all methods of the
		272	C<urxvt::term> class on this object.
		273
		274	It has the following methods and data members:
		275
		276	=over 4
		277
		278	=item $urxvt_term = $self->{term}
		279
		280	Returns the C<urxvt::term> object associated with this instance of the
		281	extension. This member I<must not> be changed in any way.
		282
		283	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		284
		285	Dynamically enable the given hooks (named without the C<on_> prefix) for
		286	this extension, replacing any previous hook. This is useful when you want
		287	to overwrite time-critical hooks only temporarily.
		288
		289	=item $self->disable ($hook_name[, $hook_name..])
		290
		291	Dynamically disable the given hooks.
		292
		293	=back
		294
23	=head2 Hooks	295	=head2 Hooks
24		296
25	The following subroutines can be declared in loaded scripts, and will be called	297	The following subroutines can be declared in extension files, and will be
26	whenever the relevant event happens.	298	called whenever the relevant event happens.
27		299
		300	The first argument passed to them is an extension oject as described in
		301	the in the C<Extension Objects> section.
		302
28	All of them must return a boolean value. If it is true, then the event	303	B<All> of these hooks must return a boolean value. If it is true, then the
29	counts as being I<consumed>, and the invocation of other hooks is skipped,	304	event counts as being I<consumed>, and the invocation of other hooks is
30	and the relevant action might not be carried out by the C++ code.	305	skipped, and the relevant action might not be carried out by the C++ code.
31		306
32	When in doubt, return a false value (preferably C<()>).	307	I<< When in doubt, return a false value (preferably C<()>). >>
33		308
34	=over 4	309	=over 4
35		310
36	=item on_init $term	311	=item on_init $term
37		312
38	Called after a new terminal object has been initialized, but before	313	Called after a new terminal object has been initialized, but before
39	windows are created or the command gets run.	314	windows are created or the command gets run. Most methods are unsafe to
		315	call or deliver senseless data, as terminal size and other characteristics
		316	have not yet been determined. You can safely query and change resources,
		317	though.
40		318
41	=item on_reset $term	319	=item on_reset $term
42		320
43	Called after the screen is "reset" for any reason, such as resizing or	321	Called after the screen is "reset" for any reason, such as resizing or
44	control sequences. Here is where you can react on changes to size-related	322	control sequences. Here is where you can react on changes to size-related
…		…
64	requested from the server. The selection text can be queried and changed	342	requested from the server. The selection text can be queried and changed
65	by calling C<< $term->selection >>.	343	by calling C<< $term->selection >>.
66		344
67	Returning a true value aborts selection grabbing. It will still be hilighted.	345	Returning a true value aborts selection grabbing. It will still be hilighted.
68		346
69	=item on_focus_in $term	347	=item on_sel_extend $term
70		348
71	Called whenever the window gets the keyboard focus, before urxvt does	349	Called whenever the user tries to extend the selection (e.g. with a double
72	focus in processing.	350	click) and is either supposed to return false (normal operation), or
		351	should extend the selection itelf and return true to suppress the built-in
		352	processing. This can happen multiple times, as long as the callback
		353	returns true, it will be called on every further click by the user and is
		354	supposed to enlarge the selection more and more, if possible.
73		355
74	=item on_focus_out $term	356	See the F<selection> example extension.
75
76	Called wheneever the window loses keyboard focus, before urxvt does focus
77	out processing.
78		357
79	=item on_view_change $term, $offset	358	=item on_view_change $term, $offset
80		359
81	Called whenever the view offset changes, i..e the user or program	360	Called whenever the view offset changes, i..e the user or program
82	scrolls. Offset C<0> means display the normal terminal, positive values	361	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
90		369
91	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	370	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
92	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	371	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
93	number of lines that will be in the scrollback buffer.	372	number of lines that will be in the scrollback buffer.
94		373
95	=item on_tty_activity $term *NYI*	374	=item on_osc_seq $term, $string
96		375
97	Called whenever the program(s) running in the urxvt window send output.	376	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		377	operating system command) is processed. Cursor position and other state
		378	information is up-to-date when this happens. For interoperability, the
		379	string should start with the extension name and a colon, to distinguish
		380	it from commands for other extensions, and this might be enforced in the
		381	future.
		382
		383	Be careful not ever to trust (in a security sense) the data you receive,
		384	as its source can not easily be controleld (e-mail content, messages from
		385	other users on the same system etc.).
		386
		387	=item on_add_lines $term, $string
		388
		389	Called whenever text is about to be output, with the text as argument. You
		390	can filter/change and output the text yourself by returning a true value
		391	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		392	might be very slow, however, as your hook is called for B<all> text being
		393	output.
		394
		395	=item on_tt_write $term, $octets
		396
		397	Called whenever some data is written to the tty/pty and can be used to
		398	suppress or filter tty input.
		399
		400	=item on_line_update $term, $row
		401
		402	Called whenever a line was updated or changed. Can be used to filter
		403	screen output (e.g. underline urls or other useless stuff). Only lines
		404	that are being shown will be filtered, and, due to performance reasons,
		405	not always immediately.
		406
		407	The row number is always the topmost row of the line if the line spans
		408	multiple rows.
		409
		410	Please note that, if you change the line, then the hook might get called
		411	later with the already-modified line (e.g. if unrelated parts change), so
		412	you cannot just toggle rendition bits, but only set them.
98		413
99	=item on_refresh_begin $term	414	=item on_refresh_begin $term
100		415
101	Called just before the screen gets redrawn. Can be used for overlay	416	Called just before the screen gets redrawn. Can be used for overlay
102	or similar effects by modify terminal contents in refresh_begin, and	417	or similar effects by modify terminal contents in refresh_begin, and
…		…
105		420
106	=item on_refresh_end $term	421	=item on_refresh_end $term
107		422
108	Called just after the screen gets redrawn. See C<on_refresh_begin>.	423	Called just after the screen gets redrawn. See C<on_refresh_begin>.
109		424
		425	=item on_keyboard_command $term, $string
		426
		427	Called whenever the user presses a key combination that has a
		428	C<perl:string> action bound to it (see description of the B<keysym>
		429	resource in the @@RXVT_NAME@@(1) manpage).
		430
		431	=item on_x_event $term, $event
		432
		433	Called on every X event received on the vt window (and possibly other
		434	windows). Should only be used as a last resort. Most event structure
		435	members are not passed.
		436
		437	=item on_focus_in $term
		438
		439	Called whenever the window gets the keyboard focus, before rxvt-unicode
		440	does focus in processing.
		441
		442	=item on_focus_out $term
		443
		444	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		445	focus out processing.
		446
		447	=item on_configure_notify $term, $event
		448
		449	=item on_key_press $term, $event, $keysym, $octets
		450
		451	=item on_key_release $term, $event, $keysym
		452
		453	=item on_button_press $term, $event
		454
		455	=item on_button_release $term, $event
		456
		457	=item on_motion_notify $term, $event
		458
		459	=item on_map_notify $term, $event
		460
		461	=item on_unmap_notify $term, $event
		462
		463	Called whenever the corresponding X event is received for the terminal If
		464	the hook returns true, then the even will be ignored by rxvt-unicode.
		465
		466	The event is a hash with most values as named by Xlib (see the XEvent
		467	manpage), with the additional members C<row> and C<col>, which are the row
		468	and column under the mouse cursor.
		469
		470	C<on_key_press> additionally receives the string rxvt-unicode would
		471	output, if any, in locale-specific encoding.
		472
		473	subwindow.
		474
		475	=back
		476
		477	=cut
		478
		479	package urxvt;
		480
		481	use utf8;
		482	use strict;
		483	use Carp ();
		484	use Scalar::Util ();
		485	use List::Util ();
		486
		487	our $VERSION = 1;
		488	our $TERM;
		489	our @HOOKNAME;
		490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		491	our %OPTION;
		492
		493	our $LIBDIR;
		494	our $RESNAME;
		495	our $RESCLASS;
		496	our $RXVTNAME;
		497
		498	=head2 Variables in the C<urxvt> Package
		499
		500	=over 4
		501
		502	=item $urxvt::LIBDIR
		503
		504	The rxvt-unicode library directory, where, among other things, the perl
		505	modules and scripts are stored.
		506
		507	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		508
		509	The resource class and name rxvt-unicode uses to look up X resources.
		510
		511	=item $urxvt::RXVTNAME
		512
		513	The basename of the installed binaries, usually C<urxvt>.
		514
		515	=item $urxvt::TERM
		516
		517	The current terminal. This variable stores the current C<urxvt::term>
		518	object, whenever a callback/hook is executing.
		519
110	=back	520	=back
111		521
112	=head2 Functions in the C<urxvt> Package	522	=head2 Functions in the C<urxvt> Package
113		523
114	=over 4	524	=over 4
…		…
119	costs! The only time this is acceptable is when the terminal process	529	costs! The only time this is acceptable is when the terminal process
120	starts up.	530	starts up.
121		531
122	=item urxvt::warn $string	532	=item urxvt::warn $string
123		533
124	Calls C<rxvt_warn> witht eh given string which should not include a	534	Calls C<rxvt_warn> with the given string which should not include a
125	newline. The module also overwrites the C<warn> builtin with a function	535	newline. The module also overwrites the C<warn> builtin with a function
126	that calls this function.	536	that calls this function.
127		537
128	Using this function has the advantage that its output ends up in the	538	Using this function has the advantage that its output ends up in the
129	correct place, e.g. on stderr of the connecting urxvtc client.	539	correct place, e.g. on stderr of the connecting urxvtc client.
130		540
131	=item $cellwidth = urxvt::wcswidth $string	541	Messages have a size limit of 1023 bytes currently.
132
133	Returns the number of screen-cells this string would need. Correctly
134	accounts for wide and combining characters.
135		542
136	=item $time = urxvt::NOW	543	=item $time = urxvt::NOW
137		544
138	Returns the "current time" (as per the event loop).	545	Returns the "current time" (as per the event loop).
139		546
		547	=item urxvt::CurrentTime
		548
		549	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		550	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		551	Button4Mask, Button5Mask, AnyModifier
		552
		553	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		554	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		555	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		556	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		557	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		558	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		559	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		560
		561	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		562	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		563	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		564	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		565	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		566	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		567	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		568
		569	Various constants for use in X calls and event processing.
		570
		571	=back
		572
		573	=head2 RENDITION
		574
		575	Rendition bitsets contain information about colour, font, font styles and
		576	similar information for each screen cell.
		577
		578	The following "macros" deal with changes in rendition sets. You should
		579	never just create a bitset, you should always modify an existing one,
		580	as they contain important information required for correct operation of
		581	rxvt-unicode.
		582
		583	=over 4
		584
		585	=item $rend = urxvt::DEFAULT_RSTYLE
		586
		587	Returns the default rendition, as used when the terminal is starting up or
		588	being reset. Useful as a base to start when creating renditions.
		589
		590	=item $rend = urxvt::OVERLAY_RSTYLE
		591
		592	Return the rendition mask used for overlays by default.
		593
		594	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		595
		596	Return the bit that enabled bold, italic, blink, reverse-video and
		597	underline, respectively. To enable such a style, just logically OR it into
		598	the bitset.
		599
		600	=item $foreground = urxvt::GET_BASEFG $rend
		601
		602	=item $background = urxvt::GET_BASEBG $rend
		603
		604	Return the foreground/background colour index, respectively.
		605
		606	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		607
		608	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		609
		610	Replace the foreground/background colour in the rendition mask with the
		611	specified one.
		612
		613	=item $value = urxvt::GET_CUSTOM $rend
		614
		615	Return the "custom" value: Every rendition has 5 bits for use by
		616	extensions. They can be set and changed as you like and are initially
		617	zero.
		618
		619	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		620
		621	Change the custom value.
		622
		623	=back
		624
140	=cut	625	=cut
141		626
142	package urxvt;
143
144	use strict;
145
146	our $term;
147	our @HOOKNAME;
148	our $LIBDIR;
149
150	BEGIN {	627	BEGIN {
151	urxvt->bootstrap;
152
153	# overwrite perl's warn	628	# overwrite perl's warn
154	*CORE::GLOBAL::warn = sub {	629	*CORE::GLOBAL::warn = sub {
155	my $msg = join "", @_;	630	my $msg = join "", @_;
156	$msg .= "\n"	631	$msg .= "\n"
157	unless $msg =~ /\n$/;	632	unless $msg =~ /\n$/;
158	urxvt::warn ($msg);	633	urxvt::warn ($msg);
159	};	634	};
160	}
161		635
		636	# %ENV is the original startup environment
		637	delete $ENV{IFS};
		638	delete $ENV{CDPATH};
		639	delete $ENV{BASH_ENV};
		640	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
		641	}
		642
162	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} || 10;	643	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
163		644
164	sub verbose {	645	sub verbose {
165	my ($level, $msg) = @_;	646	my ($level, $msg) = @_;
166	warn "$msg\n"; #d#	647	warn "$msg\n" if $level <= $verbosity;
167	}	648	}
168		649
169	my @invoke_cb;	650	my %extension_pkg;
		651
		652	# load a single script into its own package, once only
		653	sub extension_package($) {
		654	my ($path) = @_;
		655
		656	no strict 'refs';
		657
		658	$extension_pkg{$path} ||= do {
		659	$path =~ /([^\/\\]+)$/;
		660	my $pkg = $1;
		661	$pkg =~ s/[^[:word:]]/_/g;
		662	$pkg = "urxvt::ext::$pkg";
		663
		664	verbose 3, "loading extension '$path' into package '$pkg'";
		665
		666	open my $fh, "<:raw", $path
		667	or die "$path: $!";
		668
		669	@{"$pkg\::ISA"} = urxvt::term::extension::;
		670
		671	my $source =
		672	"package $pkg; use strict; use utf8;\n"
		673	. "#line 1 \"$path\"\n{\n"
		674	. (do { local $/; <$fh> })
		675	. "\n};\n1";
		676
		677	eval $source
		678	or die "$path: $@";
		679
		680	$pkg
		681	}
		682	}
		683
		684	our $retval; # return value for urxvt
170		685
171	# called by the rxvt core	686	# called by the rxvt core
172	sub invoke {	687	sub invoke {
173	local $term = shift;	688	local $TERM = shift;
174	my $htype = shift;	689	my $htype = shift;
175		690
176	my $cb = $invoke_cb[$htype];	691	if ($htype == 0) { # INIT
		692	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		693
		694	my %ext_arg;
177		695
178	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	696	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
179	if $verbosity >= 10;	697	if ($_ eq "default") {
		698	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
		699	} elsif (/^-(.*)$/) {
		700	delete $ext_arg{$1};
		701	} elsif (/^([^<]+)<(.*)>$/) {
		702	push @{ $ext_arg{$1} }, $2;
		703	} else {
		704	$ext_arg{$_} ||= [];
		705	}
		706	}
180		707
181	while (my ($k, $v) = each %$cb) {	708	while (my ($ext, $argv) = each %ext_arg) {
182	return 1 if $v->($term, @_);	709	my @files = grep -f $_, map "$_/$ext", @dirs;
		710
		711	if (@files) {
		712	$TERM->register_package (extension_package $files[0], $argv);
		713	} else {
		714	warn "perl extension '$ext' not found in perl library search path\n";
		715	}
		716	}
		717
		718	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		719	warn $@ if $@;
183	}	720	}
184		721
		722	$retval = undef;
		723
		724	if (my $cb = $TERM->{_hook}[$htype]) {
		725	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		726	if $verbosity >= 10;
		727
		728	keys %$cb;
		729
		730	while (my ($pkg, $cb) = each %$cb) {
		731	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
		732	and last;
		733
		734	if ($@) {
		735	$TERM->ungrab; # better to lose the grab than the session
		736	warn $@;
		737	}
		738	}
		739
		740	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		741	if $verbosity >= 11;
185	0	742	}
		743
		744	if ($htype == 1) { # DESTROY
		745	# clear package objects
		746	%$_ = () for values %{ $TERM->{_pkg} };
		747
		748	# clear package
		749	%$TERM = ();
		750	}
		751
		752	$retval
186	}	753	}
		754
		755	sub exec_async(@) {
		756	my $pid = fork;
		757
		758	return
		759	if !defined $pid or $pid;
		760
		761	%ENV = %{ $TERM->env };
		762
		763	exec @_;
		764	_exit 255;
		765	}
		766
		767	# urxvt::term::extension
		768
		769	package urxvt::term::extension;
		770
		771	sub enable {
		772	my ($self, %hook) = @_;
		773	my $pkg = $self->{_pkg};
		774
		775	while (my ($name, $cb) = each %hook) {
		776	my $htype = $HOOKTYPE{uc $name};
		777	defined $htype
		778	or Carp::croak "unsupported hook type '$name'";
		779
		780	$self->set_should_invoke ($htype, +1)
		781	unless exists $self->{term}{_hook}[$htype]{$pkg};
		782
		783	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		784	}
		785	}
		786
		787	sub disable {
		788	my ($self, @hook) = @_;
		789	my $pkg = $self->{_pkg};
		790
		791	for my $name (@hook) {
		792	my $htype = $HOOKTYPE{uc $name};
		793	defined $htype
		794	or Carp::croak "unsupported hook type '$name'";
		795
		796	$self->set_should_invoke ($htype, -1)
		797	if delete $self->{term}{_hook}[$htype]{$pkg};
		798	}
		799	}
		800
		801	our $AUTOLOAD;
		802
		803	sub AUTOLOAD {
		804	$AUTOLOAD =~ /:([^:]+)$/
		805	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
		806
		807	eval qq{
		808	sub $AUTOLOAD {
		809	my \$proxy = shift;
		810	\$proxy->{term}->$1 (\@_)
		811	}
		812	1
		813	} or die "FATAL: unable to compile method forwarder: $@";
		814
		815	goto &$AUTOLOAD;
		816	}
		817
		818	sub DESTROY {
		819	# nop
		820	}
		821
		822	# urxvt::destroy_hook
		823
		824	sub urxvt::destroy_hook::DESTROY {
		825	${$_[0]}->();
		826	}
		827
		828	sub urxvt::destroy_hook(&) {
		829	bless \shift, urxvt::destroy_hook::
		830	}
		831
		832	package urxvt::anyevent;
		833
		834	=head2 The C<urxvt::anyevent> Class
		835
		836	The sole purpose of this class is to deliver an interface to the
		837	C<AnyEvent> module - any module using it will work inside urxvt without
		838	further programming. The only exception is that you cannot wait on
		839	condition variables, but non-blocking condvar use is ok. What this means
		840	is that you cannot use blocking APIs, but the non-blocking variant should
		841	work.
		842
		843	=cut
		844
		845	our $VERSION = 1;
		846
		847	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		848	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		849
		850	sub timer {
		851	my ($class, %arg) = @_;
		852
		853	my $cb = $arg{cb};
		854
		855	urxvt::timer
		856	->new
		857	->start (urxvt::NOW + $arg{after})
		858	->cb (sub {
		859	$_[0]->stop; # need to cancel manually
		860	$cb->();
		861	})
		862	}
		863
		864	sub io {
		865	my ($class, %arg) = @_;
		866
		867	my $cb = $arg{cb};
		868
		869	bless [$arg{fh}, urxvt::iow
		870	->new
		871	->fd (fileno $arg{fh})
		872	->events (($arg{poll} =~ /r/ ? 1 : 0)
		873	| ($arg{poll} =~ /w/ ? 2 : 0))
		874	->start
		875	->cb (sub {
		876	$cb->(($_[1] & 1 ? 'r' : '')
		877	. ($_[1] & 2 ? 'w' : ''));
		878	})],
		879	urxvt::anyevent::
		880	}
		881
		882	sub DESTROY {
		883	$_[0][1]->stop;
		884	}
		885
		886	sub condvar {
		887	bless \my $flag, urxvt::anyevent::condvar::
		888	}
		889
		890	sub urxvt::anyevent::condvar::broadcast {
		891	${$_[0]}++;
		892	}
		893
		894	sub urxvt::anyevent::condvar::wait {
		895	unless (${$_[0]}) {
		896	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		897	}
		898	}
		899
		900	package urxvt::term;
		901
		902	=head2 The C<urxvt::term> Class
		903
		904	=over 4
		905
		906	=cut
187		907
188	# find on_xxx subs in the package and register them	908	# find on_xxx subs in the package and register them
189	# as hooks	909	# as hooks
190	sub register_package($) {	910	sub register_package {
191	my ($pkg) = @_;	911	my ($self, $pkg, $argv) = @_;
192		912
		913	my $proxy = bless {
		914	_pkg => $pkg,
		915	argv => $argv,
		916	}, $pkg;
		917	Scalar::Util::weaken ($proxy->{term} = $self);
		918
		919	$self->{_pkg}{$pkg} = $proxy;
		920
193	for my $hook (0.. $#HOOKNAME) {	921	for my $name (@HOOKNAME) {
194	my $name = $HOOKNAME[$hook];
195
196	my $ref = $pkg->can ("on_" . lc $name)	922	if (my $ref = $pkg->can ("on_" . lc $name)) {
197	or next;	923	$proxy->enable ($name => $ref);
198		924	}
199	$invoke_cb[$hook]{$ref*1} = $ref;
200	set_should_invoke $hook, 1;
201	}	925	}
202	}	926	}
203		927
204	my $script_pkg = "script0000";	928	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
205	my %script_pkg;
206		929
207	# load a single script into its own package, once only	930	Creates a new terminal, very similar as if you had started it with system
208	sub load_script($) {	931	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
209	my ($path) = @_;	932	hash which defines the environment of the new terminal.
210		933
211	$script_pkg{$path} ||= do {	934	Croaks (and probably outputs an error message) if the new instance
212	my $pkg = $script_pkg++;	935	couldn't be created. Returns C<undef> if the new instance didn't
213	verbose 3, "loading script '$path' into package '$pkg'";	936	initialise perl, and the terminal object otherwise. The C<init> and
		937	C<start> hooks will be called during this call.
214		938
215	open my $fh, "<:raw", $path	939	=cut
216	or die "$path: $!";
217		940
218	eval "package $pkg; use strict; use utf8;\n"	941	sub new {
219	. "#line 1 \"$path\"\n"	942	my ($class, $env, @args) = @_;
220	. do { local $/; <$fh> }
221	or die "$path: $@";
222		943
223	register_package $pkg;	944	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
224
225	$pkg
226	};
227	}	945	}
228		946
229	load_script $_ for grep -f $_, <$LIBDIR/perl-init/*>;	947	=item $term->destroy
230		948
		949	Destroy the terminal object (close the window, free resources
		950	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		951	watchers (timers, io watchers) are still active.
231		952
232	=back	953	=item $isset = $term->option ($optval[, $set])
233		954
234	=head2 The C<urxvt::term> Class	955	Returns true if the option specified by C<$optval> is enabled, and
		956	optionally change it. All option values are stored by name in the hash
		957	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
235		958
236	=over 4	959	Here is a a likely non-exhaustive list of option names, please see the
		960	source file F</src/optinc.h> to see the actual list:
		961
		962	borderLess console cursorBlink cursorUnderline hold iconic insecure
		963	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		964	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		965	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		966	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		967	tripleclickwords utmpInhibit visualBell
		968
		969	=item $value = $term->resource ($name[, $newval])
		970
		971	Returns the current resource value associated with a given name and
		972	optionally sets a new value. Setting values is most useful in the C<init>
		973	hook. Unset resources are returned and accepted as C<undef>.
		974
		975	The new value must be properly encoded to a suitable character encoding
		976	before passing it to this method. Similarly, the returned value may need
		977	to be converted from the used encoding to text.
		978
		979	Resource names are as defined in F<src/rsinc.h>. Colours can be specified
		980	as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
		981	likely change).
		982
		983	Please note that resource strings will currently only be freed when the
		984	terminal is destroyed, so changing options frequently will eat memory.
		985
		986	Here is a a likely non-exhaustive list of resource names, not all of which
		987	are supported in every build, please see the source file F</src/rsinc.h>
		988	to see the actual list:
		989
		990	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
		991	borderLess color cursorBlink cursorUnderline cutchars delete_key
		992	display_name embed ext_bwidth fade font geometry hold iconName
		993	imFont imLocale inputMethod insecure int_bwidth intensityStyles
		994	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
		995	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
		996	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
		997	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
		998	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
		999	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
		1000	shade term_name title transparent transparent_all tripleclickwords
		1001	utmpInhibit visualBell
		1002
		1003	=cut
		1004
		1005	sub resource($$;$) {
		1006	my ($self, $name) = (shift, shift);
		1007	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
		1008	&urxvt::term::_resource
		1009	}
		1010
		1011	=item $value = $term->x_resource ($pattern)
		1012
		1013	Returns the X-Resource for the given pattern, excluding the program or
		1014	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1015	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1016	resource with that pattern exists.
		1017
		1018	This method should only be called during the C<on_start> hook, as there is
		1019	only one resource database per display, and later invocations might return
		1020	the wrong resources.
		1021
		1022	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1023
		1024	Adds a keymap translation exactly as specified via a resource. See the
		1025	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1026
		1027	=item $rend = $term->rstyle ([$new_rstyle])
		1028
		1029	Return and optionally change the current rendition. Text that is output by
		1030	the terminal application will use this style.
		1031
		1032	=item ($row, $col) = $term->screen_cur ([$row, $col])
		1033
		1034	Return the current coordinates of the text cursor position and optionally
		1035	set it (which is usually bad as applications don't expect that).
237		1036
238	=item ($row, $col) = $term->selection_mark ([$row, $col])	1037	=item ($row, $col) = $term->selection_mark ([$row, $col])
239		1038
240	=item ($row, $col) = $term->selection_beg ([$row, $col])	1039	=item ($row, $col) = $term->selection_beg ([$row, $col])
241		1040
242	=item ($row, $col) = $term->selection_end ([$row, $col])	1041	=item ($row, $col) = $term->selection_end ([$row, $col])
243		1042
244	Return the current values of the selection mark, begin or end positions,	1043	Return the current values of the selection mark, begin or end positions,
245	and optionally set them to new values.	1044	and optionally set them to new values.
246		1045
		1046	=item $term->selection_make ($eventtime[, $rectangular])
		1047
		1048	Tries to make a selection as set by C<selection_beg> and
		1049	C<selection_end>. If C<$rectangular> is true (default: false), a
		1050	rectangular selection will be made. This is the prefered function to make
		1051	a selection.
		1052
247	=item $success = $term->selection_grab ($eventtime)	1053	=item $success = $term->selection_grab ($eventtime)
248		1054
249	Try to request the primary selection from the server (for example, as set	1055	Try to request the primary selection text from the server (for example, as
250	by the next method).	1056	set by the next method). No visual feedback will be given. This function
		1057	is mostly useful from within C<on_sel_grab> hooks.
251		1058
252	=item $oldtext = $term->selection ([$newtext])	1059	=item $oldtext = $term->selection ([$newtext])
253		1060
254	Return the current selection text and optionally replace it by C<$newtext>.	1061	Return the current selection text and optionally replace it by C<$newtext>.
255		1062
256	=item $term->scr_overlay ($x, $y, $text)	1063	=item $term->overlay_simple ($x, $y, $text)
257		1064
258	Create a simple multi-line overlay box. See the next method for details.	1065	Create a simple multi-line overlay box. See the next method for details.
259		1066
260	=cut	1067	=cut
261		1068
262	sub urxvt::term::scr_overlay {	1069	sub overlay_simple {
263	my ($self, $x, $y, $text) = @_;	1070	my ($self, $x, $y, $text) = @_;
264		1071
265	my @lines = split /\n/, $text;	1072	my @lines = split /\n/, $text;
266		1073
267	my $w = 0;	1074	my $w = List::Util::max map $self->strwidth ($_), @lines;
268	for (map urxvt::wcswidth $_, @lines) {	1075
269	$w = $_ if $w < $_;	1076	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
		1077	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		1078
		1079	$overlay
		1080	}
		1081
		1082	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
		1083
		1084	Create a new (empty) overlay at the given position with the given
		1085	width/height. C<$rstyle> defines the initial rendition style
		1086	(default: C<OVERLAY_RSTYLE>).
		1087
		1088	If C<$border> is C<2> (default), then a decorative border will be put
		1089	around the box.
		1090
		1091	If either C<$x> or C<$y> is negative, then this is counted from the
		1092	right/bottom side, respectively.
		1093
		1094	This method returns an urxvt::overlay object. The overlay will be visible
		1095	as long as the perl object is referenced.
		1096
		1097	The methods currently supported on C<urxvt::overlay> objects are:
		1098
		1099	=over 4
		1100
		1101	=item $overlay->set ($x, $y, $text, $rend)
		1102
		1103	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		1104	text in rxvt-unicode's special encoding and an array of rendition values
		1105	at a specific position inside the overlay.
		1106
		1107	=item $overlay->hide
		1108
		1109	If visible, hide the overlay, but do not destroy it.
		1110
		1111	=item $overlay->show
		1112
		1113	If hidden, display the overlay again.
		1114
		1115	=back
		1116
		1117	=item $popup = $term->popup ($event)
		1118
		1119	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1120	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1121	currently).
		1122
		1123	=cut
		1124
		1125	sub popup {
		1126	my ($self, $event) = @_;
		1127
		1128	$self->grab ($event->{time}, 1)
		1129	or return;
		1130
		1131	my $popup = bless {
		1132	term => $self,
		1133	event => $event,
		1134	}, urxvt::popup::;
		1135
		1136	Scalar::Util::weaken $popup->{term};
		1137
		1138	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1139	Scalar::Util::weaken $self->{_destroy}{$popup};
		1140
		1141	$popup
		1142	}
		1143
		1144	=item $cellwidth = $term->strwidth ($string)
		1145
		1146	Returns the number of screen-cells this string would need. Correctly
		1147	accounts for wide and combining characters.
		1148
		1149	=item $octets = $term->locale_encode ($string)
		1150
		1151	Convert the given text string into the corresponding locale encoding.
		1152
		1153	=item $string = $term->locale_decode ($octets)
		1154
		1155	Convert the given locale-encoded octets into a perl string.
		1156
		1157	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1158
		1159	XORs the rendition values in the given span with the provided value
		1160	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1161	refresh hooks to provide effects similar to the selection.
		1162
		1163	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1164
		1165	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1166	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1167	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1168	it instead. Both styles I<MUST NOT> contain font styles.
		1169
		1170	=item $term->scr_bell
		1171
		1172	Ring the bell!
		1173
		1174	=item $term->scr_add_lines ($string)
		1175
		1176	Write the given text string to the screen, as if output by the application
		1177	running inside the terminal. It may not contain command sequences (escape
		1178	codes), but is free to use line feeds, carriage returns and tabs. The
		1179	string is a normal text string, not in locale-dependent encoding.
		1180
		1181	Normally its not a good idea to use this function, as programs might be
		1182	confused by changes in cursor position or scrolling. Its useful inside a
		1183	C<on_add_lines> hook, though.
		1184
		1185	=item $term->cmd_parse ($octets)
		1186
		1187	Similar to C<scr_add_lines>, but the argument must be in the
		1188	locale-specific encoding of the terminal and can contain command sequences
		1189	(escape codes) that will be interpreted.
		1190
		1191	=item $term->tt_write ($octets)
		1192
		1193	Write the octets given in C<$data> to the tty (i.e. as program input). To
		1194	pass characters instead of octets, you should convert your strings first
		1195	to the locale-specific encoding using C<< $term->locale_encode >>.
		1196
		1197	=item $old_events = $term->pty_ev_events ([$new_events])
		1198
		1199	Replaces the event mask of the pty watcher by the given event mask. Can
		1200	be used to suppress input and output handling to the pty/tty. See the
		1201	description of C<< urxvt::timer->events >>. Make sure to always restore
		1202	the previous value.
		1203
		1204	=item $windowid = $term->parent
		1205
		1206	Return the window id of the toplevel window.
		1207
		1208	=item $windowid = $term->vt
		1209
		1210	Return the window id of the terminal window.
		1211
		1212	=item $term->vt_emask_add ($x_event_mask)
		1213
		1214	Adds the specified events to the vt event mask. Useful e.g. when you want
		1215	to receive pointer events all the times:
		1216
		1217	$term->vt_emask_add (urxvt::PointerMotionMask);
		1218
		1219	=item $window_width = $term->width
		1220
		1221	=item $window_height = $term->height
		1222
		1223	=item $font_width = $term->fwidth
		1224
		1225	=item $font_height = $term->fheight
		1226
		1227	=item $font_ascent = $term->fbase
		1228
		1229	=item $terminal_rows = $term->nrow
		1230
		1231	=item $terminal_columns = $term->ncol
		1232
		1233	=item $has_focus = $term->focus
		1234
		1235	=item $is_mapped = $term->mapped
		1236
		1237	=item $max_scrollback = $term->saveLines
		1238
		1239	=item $nrow_plus_saveLines = $term->total_rows
		1240
		1241	=item $topmost_scrollback_row = $term->top_row
		1242
		1243	Return various integers describing terminal characteristics.
		1244
		1245	=item $x_display = $term->display_id
		1246
		1247	Return the DISPLAY used by rxvt-unicode.
		1248
		1249	=item $lc_ctype = $term->locale
		1250
		1251	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1252
		1253	=item $env = $term->env
		1254
		1255	Returns a copy of the environment in effect for the terminal as a hashref
		1256	similar to C<\%ENV>.
		1257
		1258	=cut
		1259
		1260	sub env {
		1261	if (my $env = $_[0]->_env) {
		1262	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1263	} else {
		1264	+{ %ENV }
270	}	1265	}
271
272	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
273	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
274	}	1266	}
275		1267
276	=item $term->scr_overlay_new ($x, $y, $width, $height)	1268	=item $modifiermask = $term->ModLevel3Mask
277		1269
278	Create a new (empty) overlay at the given position with the given	1270	=item $modifiermask = $term->ModMetaMask
279	width/height. A border will be put around the box. If either C<$x> or
280	C<$y> is negative, then this is counted from the right/bottom side,
281	respectively.
282		1271
283	=item $term->scr_overlay_off	1272	=item $modifiermask = $term->ModNumLockMask
284		1273
285	Switch the overlay off again.	1274	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1275	AltGr), the meta key (often Alt) and the num lock key, if applicable.
286		1276
287	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	1277	=item $view_start = $term->view_start ([$newvalue])
288		1278
289	Put a single character (specified numerically) at the given overlay	1279	Returns the row number of the topmost displayed line. Maximum value is
290	position.	1280	C<0>, which displays the normal terminal contents. Lower values scroll
		1281	this many lines into the scrollback buffer.
291		1282
292	=item $term->scr_overlay_set ($x, $y, $text)	1283	=item $term->want_refresh
293		1284
294	Write a string at the given position into the overlay.	1285	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		1286	compare the on-screen display with its stored representation. If they
		1287	differ, it redraws the differences.
		1288
		1289	Used after changing terminal contents to display them.
		1290
		1291	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		1292
		1293	Returns the text of the entire row with number C<$row_number>. Row C<0>
		1294	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		1295	terminal line. The scrollback buffer starts at line C<-1> and extends to
		1296	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		1297	is requested.
		1298
		1299	If C<$new_text> is specified, it will replace characters in the current
		1300	line, starting at column C<$start_col> (default C<0>), which is useful
		1301	to replace only parts of a line. The font index in the rendition will
		1302	automatically be updated.
		1303
		1304	C<$text> is in a special encoding: tabs and wide characters that use more
		1305	than one cell when displayed are padded with urxvt::NOCHAR characters
		1306	(C<chr 65535>). Characters with combining characters and other characters
		1307	that do not fit into the normal tetx encoding will be replaced with
		1308	characters in the private use area.
		1309
		1310	You have to obey this encoding when changing text. The advantage is
		1311	that C<substr> and similar functions work on screen cells and not on
		1312	characters.
		1313
		1314	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		1315	can be used to convert normal strings into this encoding and vice versa.
		1316
		1317	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		1318
		1319	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		1320	bitsets. Rendition bitsets contain information about colour, font, font
		1321	styles and similar information. See also C<< $term->ROW_t >>.
		1322
		1323	When setting rendition, the font mask will be ignored.
		1324
		1325	See the section on RENDITION, above.
		1326
		1327	=item $length = $term->ROW_l ($row_number[, $new_length])
		1328
		1329	Returns the number of screen cells that are in use ("the line
		1330	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
		1331	line is joined with the following one.
		1332
		1333	=item $bool = $term->is_longer ($row_number)
		1334
		1335	Returns true if the row is part of a multiple-row logical "line" (i.e.
		1336	joined with the following row), which means all characters are in use
		1337	and it is continued on the next row (and possibly a continuation of the
		1338	previous row(s)).
		1339
		1340	=item $line = $term->line ($row_number)
		1341
		1342	Create and return a new C<urxvt::line> object that stores information
		1343	about the logical line that row C<$row_number> is part of. It supports the
		1344	following methods:
		1345
		1346	=over 4
		1347
		1348	=item $text = $line->t ([$new_text])
		1349
		1350	Returns or replaces the full text of the line, similar to C<ROW_t>
		1351
		1352	=item $rend = $line->r ([$new_rend])
		1353
		1354	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		1355
		1356	=item $length = $line->l
		1357
		1358	Returns the length of the line in cells, similar to C<ROW_l>.
		1359
		1360	=item $rownum = $line->beg
		1361
		1362	=item $rownum = $line->end
		1363
		1364	Return the row number of the first/last row of the line, respectively.
		1365
		1366	=item $offset = $line->offset_of ($row, $col)
		1367
		1368	Returns the character offset of the given row|col pair within the logical
		1369	line. Works for rows outside the line, too, and returns corresponding
		1370	offsets outside the string.
		1371
		1372	=item ($row, $col) = $line->coord_of ($offset)
		1373
		1374	Translates a string offset into terminal coordinates again.
		1375
		1376	=back
		1377
		1378	=cut
		1379
		1380	sub line {
		1381	my ($self, $row) = @_;
		1382
		1383	my $maxrow = $self->nrow - 1;
		1384
		1385	my ($beg, $end) = ($row, $row);
		1386
		1387	--$beg while $self->ROW_is_longer ($beg - 1);
		1388	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1389
		1390	bless {
		1391	term => $self,
		1392	beg => $beg,
		1393	end => $end,
		1394	ncol => $self->ncol,
		1395	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1396	}, urxvt::line::
		1397	}
		1398
		1399	sub urxvt::line::t {
		1400	my ($self) = @_;
		1401
		1402	if (@_ > 1)
		1403	{
		1404	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1405	for $self->{beg} .. $self->{end};
		1406	}
		1407
		1408	defined wantarray &&
		1409	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1410	0, $self->{len}
		1411	}
		1412
		1413	sub urxvt::line::r {
		1414	my ($self) = @_;
		1415
		1416	if (@_ > 1)
		1417	{
		1418	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1419	for $self->{beg} .. $self->{end};
		1420	}
		1421
		1422	if (defined wantarray) {
		1423	my $rend = [
		1424	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1425	];
		1426	$#$rend = $self->{len} - 1;
		1427	return $rend;
		1428	}
		1429
		1430	()
		1431	}
		1432
		1433	sub urxvt::line::beg { $_[0]{beg} }
		1434	sub urxvt::line::end { $_[0]{end} }
		1435	sub urxvt::line::l { $_[0]{len} }
		1436
		1437	sub urxvt::line::offset_of {
		1438	my ($self, $row, $col) = @_;
		1439
		1440	($row - $self->{beg}) * $self->{ncol} + $col
		1441	}
		1442
		1443	sub urxvt::line::coord_of {
		1444	my ($self, $offset) = @_;
		1445
		1446	use integer;
		1447
		1448	(
		1449	$offset / $self->{ncol} + $self->{beg},
		1450	$offset % $self->{ncol}
		1451	)
		1452	}
		1453
		1454	=item $text = $term->special_encode $string
		1455
		1456	Converts a perl string into the special encoding used by rxvt-unicode,
		1457	where one character corresponds to one screen cell. See
		1458	C<< $term->ROW_t >> for details.
		1459
		1460	=item $string = $term->special_decode $text
		1461
		1462	Converts rxvt-unicodes text reprsentation into a perl string. See
		1463	C<< $term->ROW_t >> for details.
		1464
		1465	=item $success = $term->grab_button ($button, $modifiermask)
		1466
		1467	Registers a synchronous button grab. See the XGrabButton manpage.
		1468
		1469	=item $success = $term->grab ($eventtime[, $sync])
		1470
		1471	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1472	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1473
		1474	=item $term->allow_events_async
		1475
		1476	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1477
		1478	=item $term->allow_events_sync
		1479
		1480	Calls XAllowEvents with SyncBoth for the most recent grab.
		1481
		1482	=item $term->allow_events_replay
		1483
		1484	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1485	recent grab.
		1486
		1487	=item $term->ungrab
		1488
		1489	Calls XUngrab for the most recent grab. Is called automatically on
		1490	evaluation errors, as it is better to lose the grab in the error case as
		1491	the session.
		1492
		1493	=back
		1494
		1495	=cut
		1496
		1497	package urxvt::popup;
		1498
		1499	=head2 The C<urxvt::popup> Class
		1500
		1501	=over 4
		1502
		1503	=cut
		1504
		1505	sub add_item {
		1506	my ($self, $item) = @_;
		1507
		1508	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1509	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1510	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1511
		1512	$item->{render} ||= sub { $_[0]{text} };
		1513
		1514	push @{ $self->{item} }, $item;
		1515	}
		1516
		1517	=item $popup->add_title ($title)
		1518
		1519	Adds a non-clickable title to the popup.
		1520
		1521	=cut
		1522
		1523	sub add_title {
		1524	my ($self, $title) = @_;
		1525
		1526	$self->add_item ({
		1527	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1528	text => $title,
		1529	activate => sub { },
		1530	});
		1531	}
		1532
		1533	=item $popup->add_separator ([$sepchr])
		1534
		1535	Creates a separator, optionally using the character given as C<$sepchr>.
		1536
		1537	=cut
		1538
		1539	sub add_separator {
		1540	my ($self, $sep) = @_;
		1541
		1542	$sep ||= "=";
		1543
		1544	$self->add_item ({
		1545	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1546	text => "",
		1547	render => sub { $sep x $self->{term}->ncol },
		1548	activate => sub { },
		1549	});
		1550	}
		1551
		1552	=item $popup->add_button ($text, $cb)
		1553
		1554	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1555	selected.
		1556
		1557	=cut
		1558
		1559	sub add_button {
		1560	my ($self, $text, $cb) = @_;
		1561
		1562	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1563	}
		1564
		1565	=item $popup->add_toggle ($text, $cb, $initial_value)
		1566
		1567	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1568	whenever it gets toggled, with a boolean indicating its value as its first
		1569	argument.
		1570
		1571	=cut
		1572
		1573	sub add_toggle {
		1574	my ($self, $text, $cb, $value) = @_;
		1575
		1576	my $item; $item = {
		1577	type => "button",
		1578	text => " $text",
		1579	value => $value,
		1580	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1581	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1582	};
		1583
		1584	$self->add_item ($item);
		1585	}
		1586
		1587	=item $popup->show
		1588
		1589	Displays the popup (which is initially hidden).
		1590
		1591	=cut
		1592
		1593	sub show {
		1594	my ($self) = @_;
		1595
		1596	local $urxvt::popup::self = $self;
		1597
		1598	my $env = $self->{term}->env;
		1599	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1600	delete $env->{LC_ALL};
		1601	$env->{LC_CTYPE} = $self->{term}->locale;
		1602
		1603	urxvt::term->new ($env, "popup",
		1604	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1605	"--transient-for" => $self->{term}->parent,
		1606	"-display" => $self->{term}->display_id,
		1607	"-pe" => "urxvt-popup")
		1608	or die "unable to create popup window\n";
		1609	}
		1610
		1611	sub DESTROY {
		1612	my ($self) = @_;
		1613
		1614	delete $self->{term}{_destroy}{$self};
		1615	$self->{term}->ungrab;
		1616	}
295		1617
296	=back	1618	=back
297		1619
298	=head2 The C<urxvt::timer> Class	1620	=head2 The C<urxvt::timer> Class
299		1621
300	This class implements timer watchers/events. Time is represented as a	1622	This class implements timer watchers/events. Time is represented as a
301	fractional number of seconds since the epoch. Example:	1623	fractional number of seconds since the epoch. Example:
302		1624
303	# create a digital clock display in upper right corner	1625	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
304	$term->{timer} = urxvt::timer	1626	$term->{timer} = urxvt::timer
305	->new	1627	->new
306	->start (urxvt::NOW)	1628	->interval (1)
307	->cb (sub {	1629	->cb (sub {
308	my ($timer) = @_;
309	my $time = $timer->at;
310	$timer->start ($time + 1);
311	$self->scr_overlay (-1, 0,	1630	$term->{overlay}->set (0, 0,
312	POSIX::strftime "%H:%M:%S", localtime $time);	1631	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
313	});	1632	});
314		1633
315	=over 4	1634	=over 4
316		1635
317	=item $timer = new urxvt::timer	1636	=item $timer = new urxvt::timer
318		1637
319	Create a new timer object in stopped state.	1638	Create a new timer object in started state. It is scheduled to fire
		1639	immediately.
320		1640
321	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1641	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
322		1642
323	Set the callback to be called when the timer triggers.	1643	Set the callback to be called when the timer triggers.
324		1644
…		…
328		1648
329	=item $timer = $timer->set ($tstamp)	1649	=item $timer = $timer->set ($tstamp)
330		1650
331	Set the time the event is generated to $tstamp.	1651	Set the time the event is generated to $tstamp.
332		1652
		1653	=item $timer = $timer->interval ($interval)
		1654
		1655	Normally (and when C<$interval> is C<0>), the timer will automatically
		1656	stop after it has fired once. If C<$interval> is non-zero, then the timer
		1657	is automatically rescheduled at the given intervals.
		1658
333	=item $timer = $timer->start	1659	=item $timer = $timer->start
334		1660
335	Start the timer.	1661	Start the timer.
336		1662
337	=item $timer = $timer->start ($tstamp)	1663	=item $timer = $timer->start ($tstamp)
338		1664
339	Set the event trigger time to C<$tstamp> and start the timer.	1665	Set the event trigger time to C<$tstamp> and start the timer.
		1666
		1667	=item $timer = $timer->after ($delay)
		1668
		1669	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
340		1670
341	=item $timer = $timer->stop	1671	=item $timer = $timer->stop
342		1672
343	Stop the timer.	1673	Stop the timer.
344		1674
…		…
350		1680
351	$term->{socket} = ...	1681	$term->{socket} = ...
352	$term->{iow} = urxvt::iow	1682	$term->{iow} = urxvt::iow
353	->new	1683	->new
354	->fd (fileno $term->{socket})	1684	->fd (fileno $term->{socket})
355	->events (1) # wait for read data	1685	->events (urxvt::EVENT_READ)
356	->start	1686	->start
357	->cb (sub {	1687	->cb (sub {
358	my ($iow, $revents) = @_;	1688	my ($iow, $revents) = @_;
359	# $revents must be 1 here, no need to check	1689	# $revents must be 1 here, no need to check
360	sysread $term->{socket}, my $buf, 8192	1690	sysread $term->{socket}, my $buf, 8192
…		…
377		1707
378	Set the filedescriptor (not handle) to watch.	1708	Set the filedescriptor (not handle) to watch.
379		1709
380	=item $iow = $iow->events ($eventmask)	1710	=item $iow = $iow->events ($eventmask)
381		1711
382	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1712	Set the event mask to watch. The only allowed values are
383	data, Bit #1 (value C<2>) enables watching for write data.	1713	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1714	together, or C<urxvt::EVENT_NONE>.
384		1715
385	=item $iow = $iow->start	1716	=item $iow = $iow->start
386		1717
387	Start watching for requested events on the given handle.	1718	Start watching for requested events on the given handle.
388		1719
389	=item $iow = $iow->stop	1720	=item $iow = $iow->stop
390		1721
391	Stop watching for events on the given filehandle.	1722	Stop watching for events on the given filehandle.
		1723
		1724	=back
		1725
		1726	=head1 ENVIRONMENT
		1727
		1728	=head2 URXVT_PERL_VERBOSITY
		1729
		1730	This variable controls the verbosity level of the perl extension. Higher
		1731	numbers indicate more verbose output.
		1732
		1733	=over 4
		1734
		1735	=item == 0 - fatal messages
		1736
		1737	=item >= 3 - script loading and management
		1738
		1739	=item >=10 - all called hooks
		1740
		1741	=item >=11 - hook reutrn values
392		1742
393	=back	1743	=back
394		1744
395	=head1 AUTHOR	1745	=head1 AUTHOR
396		1746

Diff Legend

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