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.3 by root, Mon Jan 2 15:59:25 2006 UTC vs.
Revision 1.106 by root, Wed Jan 18 19:44:22 2006 UTC

		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	rxvtperl - 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 F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, they will be loaded automatically.	9	# create a file grab_test in $HOME:
8
9	* Each script will only be loaded once, even in urxvtd, and will be valid
10	globally.
11
12	* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
13	thus must be encoded as UTF-8.
14		10
15	sub on_sel_grab {	11	sub on_sel_grab {
16	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
17	()	13	()
18	}	14	}
19		15
20	1	16	# start a @@RXVT_NAME@@ using it:
		17
		18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
21		19
22	=head1 DESCRIPTION	20	=head1 DESCRIPTION
23		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
24	=head2 Hooks	295	=head2 Hooks
25		296
26	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
27	whenever the relevant event happens.	298	called whenever the relevant event happens.
28		299
		300	The first argument passed to them is an extension oject as described in
		301	the in the C<Extension Objects> section.
		302
29	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
30	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
31	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.
32		306
33	When in doubt, return a false value (preferably C<()>).	307	I<< When in doubt, return a false value (preferably C<()>). >>
34		308
35	=over 4	309	=over 4
36		310
37	=item on_init $term	311	=item on_init $term
38		312
39	Called after a new terminal object has been initialized, but before	313	Called after a new terminal object has been initialized, but before
40	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.
41		318
42	=item on_reset $term	319	=item on_reset $term
43		320
44	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
45	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
…		…
65	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
66	by calling C<< $term->selection >>.	343	by calling C<< $term->selection >>.
67		344
68	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.
69		346
70	=item on_focus_in $term	347	=item on_sel_extend $term
71		348
72	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
73	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.
74		355
75	=item on_focus_out $term	356	See the F<selection> example extension.
76
77	Called wheneever the window loses keyboard focus, before urxvt does focus
78	out processing.
79		357
80	=item on_view_change $term, $offset	358	=item on_view_change $term, $offset
81		359
82	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
83	scrolls. Offset C<0> means display the normal terminal, positive values	361	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
91		369
92	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,
93	$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
94	number of lines that will be in the scrollback buffer.	372	number of lines that will be in the scrollback buffer.
95		373
96	=item on_tty_activity $term *NYI*	374	=item on_osc_seq $term, $string
97		375
98	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.
99		413
100	=item on_refresh_begin $term	414	=item on_refresh_begin $term
101		415
102	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
103	or similar effects by modify terminal contents in refresh_begin, and	417	or similar effects by modify terminal contents in refresh_begin, and
…		…
106		420
107	=item on_refresh_end $term	421	=item on_refresh_end $term
108		422
109	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>.
110		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
111	=back	520	=back
112		521
113	=head2 Functions in the C<urxvt> Package	522	=head2 Functions in the C<urxvt> Package
114		523
115	=over 4	524	=over 4
…		…
120	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
121	starts up.	530	starts up.
122		531
123	=item urxvt::warn $string	532	=item urxvt::warn $string
124		533
125	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
126	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
127	that calls this function.	536	that calls this function.
128		537
129	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
130	correct place, e.g. on stderr of the connecting urxvtc client.	539	correct place, e.g. on stderr of the connecting urxvtc client.
131		540
132	=item $cellwidth = urxvt::wcswidth $string	541	Messages have a size limit of 1023 bytes currently.
133
134	Returns the number of screen-cells this string would need. Correctly
135	accounts for wide and combining characters.
136		542
137	=item $time = urxvt::NOW	543	=item $time = urxvt::NOW
138		544
139	Returns the "current time" (as per the event loop).	545	Returns the "current time" (as per the event loop).
140		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
141	=cut	625	=cut
142		626
143	package urxvt;
144
145	use strict;
146
147	our $term;
148	our @HOOKNAME;
149	our $LIBDIR;
150
151	BEGIN {	627	BEGIN {
152	urxvt->bootstrap;
153
154	# overwrite perl's warn	628	# overwrite perl's warn
155	*CORE::GLOBAL::warn = sub {	629	*CORE::GLOBAL::warn = sub {
156	my $msg = join "", @_;	630	my $msg = join "", @_;
157	$msg .= "\n"	631	$msg .= "\n"
158	unless $msg =~ /\n$/;	632	unless $msg =~ /\n$/;
159	urxvt::warn ($msg);	633	urxvt::warn ($msg);
160	};	634	};
161	}
162		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
163	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} || 10;	643	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
164		644
165	sub verbose {	645	sub verbose {
166	my ($level, $msg) = @_;	646	my ($level, $msg) = @_;
167	warn "$msg\n"; #d#	647	warn "$msg\n" if $level <= $verbosity;
168	}	648	}
169		649
170	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
171		685
172	# called by the rxvt core	686	# called by the rxvt core
173	sub invoke {	687	sub invoke {
174	local $term = shift;	688	local $TERM = shift;
175	my $htype = shift;	689	my $htype = shift;
176		690
177	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;
178		695
179	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	696	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
180	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	}
181		707
182	while (my ($k, $v) = each %$cb) {	708	while (my ($ext, $argv) = each %ext_arg) {
183	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 $@;
184	}	720	}
185		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;
186	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
187	}	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
188		907
189	# find on_xxx subs in the package and register them	908	# find on_xxx subs in the package and register them
190	# as hooks	909	# as hooks
191	sub register_package($) {	910	sub register_package {
192	my ($pkg) = @_;	911	my ($self, $pkg, $argv) = @_;
193		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
194	for my $hook (0.. $#HOOKNAME) {	921	for my $name (@HOOKNAME) {
195	my $name = $HOOKNAME[$hook];
196
197	my $ref = $pkg->can ("on_" . lc $name)	922	if (my $ref = $pkg->can ("on_" . lc $name)) {
198	or next;	923	$proxy->enable ($name => $ref);
199		924	}
200	$invoke_cb[$hook]{$ref*1} = $ref;
201	set_should_invoke $hook, 1;
202	}	925	}
203	}	926	}
204		927
205	my $script_pkg = "script0000";	928	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
206	my %script_pkg;
207		929
208	# 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
209	sub load_script($) {	931	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
210	my ($path) = @_;	932	hash which defines the environment of the new terminal.
211		933
212	$script_pkg{$path} ||= do {	934	Croaks (and probably outputs an error message) if the new instance
213	my $pkg = $script_pkg++;	935	couldn't be created. Returns C<undef> if the new instance didn't
214	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.
215		938
216	open my $fh, "<:raw", $path	939	=cut
217	or die "$path: $!";
218		940
219	eval "package $pkg; use strict; use utf8;\n"	941	sub new {
220	. "#line 1 \"$path\"\n"	942	my ($class, $env, @args) = @_;
221	. do { local $/; <$fh> }
222	or die "$path: $@";
223		943
224	register_package $pkg;	944	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
225
226	$pkg
227	};
228	}	945	}
229		946
230	load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>;	947	=item $term->destroy
231		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.
232		952
233	=back	953	=item $isset = $term->option ($optval[, $set])
234		954
235	=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.
236		958
237	=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	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
		965	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
		966	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
		967	transparent 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 meta8 modifier
		995	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
		996	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
		997	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
		998	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
		999	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
		1000	secondaryScreen secondaryScroll selectstyle shade term_name title
		1001	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1002	visualBell
		1003
		1004	=cut
		1005
		1006	sub resource($$;$) {
		1007	my ($self, $name) = (shift, shift);
		1008	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
		1009	&urxvt::term::_resource
		1010	}
		1011
		1012	=item $value = $term->x_resource ($pattern)
		1013
		1014	Returns the X-Resource for the given pattern, excluding the program or
		1015	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1016	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1017	resource with that pattern exists.
		1018
		1019	This method should only be called during the C<on_start> hook, as there is
		1020	only one resource database per display, and later invocations might return
		1021	the wrong resources.
		1022
		1023	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1024
		1025	Adds a keymap translation exactly as specified via a resource. See the
		1026	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1027
		1028	=item $rend = $term->rstyle ([$new_rstyle])
		1029
		1030	Return and optionally change the current rendition. Text that is output by
		1031	the terminal application will use this style.
		1032
		1033	=item ($row, $col) = $term->screen_cur ([$row, $col])
		1034
		1035	Return the current coordinates of the text cursor position and optionally
		1036	set it (which is usually bad as applications don't expect that).
238		1037
239	=item ($row, $col) = $term->selection_mark ([$row, $col])	1038	=item ($row, $col) = $term->selection_mark ([$row, $col])
240		1039
241	=item ($row, $col) = $term->selection_beg ([$row, $col])	1040	=item ($row, $col) = $term->selection_beg ([$row, $col])
242		1041
243	=item ($row, $col) = $term->selection_end ([$row, $col])	1042	=item ($row, $col) = $term->selection_end ([$row, $col])
244		1043
245	Return the current values of the selection mark, begin or end positions,	1044	Return the current values of the selection mark, begin or end positions,
246	and optionally set them to new values.	1045	and optionally set them to new values.
247		1046
		1047	=item $term->selection_make ($eventtime[, $rectangular])
		1048
		1049	Tries to make a selection as set by C<selection_beg> and
		1050	C<selection_end>. If C<$rectangular> is true (default: false), a
		1051	rectangular selection will be made. This is the prefered function to make
		1052	a selection.
		1053
248	=item $success = $term->selection_grab ($eventtime)	1054	=item $success = $term->selection_grab ($eventtime)
249		1055
250	Try to request the primary selection from the server (for example, as set	1056	Try to request the primary selection text from the server (for example, as
251	by the next method).	1057	set by the next method). No visual feedback will be given. This function
		1058	is mostly useful from within C<on_sel_grab> hooks.
252		1059
253	=item $oldtext = $term->selection ([$newtext])	1060	=item $oldtext = $term->selection ([$newtext])
254		1061
255	Return the current selection text and optionally replace it by C<$newtext>.	1062	Return the current selection text and optionally replace it by C<$newtext>.
256		1063
257	=item $term->scr_overlay ($x, $y, $text)	1064	=item $term->overlay_simple ($x, $y, $text)
258		1065
259	Create a simple multi-line overlay box. See the next method for details.	1066	Create a simple multi-line overlay box. See the next method for details.
260		1067
261	=cut	1068	=cut
262		1069
263	sub urxvt::term::scr_overlay {	1070	sub overlay_simple {
264	my ($self, $x, $y, $text) = @_;	1071	my ($self, $x, $y, $text) = @_;
265		1072
266	my @lines = split /\n/, $text;	1073	my @lines = split /\n/, $text;
267		1074
268	my $w = 0;	1075	my $w = List::Util::max map $self->strwidth ($_), @lines;
269	for (map urxvt::wcswidth $_, @lines) {	1076
270	$w = $_ if $w < $_;	1077	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
		1078	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		1079
		1080	$overlay
		1081	}
		1082
		1083	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
		1084
		1085	Create a new (empty) overlay at the given position with the given
		1086	width/height. C<$rstyle> defines the initial rendition style
		1087	(default: C<OVERLAY_RSTYLE>).
		1088
		1089	If C<$border> is C<2> (default), then a decorative border will be put
		1090	around the box.
		1091
		1092	If either C<$x> or C<$y> is negative, then this is counted from the
		1093	right/bottom side, respectively.
		1094
		1095	This method returns an urxvt::overlay object. The overlay will be visible
		1096	as long as the perl object is referenced.
		1097
		1098	The methods currently supported on C<urxvt::overlay> objects are:
		1099
		1100	=over 4
		1101
		1102	=item $overlay->set ($x, $y, $text, $rend)
		1103
		1104	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		1105	text in rxvt-unicode's special encoding and an array of rendition values
		1106	at a specific position inside the overlay.
		1107
		1108	=item $overlay->hide
		1109
		1110	If visible, hide the overlay, but do not destroy it.
		1111
		1112	=item $overlay->show
		1113
		1114	If hidden, display the overlay again.
		1115
		1116	=back
		1117
		1118	=item $popup = $term->popup ($event)
		1119
		1120	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1121	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1122	currently).
		1123
		1124	=cut
		1125
		1126	sub popup {
		1127	my ($self, $event) = @_;
		1128
		1129	$self->grab ($event->{time}, 1)
		1130	or return;
		1131
		1132	my $popup = bless {
		1133	term => $self,
		1134	event => $event,
		1135	}, urxvt::popup::;
		1136
		1137	Scalar::Util::weaken $popup->{term};
		1138
		1139	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1140	Scalar::Util::weaken $self->{_destroy}{$popup};
		1141
		1142	$popup
		1143	}
		1144
		1145	=item $cellwidth = $term->strwidth ($string)
		1146
		1147	Returns the number of screen-cells this string would need. Correctly
		1148	accounts for wide and combining characters.
		1149
		1150	=item $octets = $term->locale_encode ($string)
		1151
		1152	Convert the given text string into the corresponding locale encoding.
		1153
		1154	=item $string = $term->locale_decode ($octets)
		1155
		1156	Convert the given locale-encoded octets into a perl string.
		1157
		1158	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1159
		1160	XORs the rendition values in the given span with the provided value
		1161	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1162	refresh hooks to provide effects similar to the selection.
		1163
		1164	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1165
		1166	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1167	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1168	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1169	it instead. Both styles I<MUST NOT> contain font styles.
		1170
		1171	=item $term->scr_bell
		1172
		1173	Ring the bell!
		1174
		1175	=item $term->scr_add_lines ($string)
		1176
		1177	Write the given text string to the screen, as if output by the application
		1178	running inside the terminal. It may not contain command sequences (escape
		1179	codes), but is free to use line feeds, carriage returns and tabs. The
		1180	string is a normal text string, not in locale-dependent encoding.
		1181
		1182	Normally its not a good idea to use this function, as programs might be
		1183	confused by changes in cursor position or scrolling. Its useful inside a
		1184	C<on_add_lines> hook, though.
		1185
		1186	=item $term->cmd_parse ($octets)
		1187
		1188	Similar to C<scr_add_lines>, but the argument must be in the
		1189	locale-specific encoding of the terminal and can contain command sequences
		1190	(escape codes) that will be interpreted.
		1191
		1192	=item $term->tt_write ($octets)
		1193
		1194	Write the octets given in C<$data> to the tty (i.e. as program input). To
		1195	pass characters instead of octets, you should convert your strings first
		1196	to the locale-specific encoding using C<< $term->locale_encode >>.
		1197
		1198	=item $old_events = $term->pty_ev_events ([$new_events])
		1199
		1200	Replaces the event mask of the pty watcher by the given event mask. Can
		1201	be used to suppress input and output handling to the pty/tty. See the
		1202	description of C<< urxvt::timer->events >>. Make sure to always restore
		1203	the previous value.
		1204
		1205	=item $windowid = $term->parent
		1206
		1207	Return the window id of the toplevel window.
		1208
		1209	=item $windowid = $term->vt
		1210
		1211	Return the window id of the terminal window.
		1212
		1213	=item $term->vt_emask_add ($x_event_mask)
		1214
		1215	Adds the specified events to the vt event mask. Useful e.g. when you want
		1216	to receive pointer events all the times:
		1217
		1218	$term->vt_emask_add (urxvt::PointerMotionMask);
		1219
		1220	=item $window_width = $term->width
		1221
		1222	=item $window_height = $term->height
		1223
		1224	=item $font_width = $term->fwidth
		1225
		1226	=item $font_height = $term->fheight
		1227
		1228	=item $font_ascent = $term->fbase
		1229
		1230	=item $terminal_rows = $term->nrow
		1231
		1232	=item $terminal_columns = $term->ncol
		1233
		1234	=item $has_focus = $term->focus
		1235
		1236	=item $is_mapped = $term->mapped
		1237
		1238	=item $max_scrollback = $term->saveLines
		1239
		1240	=item $nrow_plus_saveLines = $term->total_rows
		1241
		1242	=item $topmost_scrollback_row = $term->top_row
		1243
		1244	Return various integers describing terminal characteristics.
		1245
		1246	=item $x_display = $term->display_id
		1247
		1248	Return the DISPLAY used by rxvt-unicode.
		1249
		1250	=item $lc_ctype = $term->locale
		1251
		1252	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1253
		1254	=item $env = $term->env
		1255
		1256	Returns a copy of the environment in effect for the terminal as a hashref
		1257	similar to C<\%ENV>.
		1258
		1259	=cut
		1260
		1261	sub env {
		1262	if (my $env = $_[0]->_env) {
		1263	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1264	} else {
		1265	+{ %ENV }
271	}	1266	}
272
273	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
274	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
275	}	1267	}
276		1268
277	=item $term->scr_overlay_new ($x, $y, $width, $height)	1269	=item $modifiermask = $term->ModLevel3Mask
278		1270
279	Create a new (empty) overlay at the given position with the given	1271	=item $modifiermask = $term->ModMetaMask
280	width/height. A border will be put around the box. If either C<$x> or
281	C<$y> is negative, then this is counted from the right/bottom side,
282	respectively.
283		1272
284	=item $term->scr_overlay_off	1273	=item $modifiermask = $term->ModNumLockMask
285		1274
286	Switch the overlay off again.	1275	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1276	AltGr), the meta key (often Alt) and the num lock key, if applicable.
287		1277
288	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	1278	=item $view_start = $term->view_start ([$newvalue])
289		1279
290	Put a single character (specified numerically) at the given overlay	1280	Returns the row number of the topmost displayed line. Maximum value is
291	position.	1281	C<0>, which displays the normal terminal contents. Lower values scroll
		1282	this many lines into the scrollback buffer.
292		1283
293	=item $term->scr_overlay_set ($x, $y, $text)	1284	=item $term->want_refresh
294		1285
295	Write a string at the given position into the overlay.	1286	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		1287	compare the on-screen display with its stored representation. If they
		1288	differ, it redraws the differences.
		1289
		1290	Used after changing terminal contents to display them.
		1291
		1292	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		1293
		1294	Returns the text of the entire row with number C<$row_number>. Row C<0>
		1295	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		1296	terminal line. The scrollback buffer starts at line C<-1> and extends to
		1297	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		1298	is requested.
		1299
		1300	If C<$new_text> is specified, it will replace characters in the current
		1301	line, starting at column C<$start_col> (default C<0>), which is useful
		1302	to replace only parts of a line. The font index in the rendition will
		1303	automatically be updated.
		1304
		1305	C<$text> is in a special encoding: tabs and wide characters that use more
		1306	than one cell when displayed are padded with urxvt::NOCHAR characters
		1307	(C<chr 65535>). Characters with combining characters and other characters
		1308	that do not fit into the normal tetx encoding will be replaced with
		1309	characters in the private use area.
		1310
		1311	You have to obey this encoding when changing text. The advantage is
		1312	that C<substr> and similar functions work on screen cells and not on
		1313	characters.
		1314
		1315	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		1316	can be used to convert normal strings into this encoding and vice versa.
		1317
		1318	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		1319
		1320	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		1321	bitsets. Rendition bitsets contain information about colour, font, font
		1322	styles and similar information. See also C<< $term->ROW_t >>.
		1323
		1324	When setting rendition, the font mask will be ignored.
		1325
		1326	See the section on RENDITION, above.
		1327
		1328	=item $length = $term->ROW_l ($row_number[, $new_length])
		1329
		1330	Returns the number of screen cells that are in use ("the line
		1331	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
		1332	line is joined with the following one.
		1333
		1334	=item $bool = $term->is_longer ($row_number)
		1335
		1336	Returns true if the row is part of a multiple-row logical "line" (i.e.
		1337	joined with the following row), which means all characters are in use
		1338	and it is continued on the next row (and possibly a continuation of the
		1339	previous row(s)).
		1340
		1341	=item $line = $term->line ($row_number)
		1342
		1343	Create and return a new C<urxvt::line> object that stores information
		1344	about the logical line that row C<$row_number> is part of. It supports the
		1345	following methods:
		1346
		1347	=over 4
		1348
		1349	=item $text = $line->t ([$new_text])
		1350
		1351	Returns or replaces the full text of the line, similar to C<ROW_t>
		1352
		1353	=item $rend = $line->r ([$new_rend])
		1354
		1355	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		1356
		1357	=item $length = $line->l
		1358
		1359	Returns the length of the line in cells, similar to C<ROW_l>.
		1360
		1361	=item $rownum = $line->beg
		1362
		1363	=item $rownum = $line->end
		1364
		1365	Return the row number of the first/last row of the line, respectively.
		1366
		1367	=item $offset = $line->offset_of ($row, $col)
		1368
		1369	Returns the character offset of the given row|col pair within the logical
		1370	line. Works for rows outside the line, too, and returns corresponding
		1371	offsets outside the string.
		1372
		1373	=item ($row, $col) = $line->coord_of ($offset)
		1374
		1375	Translates a string offset into terminal coordinates again.
		1376
		1377	=back
		1378
		1379	=cut
		1380
		1381	sub line {
		1382	my ($self, $row) = @_;
		1383
		1384	my $maxrow = $self->nrow - 1;
		1385
		1386	my ($beg, $end) = ($row, $row);
		1387
		1388	--$beg while $self->ROW_is_longer ($beg - 1);
		1389	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1390
		1391	bless {
		1392	term => $self,
		1393	beg => $beg,
		1394	end => $end,
		1395	ncol => $self->ncol,
		1396	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1397	}, urxvt::line::
		1398	}
		1399
		1400	sub urxvt::line::t {
		1401	my ($self) = @_;
		1402
		1403	if (@_ > 1)
		1404	{
		1405	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1406	for $self->{beg} .. $self->{end};
		1407	}
		1408
		1409	defined wantarray &&
		1410	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1411	0, $self->{len}
		1412	}
		1413
		1414	sub urxvt::line::r {
		1415	my ($self) = @_;
		1416
		1417	if (@_ > 1)
		1418	{
		1419	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1420	for $self->{beg} .. $self->{end};
		1421	}
		1422
		1423	if (defined wantarray) {
		1424	my $rend = [
		1425	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1426	];
		1427	$#$rend = $self->{len} - 1;
		1428	return $rend;
		1429	}
		1430
		1431	()
		1432	}
		1433
		1434	sub urxvt::line::beg { $_[0]{beg} }
		1435	sub urxvt::line::end { $_[0]{end} }
		1436	sub urxvt::line::l { $_[0]{len} }
		1437
		1438	sub urxvt::line::offset_of {
		1439	my ($self, $row, $col) = @_;
		1440
		1441	($row - $self->{beg}) * $self->{ncol} + $col
		1442	}
		1443
		1444	sub urxvt::line::coord_of {
		1445	my ($self, $offset) = @_;
		1446
		1447	use integer;
		1448
		1449	(
		1450	$offset / $self->{ncol} + $self->{beg},
		1451	$offset % $self->{ncol}
		1452	)
		1453	}
		1454
		1455	=item $text = $term->special_encode $string
		1456
		1457	Converts a perl string into the special encoding used by rxvt-unicode,
		1458	where one character corresponds to one screen cell. See
		1459	C<< $term->ROW_t >> for details.
		1460
		1461	=item $string = $term->special_decode $text
		1462
		1463	Converts rxvt-unicodes text reprsentation into a perl string. See
		1464	C<< $term->ROW_t >> for details.
		1465
		1466	=item $success = $term->grab_button ($button, $modifiermask)
		1467
		1468	Registers a synchronous button grab. See the XGrabButton manpage.
		1469
		1470	=item $success = $term->grab ($eventtime[, $sync])
		1471
		1472	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1473	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1474
		1475	=item $term->allow_events_async
		1476
		1477	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1478
		1479	=item $term->allow_events_sync
		1480
		1481	Calls XAllowEvents with SyncBoth for the most recent grab.
		1482
		1483	=item $term->allow_events_replay
		1484
		1485	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1486	recent grab.
		1487
		1488	=item $term->ungrab
		1489
		1490	Calls XUngrab for the most recent grab. Is called automatically on
		1491	evaluation errors, as it is better to lose the grab in the error case as
		1492	the session.
		1493
		1494	=back
		1495
		1496	=cut
		1497
		1498	package urxvt::popup;
		1499
		1500	=head2 The C<urxvt::popup> Class
		1501
		1502	=over 4
		1503
		1504	=cut
		1505
		1506	sub add_item {
		1507	my ($self, $item) = @_;
		1508
		1509	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1510	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1511	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1512
		1513	$item->{render} ||= sub { $_[0]{text} };
		1514
		1515	push @{ $self->{item} }, $item;
		1516	}
		1517
		1518	=item $popup->add_title ($title)
		1519
		1520	Adds a non-clickable title to the popup.
		1521
		1522	=cut
		1523
		1524	sub add_title {
		1525	my ($self, $title) = @_;
		1526
		1527	$self->add_item ({
		1528	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1529	text => $title,
		1530	activate => sub { },
		1531	});
		1532	}
		1533
		1534	=item $popup->add_separator ([$sepchr])
		1535
		1536	Creates a separator, optionally using the character given as C<$sepchr>.
		1537
		1538	=cut
		1539
		1540	sub add_separator {
		1541	my ($self, $sep) = @_;
		1542
		1543	$sep ||= "=";
		1544
		1545	$self->add_item ({
		1546	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1547	text => "",
		1548	render => sub { $sep x $self->{term}->ncol },
		1549	activate => sub { },
		1550	});
		1551	}
		1552
		1553	=item $popup->add_button ($text, $cb)
		1554
		1555	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1556	selected.
		1557
		1558	=cut
		1559
		1560	sub add_button {
		1561	my ($self, $text, $cb) = @_;
		1562
		1563	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1564	}
		1565
		1566	=item $popup->add_toggle ($text, $cb, $initial_value)
		1567
		1568	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1569	whenever it gets toggled, with a boolean indicating its value as its first
		1570	argument.
		1571
		1572	=cut
		1573
		1574	sub add_toggle {
		1575	my ($self, $text, $cb, $value) = @_;
		1576
		1577	my $item; $item = {
		1578	type => "button",
		1579	text => " $text",
		1580	value => $value,
		1581	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1582	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1583	};
		1584
		1585	$self->add_item ($item);
		1586	}
		1587
		1588	=item $popup->show
		1589
		1590	Displays the popup (which is initially hidden).
		1591
		1592	=cut
		1593
		1594	sub show {
		1595	my ($self) = @_;
		1596
		1597	local $urxvt::popup::self = $self;
		1598
		1599	my $env = $self->{term}->env;
		1600	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1601	delete $env->{LC_ALL};
		1602	$env->{LC_CTYPE} = $self->{term}->locale;
		1603
		1604	urxvt::term->new ($env, "popup",
		1605	"--perl-lib" => "", "--perl-ext-common" => "",
		1606	"-pty-fd" => -1, "-sl" => 0,
		1607	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		1608	"--transient-for" => $self->{term}->parent,
		1609	"-display" => $self->{term}->display_id,
		1610	"-pe" => "urxvt-popup")
		1611	or die "unable to create popup window\n";
		1612	}
		1613
		1614	sub DESTROY {
		1615	my ($self) = @_;
		1616
		1617	delete $self->{term}{_destroy}{$self};
		1618	$self->{term}->ungrab;
		1619	}
296		1620
297	=back	1621	=back
298		1622
299	=head2 The C<urxvt::timer> Class	1623	=head2 The C<urxvt::timer> Class
300		1624
301	This class implements timer watchers/events. Time is represented as a	1625	This class implements timer watchers/events. Time is represented as a
302	fractional number of seconds since the epoch. Example:	1626	fractional number of seconds since the epoch. Example:
303		1627
304	# create a digital clock display in upper right corner	1628	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
305	$term->{timer} = urxvt::timer	1629	$term->{timer} = urxvt::timer
306	->new	1630	->new
307	->start (urxvt::NOW)	1631	->interval (1)
308	->cb (sub {	1632	->cb (sub {
309	my ($timer) = @_;
310	my $time = $timer->at;
311	$timer->start ($time + 1);
312	$self->scr_overlay (-1, 0,	1633	$term->{overlay}->set (0, 0,
313	POSIX::strftime "%H:%M:%S", localtime $time);	1634	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
314	});	1635	});
315		1636
316	=over 4	1637	=over 4
317		1638
318	=item $timer = new urxvt::timer	1639	=item $timer = new urxvt::timer
319		1640
320	Create a new timer object in stopped state.	1641	Create a new timer object in started state. It is scheduled to fire
		1642	immediately.
321		1643
322	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1644	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
323		1645
324	Set the callback to be called when the timer triggers.	1646	Set the callback to be called when the timer triggers.
325		1647
…		…
329		1651
330	=item $timer = $timer->set ($tstamp)	1652	=item $timer = $timer->set ($tstamp)
331		1653
332	Set the time the event is generated to $tstamp.	1654	Set the time the event is generated to $tstamp.
333		1655
		1656	=item $timer = $timer->interval ($interval)
		1657
		1658	Normally (and when C<$interval> is C<0>), the timer will automatically
		1659	stop after it has fired once. If C<$interval> is non-zero, then the timer
		1660	is automatically rescheduled at the given intervals.
		1661
334	=item $timer = $timer->start	1662	=item $timer = $timer->start
335		1663
336	Start the timer.	1664	Start the timer.
337		1665
338	=item $timer = $timer->start ($tstamp)	1666	=item $timer = $timer->start ($tstamp)
339		1667
340	Set the event trigger time to C<$tstamp> and start the timer.	1668	Set the event trigger time to C<$tstamp> and start the timer.
		1669
		1670	=item $timer = $timer->after ($delay)
		1671
		1672	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
341		1673
342	=item $timer = $timer->stop	1674	=item $timer = $timer->stop
343		1675
344	Stop the timer.	1676	Stop the timer.
345		1677
…		…
351		1683
352	$term->{socket} = ...	1684	$term->{socket} = ...
353	$term->{iow} = urxvt::iow	1685	$term->{iow} = urxvt::iow
354	->new	1686	->new
355	->fd (fileno $term->{socket})	1687	->fd (fileno $term->{socket})
356	->events (1) # wait for read data	1688	->events (urxvt::EVENT_READ)
357	->start	1689	->start
358	->cb (sub {	1690	->cb (sub {
359	my ($iow, $revents) = @_;	1691	my ($iow, $revents) = @_;
360	# $revents must be 1 here, no need to check	1692	# $revents must be 1 here, no need to check
361	sysread $term->{socket}, my $buf, 8192	1693	sysread $term->{socket}, my $buf, 8192
…		…
378		1710
379	Set the filedescriptor (not handle) to watch.	1711	Set the filedescriptor (not handle) to watch.
380		1712
381	=item $iow = $iow->events ($eventmask)	1713	=item $iow = $iow->events ($eventmask)
382		1714
383	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1715	Set the event mask to watch. The only allowed values are
384	data, Bit #1 (value C<2>) enables watching for write data.	1716	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1717	together, or C<urxvt::EVENT_NONE>.
385		1718
386	=item $iow = $iow->start	1719	=item $iow = $iow->start
387		1720
388	Start watching for requested events on the given handle.	1721	Start watching for requested events on the given handle.
389		1722
390	=item $iow = $iow->stop	1723	=item $iow = $iow->stop
391		1724
392	Stop watching for events on the given filehandle.	1725	Stop watching for events on the given filehandle.
		1726
		1727	=back
		1728
		1729	=head1 ENVIRONMENT
		1730
		1731	=head2 URXVT_PERL_VERBOSITY
		1732
		1733	This variable controls the verbosity level of the perl extension. Higher
		1734	numbers indicate more verbose output.
		1735
		1736	=over 4
		1737
		1738	=item == 0 - fatal messages
		1739
		1740	=item >= 3 - script loading and management
		1741
		1742	=item >=10 - all called hooks
		1743
		1744	=item >=11 - hook reutrn values
393		1745
394	=back	1746	=back
395		1747
396	=head1 AUTHOR	1748	=head1 AUTHOR
397		1749

Diff Legend

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