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.22 by root, Tue Jan 3 19:10:54 2006 UTC vs.
Revision 1.99 by root, Tue Jan 17 17:09:26 2006 UTC

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

Diff Legend

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