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.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC

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

Diff Legend

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