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

Diff Legend

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