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

Diff Legend

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