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.2 by root, Mon Jan 2 15:36:27 2006 UTC vs.
Revision 1.107 by root, Wed Jan 18 21:30:50 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	}	635	}
161		636
162	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} || 10;	637	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
163		638
164	sub verbose {	639	sub verbose {
165	my ($level, $msg) = @_;	640	my ($level, $msg) = @_;
166	warn "$msg\n"; #d#	641	warn "$msg\n" if $level <= $verbosity;
167	}	642	}
168		643
169	my @invoke_cb;	644	my %extension_pkg;
		645
		646	# load a single script into its own package, once only
		647	sub extension_package($) {
		648	my ($path) = @_;
		649
		650	no strict 'refs';
		651
		652	$extension_pkg{$path} ||= do {
		653	$path =~ /([^\/\\]+)$/;
		654	my $pkg = $1;
		655	$pkg =~ s/[^[:word:]]/_/g;
		656	$pkg = "urxvt::ext::$pkg";
		657
		658	verbose 3, "loading extension '$path' into package '$pkg'";
		659
		660	open my $fh, "<:raw", $path
		661	or die "$path: $!";
		662
		663	@{"$pkg\::ISA"} = urxvt::term::extension::;
		664
		665	my $source =
		666	"package $pkg; use strict; use utf8;\n"
		667	. "#line 1 \"$path\"\n{\n"
		668	. (do { local $/; <$fh> })
		669	. "\n};\n1";
		670
		671	eval $source
		672	or die "$path: $@";
		673
		674	$pkg
		675	}
		676	}
		677
		678	our $retval; # return value for urxvt
170		679
171	# called by the rxvt core	680	# called by the rxvt core
172	sub invoke {	681	sub invoke {
173	local $term = shift;	682	local $TERM = shift;
174	my $htype = shift;	683	my $htype = shift;
175		684
176	my $cb = $invoke_cb[$htype];	685	if ($htype == 0) { # INIT
		686	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		687
		688	my %ext_arg;
177		689
178	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	690	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
179	if $verbosity >= 10;	691	if ($_ eq "default") {
		692	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
		693	} elsif (/^-(.*)$/) {
		694	delete $ext_arg{$1};
		695	} elsif (/^([^<]+)<(.*)>$/) {
		696	push @{ $ext_arg{$1} }, $2;
		697	} else {
		698	$ext_arg{$_} ||= [];
		699	}
		700	}
180		701
181	while (my ($k, $v) = each %$cb) {	702	while (my ($ext, $argv) = each %ext_arg) {
182	return 1 if $v->($term, @_);	703	my @files = grep -f $_, map "$_/$ext", @dirs;
		704
		705	if (@files) {
		706	$TERM->register_package (extension_package $files[0], $argv);
		707	} else {
		708	warn "perl extension '$ext' not found in perl library search path\n";
		709	}
		710	}
		711
		712	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		713	warn $@ if $@;
183	}	714	}
184		715
		716	$retval = undef;
		717
		718	if (my $cb = $TERM->{_hook}[$htype]) {
		719	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		720	if $verbosity >= 10;
		721
		722	keys %$cb;
		723
		724	while (my ($pkg, $cb) = each %$cb) {
		725	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
		726	and last;
		727
		728	if ($@) {
		729	$TERM->ungrab; # better to lose the grab than the session
		730	warn $@;
		731	}
		732	}
		733
		734	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		735	if $verbosity >= 11;
185	0	736	}
		737
		738	if ($htype == 1) { # DESTROY
		739	# clear package objects
		740	%$_ = () for values %{ $TERM->{_pkg} };
		741
		742	# clear package
		743	%$TERM = ();
		744	}
		745
		746	$retval
186	}	747	}
		748
		749	sub exec_async(@) {
		750	my $pid = fork;
		751
		752	return
		753	if !defined $pid or $pid;
		754
		755	%ENV = %{ $TERM->env };
		756
		757	exec @_;
		758	_exit 255;
		759	}
		760
		761	# urxvt::term::extension
		762
		763	package urxvt::term::extension;
		764
		765	sub enable {
		766	my ($self, %hook) = @_;
		767	my $pkg = $self->{_pkg};
		768
		769	while (my ($name, $cb) = each %hook) {
		770	my $htype = $HOOKTYPE{uc $name};
		771	defined $htype
		772	or Carp::croak "unsupported hook type '$name'";
		773
		774	$self->set_should_invoke ($htype, +1)
		775	unless exists $self->{term}{_hook}[$htype]{$pkg};
		776
		777	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		778	}
		779	}
		780
		781	sub disable {
		782	my ($self, @hook) = @_;
		783	my $pkg = $self->{_pkg};
		784
		785	for my $name (@hook) {
		786	my $htype = $HOOKTYPE{uc $name};
		787	defined $htype
		788	or Carp::croak "unsupported hook type '$name'";
		789
		790	$self->set_should_invoke ($htype, -1)
		791	if delete $self->{term}{_hook}[$htype]{$pkg};
		792	}
		793	}
		794
		795	our $AUTOLOAD;
		796
		797	sub AUTOLOAD {
		798	$AUTOLOAD =~ /:([^:]+)$/
		799	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
		800
		801	eval qq{
		802	sub $AUTOLOAD {
		803	my \$proxy = shift;
		804	\$proxy->{term}->$1 (\@_)
		805	}
		806	1
		807	} or die "FATAL: unable to compile method forwarder: $@";
		808
		809	goto &$AUTOLOAD;
		810	}
		811
		812	sub DESTROY {
		813	# nop
		814	}
		815
		816	# urxvt::destroy_hook
		817
		818	sub urxvt::destroy_hook::DESTROY {
		819	${$_[0]}->();
		820	}
		821
		822	sub urxvt::destroy_hook(&) {
		823	bless \shift, urxvt::destroy_hook::
		824	}
		825
		826	package urxvt::anyevent;
		827
		828	=head2 The C<urxvt::anyevent> Class
		829
		830	The sole purpose of this class is to deliver an interface to the
		831	C<AnyEvent> module - any module using it will work inside urxvt without
		832	further programming. The only exception is that you cannot wait on
		833	condition variables, but non-blocking condvar use is ok. What this means
		834	is that you cannot use blocking APIs, but the non-blocking variant should
		835	work.
		836
		837	=cut
		838
		839	our $VERSION = 1;
		840
		841	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		842	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		843
		844	sub timer {
		845	my ($class, %arg) = @_;
		846
		847	my $cb = $arg{cb};
		848
		849	urxvt::timer
		850	->new
		851	->start (urxvt::NOW + $arg{after})
		852	->cb (sub {
		853	$_[0]->stop; # need to cancel manually
		854	$cb->();
		855	})
		856	}
		857
		858	sub io {
		859	my ($class, %arg) = @_;
		860
		861	my $cb = $arg{cb};
		862
		863	bless [$arg{fh}, urxvt::iow
		864	->new
		865	->fd (fileno $arg{fh})
		866	->events (($arg{poll} =~ /r/ ? 1 : 0)
		867	| ($arg{poll} =~ /w/ ? 2 : 0))
		868	->start
		869	->cb (sub {
		870	$cb->(($_[1] & 1 ? 'r' : '')
		871	. ($_[1] & 2 ? 'w' : ''));
		872	})],
		873	urxvt::anyevent::
		874	}
		875
		876	sub DESTROY {
		877	$_[0][1]->stop;
		878	}
		879
		880	sub condvar {
		881	bless \my $flag, urxvt::anyevent::condvar::
		882	}
		883
		884	sub urxvt::anyevent::condvar::broadcast {
		885	${$_[0]}++;
		886	}
		887
		888	sub urxvt::anyevent::condvar::wait {
		889	unless (${$_[0]}) {
		890	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		891	}
		892	}
		893
		894	package urxvt::term;
		895
		896	=head2 The C<urxvt::term> Class
		897
		898	=over 4
		899
		900	=cut
187		901
188	# find on_xxx subs in the package and register them	902	# find on_xxx subs in the package and register them
189	# as hooks	903	# as hooks
190	sub register_package($) {	904	sub register_package {
191	my ($pkg) = @_;	905	my ($self, $pkg, $argv) = @_;
192		906
		907	my $proxy = bless {
		908	_pkg => $pkg,
		909	argv => $argv,
		910	}, $pkg;
		911	Scalar::Util::weaken ($proxy->{term} = $self);
		912
		913	$self->{_pkg}{$pkg} = $proxy;
		914
193	for my $hook (0.. $#HOOKNAME) {	915	for my $name (@HOOKNAME) {
194	my $name = $HOOKNAME[$hook];
195
196	my $ref = $pkg->can ("on_" . lc $name)	916	if (my $ref = $pkg->can ("on_" . lc $name)) {
197	or next;	917	$proxy->enable ($name => $ref);
198		918	}
199	$invoke_cb[$hook]{$ref*1} = $ref;
200	set_should_invoke $hook, 1;
201	}	919	}
202	}	920	}
203		921
204	my $script_pkg = "script0000";	922	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
205	my %script_pkg;
206		923
207	# load a single script into its own package, once only	924	Creates a new terminal, very similar as if you had started it with system
208	sub load_script($) {	925	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
209	my ($path) = @_;	926	hash which defines the environment of the new terminal.
210		927
211	$script_pkg{$path} ||= do {	928	Croaks (and probably outputs an error message) if the new instance
212	my $pkg = $script_pkg++;	929	couldn't be created. Returns C<undef> if the new instance didn't
213	verbose 3, "loading script '$path' into package '$pkg'";	930	initialise perl, and the terminal object otherwise. The C<init> and
		931	C<start> hooks will be called during this call.
214		932
215	open my $fh, "<:raw", $path	933	=cut
216	or die "$path: $!";
217		934
218	eval "package $pkg; use strict; use utf8;\n"	935	sub new {
219	. "#line 1 \"$path\"\n"	936	my ($class, $env, @args) = @_;
220	. do { local $/; <$fh> }
221	or die "$path: $@";
222		937
223	register_package $pkg;	938	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
224
225	$pkg
226	};
227	}	939	}
228		940
229	load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>;	941	=item $term->destroy
230		942
		943	Destroy the terminal object (close the window, free resources
		944	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		945	watchers (timers, io watchers) are still active.
231		946
232	=back	947	=item $isset = $term->option ($optval[, $set])
233		948
234	=head2 The C<urxvt::term> Class	949	Returns true if the option specified by C<$optval> is enabled, and
		950	optionally change it. All option values are stored by name in the hash
		951	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
235		952
236	=over 4	953	Here is a a likely non-exhaustive list of option names, please see the
		954	source file F</src/optinc.h> to see the actual list:
		955
		956	borderLess console cursorBlink cursorUnderline hold iconic insecure
		957	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		958	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
		959	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
		960	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
		961	transparent tripleclickwords utmpInhibit visualBell
		962
		963	=item $value = $term->resource ($name[, $newval])
		964
		965	Returns the current resource value associated with a given name and
		966	optionally sets a new value. Setting values is most useful in the C<init>
		967	hook. Unset resources are returned and accepted as C<undef>.
		968
		969	The new value must be properly encoded to a suitable character encoding
		970	before passing it to this method. Similarly, the returned value may need
		971	to be converted from the used encoding to text.
		972
		973	Resource names are as defined in F<src/rsinc.h>. Colours can be specified
		974	as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
		975	likely change).
		976
		977	Please note that resource strings will currently only be freed when the
		978	terminal is destroyed, so changing options frequently will eat memory.
		979
		980	Here is a a likely non-exhaustive list of resource names, not all of which
		981	are supported in every build, please see the source file F</src/rsinc.h>
		982	to see the actual list:
		983
		984	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
		985	borderLess color cursorBlink cursorUnderline cutchars delete_key
		986	display_name embed ext_bwidth fade font geometry hold iconName
		987	imFont imLocale inputMethod insecure int_bwidth intensityStyles
		988	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
		989	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
		990	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
		991	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
		992	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
		993	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		994	secondaryScreen secondaryScroll selectstyle shade term_name title
		995	transient_for transparent transparent_all tripleclickwords utmpInhibit
		996	visualBell
		997
		998	=cut
		999
		1000	sub resource($$;$) {
		1001	my ($self, $name) = (shift, shift);
		1002	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
		1003	&urxvt::term::_resource
		1004	}
		1005
		1006	=item $value = $term->x_resource ($pattern)
		1007
		1008	Returns the X-Resource for the given pattern, excluding the program or
		1009	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1010	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1011	resource with that pattern exists.
		1012
		1013	This method should only be called during the C<on_start> hook, as there is
		1014	only one resource database per display, and later invocations might return
		1015	the wrong resources.
		1016
		1017	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1018
		1019	Adds a keymap translation exactly as specified via a resource. See the
		1020	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1021
		1022	=item $rend = $term->rstyle ([$new_rstyle])
		1023
		1024	Return and optionally change the current rendition. Text that is output by
		1025	the terminal application will use this style.
		1026
		1027	=item ($row, $col) = $term->screen_cur ([$row, $col])
		1028
		1029	Return the current coordinates of the text cursor position and optionally
		1030	set it (which is usually bad as applications don't expect that).
237		1031
238	=item ($row, $col) = $term->selection_mark ([$row, $col])	1032	=item ($row, $col) = $term->selection_mark ([$row, $col])
239		1033
240	=item ($row, $col) = $term->selection_beg ([$row, $col])	1034	=item ($row, $col) = $term->selection_beg ([$row, $col])
241		1035
242	=item ($row, $col) = $term->selection_end ([$row, $col])	1036	=item ($row, $col) = $term->selection_end ([$row, $col])
243		1037
244	Return the current values of the selection mark, begin or end positions,	1038	Return the current values of the selection mark, begin or end positions,
245	and optionally set them to new values.	1039	and optionally set them to new values.
246		1040
		1041	=item $term->selection_make ($eventtime[, $rectangular])
		1042
		1043	Tries to make a selection as set by C<selection_beg> and
		1044	C<selection_end>. If C<$rectangular> is true (default: false), a
		1045	rectangular selection will be made. This is the prefered function to make
		1046	a selection.
		1047
247	=item $success = $term->selection_grab ($eventtime)	1048	=item $success = $term->selection_grab ($eventtime)
248		1049
249	Try to request the primary selection from the server (for example, as set	1050	Try to request the primary selection text from the server (for example, as
250	by the next method).	1051	set by the next method). No visual feedback will be given. This function
		1052	is mostly useful from within C<on_sel_grab> hooks.
251		1053
252	=item $oldtext = $term->selection ([$newtext])	1054	=item $oldtext = $term->selection ([$newtext])
253		1055
254	Return the current selection text and optionally replace it by C<$newtext>.	1056	Return the current selection text and optionally replace it by C<$newtext>.
255		1057
256	=item $term->scr_overlay ($x, $y, $text)	1058	=item $term->overlay_simple ($x, $y, $text)
257		1059
258	Create a simple multi-line overlay box. See the next method for details.	1060	Create a simple multi-line overlay box. See the next method for details.
259		1061
260	=cut	1062	=cut
261		1063
262	sub urxvt::term::scr_overlay {	1064	sub overlay_simple {
263	my ($self, $x, $y, $text) = @_;	1065	my ($self, $x, $y, $text) = @_;
264		1066
265	my @lines = split /\n/, $text;	1067	my @lines = split /\n/, $text;
266		1068
267	my $w = 0;	1069	my $w = List::Util::max map $self->strwidth ($_), @lines;
268	for (map urxvt::wcswidth $_, @lines) {	1070
269	$w = $_ if $w < $_;	1071	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
		1072	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		1073
		1074	$overlay
		1075	}
		1076
		1077	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
		1078
		1079	Create a new (empty) overlay at the given position with the given
		1080	width/height. C<$rstyle> defines the initial rendition style
		1081	(default: C<OVERLAY_RSTYLE>).
		1082
		1083	If C<$border> is C<2> (default), then a decorative border will be put
		1084	around the box.
		1085
		1086	If either C<$x> or C<$y> is negative, then this is counted from the
		1087	right/bottom side, respectively.
		1088
		1089	This method returns an urxvt::overlay object. The overlay will be visible
		1090	as long as the perl object is referenced.
		1091
		1092	The methods currently supported on C<urxvt::overlay> objects are:
		1093
		1094	=over 4
		1095
		1096	=item $overlay->set ($x, $y, $text, $rend)
		1097
		1098	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		1099	text in rxvt-unicode's special encoding and an array of rendition values
		1100	at a specific position inside the overlay.
		1101
		1102	=item $overlay->hide
		1103
		1104	If visible, hide the overlay, but do not destroy it.
		1105
		1106	=item $overlay->show
		1107
		1108	If hidden, display the overlay again.
		1109
		1110	=back
		1111
		1112	=item $popup = $term->popup ($event)
		1113
		1114	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1115	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1116	currently).
		1117
		1118	=cut
		1119
		1120	sub popup {
		1121	my ($self, $event) = @_;
		1122
		1123	$self->grab ($event->{time}, 1)
		1124	or return;
		1125
		1126	my $popup = bless {
		1127	term => $self,
		1128	event => $event,
		1129	}, urxvt::popup::;
		1130
		1131	Scalar::Util::weaken $popup->{term};
		1132
		1133	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1134	Scalar::Util::weaken $self->{_destroy}{$popup};
		1135
		1136	$popup
		1137	}
		1138
		1139	=item $cellwidth = $term->strwidth ($string)
		1140
		1141	Returns the number of screen-cells this string would need. Correctly
		1142	accounts for wide and combining characters.
		1143
		1144	=item $octets = $term->locale_encode ($string)
		1145
		1146	Convert the given text string into the corresponding locale encoding.
		1147
		1148	=item $string = $term->locale_decode ($octets)
		1149
		1150	Convert the given locale-encoded octets into a perl string.
		1151
		1152	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1153
		1154	XORs the rendition values in the given span with the provided value
		1155	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1156	refresh hooks to provide effects similar to the selection.
		1157
		1158	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1159
		1160	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1161	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1162	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1163	it instead. Both styles I<MUST NOT> contain font styles.
		1164
		1165	=item $term->scr_bell
		1166
		1167	Ring the bell!
		1168
		1169	=item $term->scr_add_lines ($string)
		1170
		1171	Write the given text string to the screen, as if output by the application
		1172	running inside the terminal. It may not contain command sequences (escape
		1173	codes), but is free to use line feeds, carriage returns and tabs. The
		1174	string is a normal text string, not in locale-dependent encoding.
		1175
		1176	Normally its not a good idea to use this function, as programs might be
		1177	confused by changes in cursor position or scrolling. Its useful inside a
		1178	C<on_add_lines> hook, though.
		1179
		1180	=item $term->cmd_parse ($octets)
		1181
		1182	Similar to C<scr_add_lines>, but the argument must be in the
		1183	locale-specific encoding of the terminal and can contain command sequences
		1184	(escape codes) that will be interpreted.
		1185
		1186	=item $term->tt_write ($octets)
		1187
		1188	Write the octets given in C<$data> to the tty (i.e. as program input). To
		1189	pass characters instead of octets, you should convert your strings first
		1190	to the locale-specific encoding using C<< $term->locale_encode >>.
		1191
		1192	=item $old_events = $term->pty_ev_events ([$new_events])
		1193
		1194	Replaces the event mask of the pty watcher by the given event mask. Can
		1195	be used to suppress input and output handling to the pty/tty. See the
		1196	description of C<< urxvt::timer->events >>. Make sure to always restore
		1197	the previous value.
		1198
		1199	=item $windowid = $term->parent
		1200
		1201	Return the window id of the toplevel window.
		1202
		1203	=item $windowid = $term->vt
		1204
		1205	Return the window id of the terminal window.
		1206
		1207	=item $term->vt_emask_add ($x_event_mask)
		1208
		1209	Adds the specified events to the vt event mask. Useful e.g. when you want
		1210	to receive pointer events all the times:
		1211
		1212	$term->vt_emask_add (urxvt::PointerMotionMask);
		1213
		1214	=item $window_width = $term->width
		1215
		1216	=item $window_height = $term->height
		1217
		1218	=item $font_width = $term->fwidth
		1219
		1220	=item $font_height = $term->fheight
		1221
		1222	=item $font_ascent = $term->fbase
		1223
		1224	=item $terminal_rows = $term->nrow
		1225
		1226	=item $terminal_columns = $term->ncol
		1227
		1228	=item $has_focus = $term->focus
		1229
		1230	=item $is_mapped = $term->mapped
		1231
		1232	=item $max_scrollback = $term->saveLines
		1233
		1234	=item $nrow_plus_saveLines = $term->total_rows
		1235
		1236	=item $topmost_scrollback_row = $term->top_row
		1237
		1238	Return various integers describing terminal characteristics.
		1239
		1240	=item $x_display = $term->display_id
		1241
		1242	Return the DISPLAY used by rxvt-unicode.
		1243
		1244	=item $lc_ctype = $term->locale
		1245
		1246	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1247
		1248	=item $env = $term->env
		1249
		1250	Returns a copy of the environment in effect for the terminal as a hashref
		1251	similar to C<\%ENV>.
		1252
		1253	=cut
		1254
		1255	sub env {
		1256	if (my $env = $_[0]->_env) {
		1257	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1258	} else {
		1259	+{ %ENV }
270	}	1260	}
271
272	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
273	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
274	}	1261	}
275		1262
276	=item $term->scr_overlay_new ($x, $y, $width, $height)	1263	=item $modifiermask = $term->ModLevel3Mask
277		1264
278	Create a new (empty) overlay at the given position with the given	1265	=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		1266
283	=item $term->scr_overlay_off	1267	=item $modifiermask = $term->ModNumLockMask
284		1268
285	Switch the overlay off again.	1269	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1270	AltGr), the meta key (often Alt) and the num lock key, if applicable.
286		1271
287	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	1272	=item $view_start = $term->view_start ([$newvalue])
288		1273
289	Put a single character (specified numerically) at the given overlay	1274	Returns the row number of the topmost displayed line. Maximum value is
290	position.	1275	C<0>, which displays the normal terminal contents. Lower values scroll
		1276	this many lines into the scrollback buffer.
291		1277
292	=item $term->scr_overlay_set ($x, $y, $text)	1278	=item $term->want_refresh
293		1279
294	Write a string at the given position into the overlay.	1280	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		1281	compare the on-screen display with its stored representation. If they
		1282	differ, it redraws the differences.
		1283
		1284	Used after changing terminal contents to display them.
		1285
		1286	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		1287
		1288	Returns the text of the entire row with number C<$row_number>. Row C<0>
		1289	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		1290	terminal line. The scrollback buffer starts at line C<-1> and extends to
		1291	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		1292	is requested.
		1293
		1294	If C<$new_text> is specified, it will replace characters in the current
		1295	line, starting at column C<$start_col> (default C<0>), which is useful
		1296	to replace only parts of a line. The font index in the rendition will
		1297	automatically be updated.
		1298
		1299	C<$text> is in a special encoding: tabs and wide characters that use more
		1300	than one cell when displayed are padded with urxvt::NOCHAR characters
		1301	(C<chr 65535>). Characters with combining characters and other characters
		1302	that do not fit into the normal tetx encoding will be replaced with
		1303	characters in the private use area.
		1304
		1305	You have to obey this encoding when changing text. The advantage is
		1306	that C<substr> and similar functions work on screen cells and not on
		1307	characters.
		1308
		1309	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		1310	can be used to convert normal strings into this encoding and vice versa.
		1311
		1312	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		1313
		1314	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		1315	bitsets. Rendition bitsets contain information about colour, font, font
		1316	styles and similar information. See also C<< $term->ROW_t >>.
		1317
		1318	When setting rendition, the font mask will be ignored.
		1319
		1320	See the section on RENDITION, above.
		1321
		1322	=item $length = $term->ROW_l ($row_number[, $new_length])
		1323
		1324	Returns the number of screen cells that are in use ("the line
		1325	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
		1326	line is joined with the following one.
		1327
		1328	=item $bool = $term->is_longer ($row_number)
		1329
		1330	Returns true if the row is part of a multiple-row logical "line" (i.e.
		1331	joined with the following row), which means all characters are in use
		1332	and it is continued on the next row (and possibly a continuation of the
		1333	previous row(s)).
		1334
		1335	=item $line = $term->line ($row_number)
		1336
		1337	Create and return a new C<urxvt::line> object that stores information
		1338	about the logical line that row C<$row_number> is part of. It supports the
		1339	following methods:
		1340
		1341	=over 4
		1342
		1343	=item $text = $line->t ([$new_text])
		1344
		1345	Returns or replaces the full text of the line, similar to C<ROW_t>
		1346
		1347	=item $rend = $line->r ([$new_rend])
		1348
		1349	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		1350
		1351	=item $length = $line->l
		1352
		1353	Returns the length of the line in cells, similar to C<ROW_l>.
		1354
		1355	=item $rownum = $line->beg
		1356
		1357	=item $rownum = $line->end
		1358
		1359	Return the row number of the first/last row of the line, respectively.
		1360
		1361	=item $offset = $line->offset_of ($row, $col)
		1362
		1363	Returns the character offset of the given row|col pair within the logical
		1364	line. Works for rows outside the line, too, and returns corresponding
		1365	offsets outside the string.
		1366
		1367	=item ($row, $col) = $line->coord_of ($offset)
		1368
		1369	Translates a string offset into terminal coordinates again.
		1370
		1371	=back
		1372
		1373	=cut
		1374
		1375	sub line {
		1376	my ($self, $row) = @_;
		1377
		1378	my $maxrow = $self->nrow - 1;
		1379
		1380	my ($beg, $end) = ($row, $row);
		1381
		1382	--$beg while $self->ROW_is_longer ($beg - 1);
		1383	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1384
		1385	bless {
		1386	term => $self,
		1387	beg => $beg,
		1388	end => $end,
		1389	ncol => $self->ncol,
		1390	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1391	}, urxvt::line::
		1392	}
		1393
		1394	sub urxvt::line::t {
		1395	my ($self) = @_;
		1396
		1397	if (@_ > 1)
		1398	{
		1399	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1400	for $self->{beg} .. $self->{end};
		1401	}
		1402
		1403	defined wantarray &&
		1404	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1405	0, $self->{len}
		1406	}
		1407
		1408	sub urxvt::line::r {
		1409	my ($self) = @_;
		1410
		1411	if (@_ > 1)
		1412	{
		1413	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1414	for $self->{beg} .. $self->{end};
		1415	}
		1416
		1417	if (defined wantarray) {
		1418	my $rend = [
		1419	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1420	];
		1421	$#$rend = $self->{len} - 1;
		1422	return $rend;
		1423	}
		1424
		1425	()
		1426	}
		1427
		1428	sub urxvt::line::beg { $_[0]{beg} }
		1429	sub urxvt::line::end { $_[0]{end} }
		1430	sub urxvt::line::l { $_[0]{len} }
		1431
		1432	sub urxvt::line::offset_of {
		1433	my ($self, $row, $col) = @_;
		1434
		1435	($row - $self->{beg}) * $self->{ncol} + $col
		1436	}
		1437
		1438	sub urxvt::line::coord_of {
		1439	my ($self, $offset) = @_;
		1440
		1441	use integer;
		1442
		1443	(
		1444	$offset / $self->{ncol} + $self->{beg},
		1445	$offset % $self->{ncol}
		1446	)
		1447	}
		1448
		1449	=item $text = $term->special_encode $string
		1450
		1451	Converts a perl string into the special encoding used by rxvt-unicode,
		1452	where one character corresponds to one screen cell. See
		1453	C<< $term->ROW_t >> for details.
		1454
		1455	=item $string = $term->special_decode $text
		1456
		1457	Converts rxvt-unicodes text reprsentation into a perl string. See
		1458	C<< $term->ROW_t >> for details.
		1459
		1460	=item $success = $term->grab_button ($button, $modifiermask)
		1461
		1462	Registers a synchronous button grab. See the XGrabButton manpage.
		1463
		1464	=item $success = $term->grab ($eventtime[, $sync])
		1465
		1466	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1467	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1468
		1469	=item $term->allow_events_async
		1470
		1471	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1472
		1473	=item $term->allow_events_sync
		1474
		1475	Calls XAllowEvents with SyncBoth for the most recent grab.
		1476
		1477	=item $term->allow_events_replay
		1478
		1479	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1480	recent grab.
		1481
		1482	=item $term->ungrab
		1483
		1484	Calls XUngrab for the most recent grab. Is called automatically on
		1485	evaluation errors, as it is better to lose the grab in the error case as
		1486	the session.
		1487
		1488	=back
		1489
		1490	=cut
		1491
		1492	package urxvt::popup;
		1493
		1494	=head2 The C<urxvt::popup> Class
		1495
		1496	=over 4
		1497
		1498	=cut
		1499
		1500	sub add_item {
		1501	my ($self, $item) = @_;
		1502
		1503	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1504	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1505	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1506
		1507	$item->{render} ||= sub { $_[0]{text} };
		1508
		1509	push @{ $self->{item} }, $item;
		1510	}
		1511
		1512	=item $popup->add_title ($title)
		1513
		1514	Adds a non-clickable title to the popup.
		1515
		1516	=cut
		1517
		1518	sub add_title {
		1519	my ($self, $title) = @_;
		1520
		1521	$self->add_item ({
		1522	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1523	text => $title,
		1524	activate => sub { },
		1525	});
		1526	}
		1527
		1528	=item $popup->add_separator ([$sepchr])
		1529
		1530	Creates a separator, optionally using the character given as C<$sepchr>.
		1531
		1532	=cut
		1533
		1534	sub add_separator {
		1535	my ($self, $sep) = @_;
		1536
		1537	$sep ||= "=";
		1538
		1539	$self->add_item ({
		1540	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1541	text => "",
		1542	render => sub { $sep x $self->{term}->ncol },
		1543	activate => sub { },
		1544	});
		1545	}
		1546
		1547	=item $popup->add_button ($text, $cb)
		1548
		1549	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1550	selected.
		1551
		1552	=cut
		1553
		1554	sub add_button {
		1555	my ($self, $text, $cb) = @_;
		1556
		1557	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1558	}
		1559
		1560	=item $popup->add_toggle ($text, $cb, $initial_value)
		1561
		1562	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1563	whenever it gets toggled, with a boolean indicating its value as its first
		1564	argument.
		1565
		1566	=cut
		1567
		1568	sub add_toggle {
		1569	my ($self, $text, $cb, $value) = @_;
		1570
		1571	my $item; $item = {
		1572	type => "button",
		1573	text => " $text",
		1574	value => $value,
		1575	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1576	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1577	};
		1578
		1579	$self->add_item ($item);
		1580	}
		1581
		1582	=item $popup->show
		1583
		1584	Displays the popup (which is initially hidden).
		1585
		1586	=cut
		1587
		1588	sub show {
		1589	my ($self) = @_;
		1590
		1591	local $urxvt::popup::self = $self;
		1592
		1593	my $env = $self->{term}->env;
		1594	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1595	delete $env->{LC_ALL};
		1596	$env->{LC_CTYPE} = $self->{term}->locale;
		1597
		1598	urxvt::term->new ($env, "popup",
		1599	"--perl-lib" => "", "--perl-ext-common" => "",
		1600	"-pty-fd" => -1, "-sl" => 0,
		1601	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		1602	"--transient-for" => $self->{term}->parent,
		1603	"-display" => $self->{term}->display_id,
		1604	"-pe" => "urxvt-popup")
		1605	or die "unable to create popup window\n";
		1606	}
		1607
		1608	sub DESTROY {
		1609	my ($self) = @_;
		1610
		1611	delete $self->{term}{_destroy}{$self};
		1612	$self->{term}->ungrab;
		1613	}
295		1614
296	=back	1615	=back
297		1616
298	=head2 The C<urxvt::timer> Class	1617	=head2 The C<urxvt::timer> Class
299		1618
300	This class implements timer watchers/events. Time is represented as a	1619	This class implements timer watchers/events. Time is represented as a
301	fractional number of seconds since the epoch. Example:	1620	fractional number of seconds since the epoch. Example:
302		1621
303	# create a digital clock display in upper right corner	1622	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
304	$term->{timer} = urxvt::timer	1623	$term->{timer} = urxvt::timer
305	->new	1624	->new
306	->start (urxvt::NOW)	1625	->interval (1)
307	->cb (sub {	1626	->cb (sub {
308	my ($timer) = @_;
309	my $time = $timer->at;
310	$timer->start ($time + 1);
311	$self->scr_overlay (-1, 0,	1627	$term->{overlay}->set (0, 0,
312	POSIX::strftime "%H:%M:%S", localtime $time);	1628	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
313	});	1629	});
314		1630
315	=over 4	1631	=over 4
316		1632
317	=item $timer = new urxvt::timer	1633	=item $timer = new urxvt::timer
318		1634
319	Create a new timer object in stopped state.	1635	Create a new timer object in started state. It is scheduled to fire
		1636	immediately.
320		1637
321	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1638	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
322		1639
323	Set the callback to be called when the timer triggers.	1640	Set the callback to be called when the timer triggers.
324		1641
…		…
328		1645
329	=item $timer = $timer->set ($tstamp)	1646	=item $timer = $timer->set ($tstamp)
330		1647
331	Set the time the event is generated to $tstamp.	1648	Set the time the event is generated to $tstamp.
332		1649
		1650	=item $timer = $timer->interval ($interval)
		1651
		1652	Normally (and when C<$interval> is C<0>), the timer will automatically
		1653	stop after it has fired once. If C<$interval> is non-zero, then the timer
		1654	is automatically rescheduled at the given intervals.
		1655
333	=item $timer = $timer->start	1656	=item $timer = $timer->start
334		1657
335	Start the timer.	1658	Start the timer.
336		1659
337	=item $timer = $timer->start ($tstamp)	1660	=item $timer = $timer->start ($tstamp)
338		1661
339	Set the event trigger time to C<$tstamp> and start the timer.	1662	Set the event trigger time to C<$tstamp> and start the timer.
		1663
		1664	=item $timer = $timer->after ($delay)
		1665
		1666	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
340		1667
341	=item $timer = $timer->stop	1668	=item $timer = $timer->stop
342		1669
343	Stop the timer.	1670	Stop the timer.
344		1671
…		…
350		1677
351	$term->{socket} = ...	1678	$term->{socket} = ...
352	$term->{iow} = urxvt::iow	1679	$term->{iow} = urxvt::iow
353	->new	1680	->new
354	->fd (fileno $term->{socket})	1681	->fd (fileno $term->{socket})
355	->events (1) # wait for read data	1682	->events (urxvt::EVENT_READ)
356	->start	1683	->start
357	->cb (sub {	1684	->cb (sub {
358	my ($iow, $revents) = @_;	1685	my ($iow, $revents) = @_;
359	# $revents must be 1 here, no need to check	1686	# $revents must be 1 here, no need to check
360	sysread $term->{socket}, my $buf, 8192	1687	sysread $term->{socket}, my $buf, 8192
…		…
377		1704
378	Set the filedescriptor (not handle) to watch.	1705	Set the filedescriptor (not handle) to watch.
379		1706
380	=item $iow = $iow->events ($eventmask)	1707	=item $iow = $iow->events ($eventmask)
381		1708
382	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1709	Set the event mask to watch. The only allowed values are
383	data, Bit #1 (value C<2>) enables watching for write data.	1710	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1711	together, or C<urxvt::EVENT_NONE>.
384		1712
385	=item $iow = $iow->start	1713	=item $iow = $iow->start
386		1714
387	Start watching for requested events on the given handle.	1715	Start watching for requested events on the given handle.
388		1716
389	=item $iow = $iow->stop	1717	=item $iow = $iow->stop
390		1718
391	Stop watching for events on the given filehandle.	1719	Stop watching for events on the given filehandle.
		1720
		1721	=back
		1722
		1723	=head1 ENVIRONMENT
		1724
		1725	=head2 URXVT_PERL_VERBOSITY
		1726
		1727	This variable controls the verbosity level of the perl extension. Higher
		1728	numbers indicate more verbose output.
		1729
		1730	=over 4
		1731
		1732	=item == 0 - fatal messages
		1733
		1734	=item >= 3 - script loading and management
		1735
		1736	=item >=10 - all called hooks
		1737
		1738	=item >=11 - hook reutrn values
392		1739
393	=back	1740	=back
394		1741
395	=head1 AUTHOR	1742	=head1 AUTHOR
396		1743

Diff Legend

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