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.28 by root, Wed Jan 4 00:09:12 2006 UTC vs.
Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC

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

Diff Legend

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